interconnect_blocks

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

Overview

Name	interconnect_blocks
Type	Resource
Id	azure.compute.interconnect_blocks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
instanceView	object	The Interconnect Block instance view.
interconnectBlockId	string	A unique id (GUID) generated and assigned to the Interconnect Block by the platform which does not change throughout the lifetime of the resource.
interconnectGroup	object	The Microsoft.Network/interconnectGroups resource that this Interconnect Block is associated with. Required at create and immutable thereafter. Required.
location	string	The geo-location where the resource lives. Required.
placement	object	Placement section specifies the user-defined constraints for Interconnect Block hardware placement. This property cannot be changed once Interconnect Block is provisioned.
provisioningState	string	The provisioning state, which only appears in the response.
provisioningTime	string (date-time)	The date time when the Interconnect Block was last updated.
sku	object	SKU of the resource for which capacity needs to be pre-allocated. Both sku.name and sku.capacity are required at create. After create, only sku.capacity can be updated. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeCreated	string (date-time)	Specifies the time at which the Interconnect Block resource was created.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachinesAssociated	array	A list of all virtual machine resource ids that are associated with the Interconnect Block.
zones	array	The availability zones.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
instanceView	object	The Interconnect Block instance view.
interconnectBlockId	string	A unique id (GUID) generated and assigned to the Interconnect Block by the platform which does not change throughout the lifetime of the resource.
interconnectGroup	object	The Microsoft.Network/interconnectGroups resource that this Interconnect Block is associated with. Required at create and immutable thereafter. Required.
location	string	The geo-location where the resource lives. Required.
placement	object	Placement section specifies the user-defined constraints for Interconnect Block hardware placement. This property cannot be changed once Interconnect Block is provisioned.
provisioningState	string	The provisioning state, which only appears in the response.
provisioningTime	string (date-time)	The date time when the Interconnect Block was last updated.
sku	object	SKU of the resource for which capacity needs to be pre-allocated. Both sku.name and sku.capacity are required at create. After create, only sku.capacity can be updated. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeCreated	string (date-time)	Specifies the time at which the Interconnect Block resource was created.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachinesAssociated	array	A list of all virtual machine resource ids that are associated with the Interconnect Block.
zones	array	The availability zones.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
instanceView	object	The Interconnect Block instance view.
interconnectBlockId	string	A unique id (GUID) generated and assigned to the Interconnect Block by the platform which does not change throughout the lifetime of the resource.
interconnectGroup	object	The Microsoft.Network/interconnectGroups resource that this Interconnect Block is associated with. Required at create and immutable thereafter. Required.
location	string	The geo-location where the resource lives. Required.
placement	object	Placement section specifies the user-defined constraints for Interconnect Block hardware placement. This property cannot be changed once Interconnect Block is provisioned.
provisioningState	string	The provisioning state, which only appears in the response.
provisioningTime	string (date-time)	The date time when the Interconnect Block was last updated.
sku	object	SKU of the resource for which capacity needs to be pre-allocated. Both sku.name and sku.capacity are required at create. After create, only sku.capacity can be updated. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeCreated	string (date-time)	Specifies the time at which the Interconnect Block resource was created.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachinesAssociated	array	A list of all virtual machine resource ids that are associated with the Interconnect Block.
zones	array	The availability zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, interconnect_block_name, subscription_id	$expand	Retrieves information about an Interconnect Block.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all of the Interconnect Blocks in the specified resource group. Use the nextLink property in the response to get the next page of Interconnect Blocks.
list_by_subscription	select	subscription_id		Lists all of the Interconnect Blocks in the subscription. Use the nextLink property in the response to get the next page of Interconnect Blocks.
create_or_update	insert	resource_group_name, interconnect_block_name, subscription_id, location, sku		Creates or updates an Interconnect Block. When updating an Interconnect Block, only tags and sku.capacity may be modified.
update	update	resource_group_name, interconnect_block_name, subscription_id		Updates an Interconnect Block. When updating an Interconnect Block, only tags and sku.capacity may be modified.
create_or_update	replace	resource_group_name, interconnect_block_name, subscription_id, location, sku		Creates or updates an Interconnect Block. When updating an Interconnect Block, only tags and sku.capacity may be modified.
delete	delete	resource_group_name, interconnect_block_name, subscription_id		Deletes an Interconnect Block. The operation is only allowed when there are no virtual machines or VMSS VM instances associated with the Interconnect Block.

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_block_name	string	The name of the Interconnect Block. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	The expand expression to apply on the operation. 'instanceView' retrieves a snapshot of the runtime properties of the Interconnect Block that is managed by the platform and can change outside of control plane operations. "instanceView" Default value is None.

