Get-AzInterconnectBlock
Gets the properties of an Interconnect Block or lists Interconnect Blocks in a resource group or subscription.
Syntax
DefaultParameterSet (Default)
Get-AzInterconnectBlock
[-ResourceGroupName <String>]
[-Name <String>]
[-Expand <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzInterconnectBlock cmdlet retrieves properties of an Interconnect Block, or lists Interconnect Blocks within a resource group or the current subscription.
When neither -ResourceGroupName nor -Name is specified, all Interconnect Blocks in the current subscription are returned.
When only -ResourceGroupName is specified, all Interconnect Blocks in that resource group are returned.
When both -ResourceGroupName and -Name are specified without wildcards, a single Interconnect Block is returned.
Both parameters support wildcard characters, which trigger a list-and-filter operation instead of a direct GET.
Examples
Example 1: Get a specific Interconnect Block
Get-AzInterconnectBlock -ResourceGroupName "myRG" -Name "myICB"
This command retrieves the Interconnect Block named "myICB" in the resource group "myRG".
Example 2: Get an Interconnect Block with instance view
Get-AzInterconnectBlock -ResourceGroupName "myRG" -Name "myICB" -Expand "instanceView"
This command retrieves the Interconnect Block with its runtime instance view, including current capacity and status information.
Example 3: List Interconnect Blocks by wildcard name
Get-AzInterconnectBlock -ResourceGroupName "myRG" -Name "icb*"
This command lists all Interconnect Blocks in "myRG" whose name starts with "icb".
Example 4: List all Interconnect Blocks in a resource group
Get-AzInterconnectBlock -ResourceGroupName "myRG"
This command lists all Interconnect Blocks in the resource group "myRG".
Example 5: List all Interconnect Blocks in the subscription
Get-AzInterconnectBlock
This command lists all Interconnect Blocks in the current subscription.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Expand
The expand expression to apply on the operation. 'instanceView' retrieves a snapshot of the runtime properties of the Interconnect Block.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
DefaultParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
Specifies the name of the Interconnect Block resource. Supports wildcard characters.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
DefaultParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
Specifies the name of a resource group. Supports wildcard characters.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
DefaultParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
