az interconnect-group subgroup

Note

This reference is part of the interconnect extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az interconnect-group subgroup command. Learn more about extensions.

Manage Subgroup.

Commands

Name Description Type Status
az interconnect-group subgroup list

List all subgroups in an interconnect group.

Extension GA
az interconnect-group subgroup show

Get the specified subgroup in an interconnect group.

Extension GA

az interconnect-group subgroup list

List all subgroups in an interconnect group.

az interconnect-group subgroup list --group-name --interconnect-group-name
                                    --resource-group
                                    [--max-items]
                                    [--next-token]

Examples

List subgroups

az network interconnect-group subgroup list --resource-group rg1 --interconnect-group-name test-ig

Required Parameters

--group-name --interconnect-group-name

The name of the interconnect group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az interconnect-group subgroup show

Get the specified subgroup in an interconnect group.

az interconnect-group subgroup show [--group-name --interconnect-group-name]
                                    [--ids]
                                    [--name --subgroup-name]
                                    [--resource-group]
                                    [--subscription]

Examples

Get subgroup

az network interconnect-group subgroup show --resource-group rg1 --interconnect-group-name test-ig --subgroup-name subgroup0

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--group-name --interconnect-group-name

The name of the interconnect group.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --subgroup-name -n

The name of the subgroup.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False