interconnect_groups

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

Overview

Name	interconnect_groups
Type	Resource
Id	azure.network.interconnect_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
provisioningState	string	The provisioning state of the interconnect group resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the interconnect group resource.
scope	string	Scope of interconnect group resource. Known values are: "None" and "InfiniBand". (None, InfiniBand)
subgroupProfile	object	The subgroup profile of the interconnect group resource. Required.
subgroups	array	A list of subgroups of the interconnect group.
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
provisioningState	string	The provisioning state of the interconnect group resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the interconnect group resource.
scope	string	Scope of interconnect group resource. Known values are: "None" and "InfiniBand". (None, InfiniBand)
subgroupProfile	object	The subgroup profile of the interconnect group resource. Required.
subgroups	array	A list of subgroups of the interconnect group.
tags	object	Resource tags.
type	string	Resource type.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
provisioningState	string	The provisioning state of the interconnect group resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the interconnect group resource.
scope	string	Scope of interconnect group resource. Known values are: "None" and "InfiniBand". (None, InfiniBand)
subgroupProfile	object	The subgroup profile of the interconnect group resource. Required.
subgroups	array	A list of subgroups of the interconnect group.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, interconnect_group_name, subscription_id		Gets information about the specified interconnect group.
list	select	resource_group_name, subscription_id		Gets all interconnect groups in a resource group.
list_all	select	subscription_id		Gets all interconnect groups in a subscription.
create_or_update	insert	resource_group_name, interconnect_group_name, subscription_id		Creates or updates an interconnect group.
update_tags	update	resource_group_name, interconnect_group_name, subscription_id		Updates interconnect group tags.
create_or_update	replace	resource_group_name, interconnect_group_name, subscription_id		Creates or updates an interconnect group.
delete	delete	resource_group_name, interconnect_group_name, subscription_id		Deletes the specified interconnect group.
get_node_availability	exec	resource_group_name, interconnect_group_name, subscription_id		Gets node availability for all subgroups in the specified interconnect group.

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
interconnect_group_name	string	The name of the interconnect group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets information about the specified interconnect group.

SELECT
id,
name,
etag,
location,
provisioningState,
resourceGuid,
scope,
subgroupProfile,
subgroups,
tags,
type
FROM azure.network.interconnect_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND interconnect_group_name = '{{ interconnect_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all interconnect groups in a resource group.

SELECT
id,
name,
etag,
location,
provisioningState,
resourceGuid,
scope,
subgroupProfile,
subgroups,
tags,
type
FROM azure.network.interconnect_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all interconnect groups in a subscription.

SELECT
id,
name,
etag,
location,
provisioningState,
resourceGuid,
scope,
subgroupProfile,
subgroups,
tags,
type
FROM azure.network.interconnect_groups
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an interconnect group.

INSERT INTO azure.network.interconnect_groups (
id,
location,
tags,
properties,
resource_group_name,
interconnect_group_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ interconnect_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: interconnect_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the interconnect_groups resource.
  - name: interconnect_group_name
    value: "{{ interconnect_group_name }}"
    description: Required parameter for the interconnect_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the interconnect_groups resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the interconnect group.
    value:
      scope: "{{ scope }}"
      subgroups:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            internalSubgroupId: "{{ internalSubgroupId }}"
            interconnectBlock:
              id: "{{ id }}"
            virtualMachines:
              - id: "{{ id }}"
            provisioningState: "{{ provisioningState }}"
      provisioningState: "{{ provisioningState }}"
      resourceGuid: "{{ resourceGuid }}"
      subgroupProfile:
        vmSize: "{{ vmSize }}"
        scope: "{{ scope }}"
        size: {{ size }}

UPDATE examples

update_tags

Updates interconnect group tags.

UPDATE azure.network.interconnect_groups
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND interconnect_group_name = '{{ interconnect_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an interconnect group.

REPLACE azure.network.interconnect_groups
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND interconnect_group_name = '{{ interconnect_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified interconnect group.

DELETE FROM azure.network.interconnect_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND interconnect_group_name = '{{ interconnect_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_node_availability

Gets node availability for all subgroups in the specified interconnect group.

EXEC azure.network.interconnect_groups.get_node_availability 
@resource_group_name='{{ resource_group_name }}' --required, 
@interconnect_group_name='{{ interconnect_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;