Get-AzInterconnectGroup
Gets an interconnect group.
Syntax
ListParameterSet (Default)
Get-AzInterconnectGroup
[-ResourceGroupName <String>]
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByNameParameterSet
Get-AzInterconnectGroup
-ResourceGroupName <String>
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdParameterSet
Get-AzInterconnectGroup
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzInterconnectGroup cmdlet gets one or more interconnect groups. If no name is specified, all interconnect groups in the resource group are returned. If neither a resource group nor a name is specified, all interconnect groups in the subscription are returned.
Examples
Example 1: Get an interconnect group by name
$interconnectGroup = Get-AzInterconnectGroup -ResourceGroupName "ResourceGroup01" -Name "InterconnectGroup01"
This command gets the interconnect group named InterconnectGroup01 in the resource group named ResourceGroup01.
Example 2: List all interconnect groups in a resource group
Get-AzInterconnectGroup -ResourceGroupName "ResourceGroup01"
This command lists all interconnect groups in the resource group named ResourceGroup01.
Example 3: List all interconnect groups in the subscription
Get-AzInterconnectGroup
This command lists all interconnect groups in the current subscription.
Example 4: Get an interconnect group by resource ID
Get-AzInterconnectGroup -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.Network/interconnectGroups/InterconnectGroup01"
This command gets the interconnect group identified by the specified resource ID.
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 |
-Name
The name of the interconnect group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | ResourceName, InterconnectGroupName |
Parameter sets
ListParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
The resource group name of the interconnect group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ListParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceId
The resource id of the interconnect group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | InterconnectGroupId |
Parameter sets
GetByResourceIdParameterSet
| Position: | Named |
| Mandatory: | True |
| 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.
