Share via

az network express-route peering peer-connection

  • Preview

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage ExpressRoute circuit peer connections.

Commands

Name Description Type Status
az network express-route peering peer-connection list

Gets all global reach peer connections associated with a private peering in an express route circuit.

 Core Preview
az network express-route peering peer-connection show

Get the specified Peer Express Route Circuit Connection from the specified express route circuit.

 Core Preview

az network express-route peering peer-connection list

Edit
Preview

Command group 'az network express-route peering peer-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets all global reach peer connections associated with a private peering in an express route circuit.

az network express-route peering peer-connection list --circuit-name
                                                      --peering-name
                                                      --resource-group
                                                      [--max-items]
                                                      [--next-token]

Examples

List ExpressRouteCircuit PeerConnection

az network express-route peering connection list --circuit-name MyCircuit --peering-name MyPeering --resource-group MyResourceGroup

Required Parameters

--circuit-name

ExpressRoute circuit name.

--peering-name

Name of BGP peering (i.e. AzurePrivatePeering).

--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 network express-route peering peer-connection show

Edit
Preview

Command group 'az network express-route peering peer-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the specified Peer Express Route Circuit Connection from the specified express route circuit.

az network express-route peering peer-connection show [--circuit-name]
                                                      [--ids]
                                                      [--name]
                                                      [--peering-name]
                                                      [--resource-group]
                                                      [--subscription]

Examples

Show ExpressRouteCircuit Connection

az network express-route peering peer-connection show --circuit-name MyCircuit --name MyPeeringConnection --peering-name MyPeering --resource-group MyResourceGroup

Optional Parameters

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

--circuit-name

ExpressRoute circuit name.

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 -n

Name of the peering connection.

Property Value
Parameter group: Resource Id Arguments
--peering-name

Name of BGP peering (i.e. AzurePrivatePeering).

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