az network vrouter

Manage the virtual router. This feature supports both VirtualHub and VirtualRouter. Considering VirtualRouter is depcated, we recommand to create VirtualRouter instead.

Commands

az network vrouter create

Create a virtual router.

az network vrouter delete

Delete a virtual router under a resource group.

az network vrouter list

List all virtual routers under a subscription or a resource group.

az network vrouter peering

Manage the virtual router peering.

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 show

Show a virtual router.

az network vrouter update

Update a virtual router.

az network vrouter create

Create a virtual router.

az network vrouter create --name
                          --resource-group
                          [--hosted-gateway]
                          [--hosted-subnet]
                          [--location]
                          [--subscription]
                          [--tags]

Required Parameters

--name -n

The name of the Virtual Router.

--resource-group -g

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

Optional Parameters

--hosted-gateway

Name or ID of the virtual network gateway with ExpressRouter on which VirtualRouter is hosted.

--hosted-subnet

The ID of a subnet where VirtualRouter would be deployed.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az network vrouter delete

Delete a virtual router under a resource group.

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

Required Parameters

--name -n

The name of the Virtual Router.

--resource-group -g

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

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 list

List all virtual routers under a subscription or a resource group.

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

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.

--resource-group -g

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

--subscription

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

az network vrouter show

Show a virtual router.

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

Required Parameters

--name -n

The name of the Virtual Router.

--resource-group -g

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

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 update

Update a virtual router.

az network vrouter update --name
                          --resource-group
                          [--add]
                          [--force-string]
                          [--remove]
                          [--set]
                          [--subscription]
                          [--tags]

Required Parameters

--name -n

The name of the Virtual Router.

--resource-group -g

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

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.

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.