interconnect_groups

Creates, updates, deletes, gets or lists an interconnect_groups resource.

Overview

Name	`interconnect_groups`
Type	Resource
Id	`google.compute.interconnect_groups`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`id`	`string (uint64)`	Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.
`name`	`string`	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`configured`	`object`	[Output Only] The status of the group as configured. This has the same structure as the operational field reported by the OperationalStatus method, but does not take into account the operational status of each resource. (id: InterconnectGroupConfigured)
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`etag`	`string`	Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by AIP 154.
`intent`	`object`	The user's intent for this group. This is the only required field besides the name that must be specified on group creation. (id: InterconnectGroupIntent)
`interconnects`	`object`	Interconnects in the InterconnectGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an "Interconnects per group" quota.
`kind`	`string`	Output only. [Output Only] Type of the resource. Always compute#InterconnectGroup (default: compute#InterconnectGroup)
`physicalStructure`	`object`	[Output Only] An analysis of the physical layout of Interconnects in this group. Every Interconnect in the group is shown once in this structure. (id: InterconnectGroupPhysicalStructure)
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for the resource.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`etag`	`string`
`items`	`array`	A list of InterconnectGroup resources.
`kind`	`string`	(default: compute#InterconnectGroup)
`nextPageToken`	`string`	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
`selfLink`	`string`	[Output Only] Server-defined URL for this resource.
`unreachables`	`array`	Output only. [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
`warning`	`object`	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `interconnectGroup`		Returns the specified InterconnectGroup resource in the given scope.
`list`	`select`	`project`	`returnPartialSuccess`, `maxResults`, `pageToken`, `filter`, `orderBy`	Lists the InterconnectGroups for a project in the given scope.
`create_members`	`insert`	`project`, `interconnectGroup`		Create Interconnects with redundancy by creating them in a specified interconnect group.
`insert`	`insert`	`project`	`requestId`	Creates a InterconnectGroup in the specified project in the given scope using the parameters that are included in the request.
`patch`	`update`	`project`, `interconnectGroup`	`requestId`, `updateMask`	Patches the specified InterconnectGroup resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
`delete`	`delete`	`project`, `interconnectGroup`	`requestId`	Deletes the specified InterconnectGroup in the given scope

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`interconnectGroup`	`string`
`project`	`string`
`filter`	`string`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Returns the specified InterconnectGroup resource in the given scope.

SELECT
id,
name,
configured,
creationTimestamp,
description,
etag,
intent,
interconnects,
kind,
physicalStructure,
selfLink
FROM google.compute.interconnect_groups
WHERE project = '{{ project }}' -- required
AND interconnectGroup = '{{ interconnectGroup }}' -- required
;

Lists the InterconnectGroups for a project in the given scope.

SELECT
id,
etag,
items,
kind,
nextPageToken,
selfLink,
unreachables,
warning
FROM google.compute.interconnect_groups
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

`INSERT` examples

create_members
insert
Manifest

Create Interconnects with redundancy by creating them in a specified
interconnect group.

INSERT INTO google.compute.interconnect_groups (
data__request,
project,
interconnectGroup
)
SELECT 
'{{ request }}',
'{{ project }}',
'{{ interconnectGroup }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Creates a InterconnectGroup in the specified project in the given scope
using the parameters that are included in the request.

INSERT INTO google.compute.interconnect_groups (
data__intent,
data__description,
data__interconnects,
data__etag,
data__name,
project,
requestId
)
SELECT 
'{{ intent }}',
'{{ description }}',
'{{ interconnects }}',
'{{ etag }}',
'{{ name }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: interconnect_groups
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the interconnect_groups resource.
  - name: interconnectGroup
    value: "{{ interconnectGroup }}"
    description: Required parameter for the interconnect_groups resource.
  - name: request
    value:
      intentMismatchBehavior: "{{ intentMismatchBehavior }}"
      interconnects:
        - interconnectType: "{{ interconnectType }}"
          adminEnabled: {{ adminEnabled }}
          requestedFeatures: "{{ requestedFeatures }}"
          nocContactEmail: "{{ nocContactEmail }}"
          name: "{{ name }}"
          customerName: "{{ customerName }}"
          remoteLocation: "{{ remoteLocation }}"
          linkType: "{{ linkType }}"
          requestedLinkCount: {{ requestedLinkCount }}
          description: "{{ description }}"
          facility: "{{ facility }}"
      templateInterconnect:
        interconnectType: "{{ interconnectType }}"
        adminEnabled: {{ adminEnabled }}
        requestedFeatures:
          - "{{ requestedFeatures }}"
        nocContactEmail: "{{ nocContactEmail }}"
        name: "{{ name }}"
        customerName: "{{ customerName }}"
        remoteLocation: "{{ remoteLocation }}"
        linkType: "{{ linkType }}"
        requestedLinkCount: {{ requestedLinkCount }}
        description: "{{ description }}"
        facility: "{{ facility }}"
  - name: intent
    description: |
      The user's intent for this group. This is the only required field besides
      the name that must be specified on group creation.
    value:
      topologyCapability: "{{ topologyCapability }}"
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: interconnects
    value: "{{ interconnects }}"
    description: |
      Interconnects in the InterconnectGroup. Keys are arbitrary user-specified
      strings. Users are encouraged, but not required, to use their preferred
      format for resource links as keys.
      Note that there are add-members and remove-members methods in gcloud.
      The size of this map is limited by an "Interconnects per group" quota.
  - name: etag
    value: "{{ etag }}"
    description: |
      Opaque system-generated token that uniquely identifies the configuration.
      If provided when patching a configuration in update mode, the provided
      token must match the current token or the update is rejected. This provides
      a reliable means of doing read-modify-write (optimistic locking) as
      described by AIP 154.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      Specifically, the name must be 1-63 characters long and match the regular
      expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      character must be a lowercase letter, and all following characters must
      be a dash, lowercase letter, or digit, except the last character, which
      cannot be a dash.
  - name: requestId
    value: "{{ requestId }}"

`UPDATE` examples

patch

Patches the specified InterconnectGroup resource with the data included in
the request. This method supports PATCH
semantics and usesJSON merge
patch format and processing rules.

UPDATE google.compute.interconnect_groups
SET 
data__intent = '{{ intent }}',
data__description = '{{ description }}',
data__interconnects = '{{ interconnects }}',
data__etag = '{{ etag }}',
data__name = '{{ name }}'
WHERE 
project = '{{ project }}' --required
AND interconnectGroup = '{{ interconnectGroup }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

`DELETE` examples

delete

Deletes the specified InterconnectGroup in the given scope

DELETE FROM google.compute.interconnect_groups
WHERE project = '{{ project }}' --required
AND interconnectGroup = '{{ interconnectGroup }}' --required
AND requestId = '{{ requestId }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​