SELECT examples

get

Retrieves information about an Interconnect Block.

SELECT
id,
name,
instanceView,
interconnectBlockId,
interconnectGroup,
location,
placement,
provisioningState,
provisioningTime,
sku,
systemData,
tags,
timeCreated,
type,
virtualMachinesAssociated,
zones
FROM azure.compute.interconnect_blocks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND interconnect_block_name = '{{ interconnect_block_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Lists all of the Interconnect Blocks in the specified resource group. Use the nextLink property in the response to get the next page of Interconnect Blocks.

SELECT
id,
name,
instanceView,
interconnectBlockId,
interconnectGroup,
location,
placement,
provisioningState,
provisioningTime,
sku,
systemData,
tags,
timeCreated,
type,
virtualMachinesAssociated,
zones
FROM azure.compute.interconnect_blocks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all of the Interconnect Blocks in the subscription. Use the nextLink property in the response to get the next page of Interconnect Blocks.

SELECT
id,
name,
instanceView,
interconnectBlockId,
interconnectGroup,
location,
placement,
provisioningState,
provisioningTime,
sku,
systemData,
tags,
timeCreated,
type,
virtualMachinesAssociated,
zones
FROM azure.compute.interconnect_blocks
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an Interconnect Block. When updating an Interconnect Block, only tags and sku.capacity may be modified.

INSERT INTO azure.compute.interconnect_blocks (
tags,
location,
properties,
sku,
zones,
placement,
resource_group_name,
interconnect_block_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ zones }}',
'{{ placement }}',
'{{ resource_group_name }}',
'{{ interconnect_block_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
placement,
properties,
sku,
systemData,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: interconnect_blocks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the interconnect_blocks resource.
  - name: interconnect_block_name
    value: "{{ interconnect_block_name }}"
    description: Required parameter for the interconnect_blocks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the interconnect_blocks resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of the Interconnect Block.
    value:
      virtualMachinesAssociated:
        - id: "{{ id }}"
      interconnectGroup:
        id: "{{ id }}"
      interconnectBlockId: "{{ interconnectBlockId }}"
      provisioningTime: "{{ provisioningTime }}"
      provisioningState: "{{ provisioningState }}"
      instanceView:
        currentCapacity: {{ currentCapacity }}
        statuses:
          - code: "{{ code }}"
            level: "{{ level }}"
            displayStatus: "{{ displayStatus }}"
            message: "{{ message }}"
            time: "{{ time }}"
      timeCreated: "{{ timeCreated }}"
  - name: sku
    description: |
      SKU of the resource for which capacity needs to be pre-allocated. Both `sku.name` and `sku.capacity` are required at create. After create, only `sku.capacity` can be updated. Required.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      capacity: {{ capacity }}
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.
  - name: placement
    description: |
      Placement section specifies the user-defined constraints for Interconnect Block hardware placement. This property cannot be changed once Interconnect Block is provisioned.
    value:
      zonePlacementPolicy: "{{ zonePlacementPolicy }}"
      includeZones:
        - "{{ includeZones }}"
      excludeZones:
        - "{{ excludeZones }}"

UPDATE examples

update

Updates an Interconnect Block. When updating an Interconnect Block, only tags and sku.capacity may be modified.

UPDATE azure.compute.interconnect_blocks
SET 
tags = '{{ tags }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND interconnect_block_name = '{{ interconnect_block_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
placement,
properties,
sku,
systemData,
tags,
type,
zones;

REPLACE examples

create_or_update

Creates or updates an Interconnect Block. When updating an Interconnect Block, only tags and sku.capacity may be modified.

REPLACE azure.compute.interconnect_blocks
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
zones = '{{ zones }}',
placement = '{{ placement }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND interconnect_block_name = '{{ interconnect_block_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND sku = '{{ sku }}' --required
RETURNING
id,
name,
location,
placement,
properties,
sku,
systemData,
tags,
type,
zones;

DELETE examples

delete

Deletes an Interconnect Block. The operation is only allowed when there are no virtual machines or VMSS VM instances associated with the Interconnect Block.

DELETE FROM azure.compute.interconnect_blocks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND interconnect_block_name = '{{ interconnect_block_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;