Get-AzInterconnectGroupSubgroup
Gets a subgroup of an interconnect group.
Syntax
GetByNameParameterSet (Default)
Get-AzInterconnectGroupSubgroup
-ResourceGroupName <String>
-InterconnectGroupName <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdParameterSet
Get-AzInterconnectGroupSubgroup
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzInterconnectGroupSubgroup cmdlet gets one or more subgroups of an interconnect group. Subgroups are read-only child resources that are created and managed by the platform. If no name is specified, all subgroups of the interconnect group are returned.
Examples
Example 1: List all subgroups of an interconnect group
Get-AzInterconnectGroupSubgroup -ResourceGroupName "ResourceGroup01" -InterconnectGroupName "InterconnectGroup01"
This command lists all subgroups of the interconnect group named InterconnectGroup01.
Example 2: Get a subgroup by name
Get-AzInterconnectGroupSubgroup -ResourceGroupName "ResourceGroup01" -InterconnectGroupName "InterconnectGroup01" -Name "Subgroup01"
This command gets the subgroup named Subgroup01 of the interconnect group named InterconnectGroup01.
Example 3: Get a subgroup by resource ID
Get-AzInterconnectGroupSubgroup -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.Network/interconnectGroups/InterconnectGroup01/subgroups/Subgroup01"
This command gets the subgroup 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 |
-InterconnectGroupName
The name of the interconnect group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByNameParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
The name of the subgroup.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | ResourceName, SubgroupName |
Parameter sets
GetByNameParameterSet
| 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
GetByNameParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceId
The resource id of the subgroup.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SubgroupId |
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.
