Share via

az network vhub route-table

  • Reference

Note

This reference is part of the virtual-wan extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az network vhub route-table command. Learn more about extensions.

Manage route table in the virtual hub.

Commands

Name Description Type Status
az network vhub route-table create

Create a route table in the virtual hub.

 Extension GA
az network vhub route-table delete

Delete a route table in the virtual hub.

 Extension GA
az network vhub route-table list

List all route tables in the virtual hub.

 Extension GA
az network vhub route-table route

Manage routes of route table in the virtual hub.

 Extension GA
az network vhub route-table route add

Add a route into route table of the virtual hub.

 Extension GA
az network vhub route-table route list

List routes in the virtual hub route table.

 Extension GA
az network vhub route-table route remove

Remove a route from route table of the virtual hub.

 Extension GA
az network vhub route-table show

Show a route table in the virtual hub.

 Extension GA
az network vhub route-table update

Update a route table in the virtual hub.

 Extension GA
az network vhub route-table wait

Place the CLI in a waiting state until a condition of the vhub route-table is met.

 Extension GA

az network vhub route-table create

Create a route table in the virtual hub.

az network vhub route-table create --name
                                   --resource-group
                                   --vhub-name
                                   [--destination-type {CIDR, ResourceId, Service}]
                                   [--destinations]
                                   [--labels]
                                   [--next-hop]
                                   [--next-hop-type {ResourceId}]
                                   [--no-wait]
                                   [--route-name]

Examples

Create a v3 route table in the virtual hub.

az network vhub route-table create -n MyRouteTable -g MyResourceGroup --vhub-name MyVhub --route-name MyRoute --destination-type CIDR --destinations "10.4.0.0/16" "10.6.0.0/16" --next-hop-type ResourceId --next-hop /subscriptions/MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/azureFirewalls/MyFirewall --labels label1 label2

Required Parameters

--name -n

Name of the virtual hub route table.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Optional Parameters

--destination-type

The type of destinations.

Accepted values: CIDR, ResourceId, Service
--destinations

Space-separated list of all destinations.

--labels

Space-separated list of all labels associated with this route table.

--next-hop

The resource ID of the next hop.

--next-hop-type

The type of next hop.

Accepted values: ResourceId
--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--route-name

The name of the route.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network vhub route-table delete

Delete a route table in the virtual hub.

az network vhub route-table delete --name
                                   --resource-group
                                   --vhub-name

Examples

Delete a route table in the virtual hub.

az network vhub route-table delete -n MyRouteTable -g MyResourceGroup --vhub-name MyVhub

Required Parameters

--name -n

Name of the virtual hub route table.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network vhub route-table list

List all route tables in the virtual hub.

az network vhub route-table list --resource-group
                                 --vhub-name

Required Parameters

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network vhub route-table show

Show a route table in the virtual hub.

az network vhub route-table show --name
                                 --resource-group
                                 --vhub-name

Required Parameters

--name -n

Name of the virtual hub route table.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network vhub route-table update

Update a route table in the virtual hub.

az network vhub route-table update --name
                                   --resource-group
                                   --vhub-name
                                   [--labels]
                                   [--no-wait]

Examples

Update the labels for a v3 route table in the virtual hub.

az network vhub route-table update -n MyRouteTable -g MyResourceGroup --vhub-name MyVhub --labels label1 label2

Required Parameters

--name -n

Name of the virtual hub route table.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Optional Parameters

--labels

Space-separated list of all labels associated with this route table.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network vhub route-table wait

Place the CLI in a waiting state until a condition of the vhub route-table is met.

az network vhub route-table wait --name
                                 --resource-group
                                 --vhub-name
                                 [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--interval]
                                 [--timeout]
                                 [--updated]

Examples

Pause executing next line of CLI script until the route table is successfully provisioned.

az network vhub route-table wait -n MyRouteTable -g MyResourceGroup --vhub-name MyVhub --created

Required Parameters

--name -n

Name of the virtual hub route table.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--interval

Polling interval in seconds.

Default value: 30
--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.