az network route-table route
Manage routes in a route table.
Name | Description | Type | Status |
---|---|---|---|
az network route-table route create |
Create a route in a route table. |
Core | GA |
az network route-table route delete |
Delete a route from a route table. |
Core | GA |
az network route-table route list |
List routes in a route table. |
Core | GA |
az network route-table route show |
Get the details of a route in a route table. |
Core | GA |
az network route-table route update |
Update a route in a route table. |
Core | GA |
az network route-table route wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
Create a route in a route table.
az network route-table route create --name
--resource-group
--route-table-name
[--address-prefix]
[--next-hop-ip-address]
[--next-hop-type {Internet, None, VirtualAppliance, VirtualNetworkGateway, VnetLocal}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
Create a route that forces all inbound traffic to a Network Virtual Appliance.
az network route-table route create -g MyResourceGroup --route-table-name MyRouteTable -n MyRoute --next-hop-type VirtualAppliance --address-prefix 10.0.0.0/16 --next-hop-ip-address 10.0.100.4
Route name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Route table name.
The destination CIDR to which the route applies.
The IP address packets should be forwarded to when using the VirtualAppliance hop type.
The type of Azure hop the packet should be sent to.
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.
Delete a route from a route table.
az network route-table route delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--route-table-name]
[--subscription]
Delete a route from a route table.
az network route-table route delete -g MyResourceGroup --route-table-name MyRouteTable -n MyRoute
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.
Route name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Route table name.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
List routes in a route table.
az network route-table route list --resource-group
--route-table-name
List routes in a route table.
az network route-table route list -g MyResourceGroup --route-table-name MyRouteTable
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Route table name.
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.
Get the details of a route in a route table.
az network route-table route show [--ids]
[--name]
[--resource-group]
[--route-table-name]
[--subscription]
Get the details of a route in a route table.
az network route-table route show -g MyResourceGroup --route-table-name MyRouteTable -n MyRoute -o table
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.
Route name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Route table name.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Update a route in a route table.
az network route-table route update [--add]
[--address-prefix]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--next-hop-ip-address]
[--next-hop-type {Internet, None, VirtualAppliance, VirtualNetworkGateway, VnetLocal}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--route-table-name]
[--set]
[--subscription]
Update a route in a route table to change the next hop ip address.
az network route-table route update -g MyResourceGroup --route-table-name MyRouteTable -n MyRoute --next-hop-ip-address 10.0.100.5
Update a route in a route table.
az network route-table route update --address-prefix 10.0.0.0/16 --name MyRoute --next-hop-ip-address 10.0.100.5 --next-hop-type VirtualNetworkGateway --resource-group MyResourceGroup --route-table-name MyRouteTable
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>
.
The destination CIDR to which the route applies.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Route name.
The IP address packets should be forwarded to when using the VirtualAppliance hop type.
The type of Azure hop the packet should be sent to.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Route table name.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Place the CLI in a waiting state until a condition is met.
az network route-table route wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--route-table-name]
[--subscription]
[--timeout]
[--updated]
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.
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.
Polling interval in seconds.
Route name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Route table name.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: