az network vhub route-table
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 of the virtual hub route table.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the virtual hub.
Optional Parameters
The type of destinations.
Space-separated list of all destinations.
Space-separated list of all labels associated with this route table.
The resource ID of the next hop.
The type of next hop.
Do not wait for the long-running operation to finish.
The name of the route.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 of the virtual hub route table.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the virtual hub.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the virtual hub.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 of the virtual hub route table.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the virtual hub.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 of the virtual hub route table.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the virtual hub.
Optional Parameters
Space-separated list of all labels associated with this route table.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 of the virtual hub route table.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the virtual hub.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.