az network vrouter peering

Manage the virtual router peering.

Commands

az network vrouter peering create

Create a virtual router peering.

az network vrouter peering delete

Delete a virtual router peering.

az network vrouter peering list

List all virtual router peerings under a resource group.

az network vrouter peering show

Show a virtual router peering.

az network vrouter peering update

Update a virtual router peering.

az network vrouter peering create

Create a virtual router peering.

az network vrouter peering create --name
                                  --peer-asn
                                  --peer-ip
                                  --resource-group
                                  --vrouter-name
                                  [--subscription]

Required Parameters

--name -n

The name of the Virtual Router Peering.

--peer-asn

Peer ASN. Its range is from 1 to 4294967295.

--peer-ip

Peer IP address.

--resource-group -g

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

--vrouter-name

The name of the Virtual Router.

Optional Parameters

--subscription

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

az network vrouter peering delete

Delete a virtual router peering.

az network vrouter peering delete --name
                                  --resource-group
                                  --vrouter-name
                                  [--subscription]

Required Parameters

--name -n

The name of the Virtual Router Peering.

--resource-group -g

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

--vrouter-name

The name of the Virtual Router.

Optional Parameters

--subscription

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

az network vrouter peering list

List all virtual router peerings under a resource group.

az network vrouter peering list --resource-group
                                --vrouter-name
                                [--query-examples]
                                [--subscription]

Required Parameters

--resource-group -g

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

--vrouter-name

The name of the Virtual Router.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az network vrouter peering show

Show a virtual router peering.

az network vrouter peering show --name
                                --resource-group
                                --vrouter-name
                                [--query-examples]
                                [--subscription]

Required Parameters

--name -n

The name of the Virtual Router Peering.

--resource-group -g

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

--vrouter-name

The name of the Virtual Router.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az network vrouter peering update

Update a virtual router peering.

az network vrouter peering update --name
                                  --resource-group
                                  --vrouter-name
                                  [--add]
                                  [--force-string]
                                  [--peer-asn]
                                  [--peer-ip]
                                  [--remove]
                                  [--set]
                                  [--subscription]

Required Parameters

--name -n

The name of the Virtual Router Peering.

--resource-group -g

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

--vrouter-name

The name of the Virtual Router.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--peer-asn

Peer ASN. Its range is from 1 to 4294967295.

--peer-ip

Peer IP address.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subscription

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