az network route-table route
Manage routes in a route table.
Commands
az network route-table route create |
Create a route in a route table. |
az network route-table route delete |
Delete a route from a route table. |
az network route-table route list |
List routes in a route table. |
az network route-table route show |
Get the details of a route in a route table. |
az network route-table route update |
Update a route in a route table. |
az network route-table route create
Create a route in a route table.
az network route-table route create --address-prefix
--name
--next-hop-type {Internet, None, VirtualAppliance, VirtualNetworkGateway, VnetLocal}
--resource-group
--route-table-name
[--next-hop-ip-address]
[--subscription]
Examples
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
Required Parameters
The destination CIDR to which the route applies.
Route name.
The type of Azure hop the packet should be sent to.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Route table name.
Optional Parameters
The IP address packets should be forwarded to when using the VirtualAppliance hop type.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network route-table route delete
Delete a route from a route table.
az network route-table route delete [--ids]
[--name]
[--resource-group]
[--route-table-name]
[--subscription]
Examples
Delete a route from a route table.
az network route-table route delete -g MyResourceGroup --route-table-name MyRouteTable -n MyRoute
Optional Parameters
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
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network route-table route list
List routes in a route table.
az network route-table route list --resource-group
--route-table-name
[--query-examples]
[--subscription]
Examples
List routes in a route table.
az network route-table route list -g MyResourceGroup --route-table-name MyRouteTable
Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Route table name.
Optional Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network route-table route show
Get the details of a route in a route table.
az network route-table route show [--ids]
[--name]
[--query-examples]
[--resource-group]
[--route-table-name]
[--subscription]
Examples
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
Optional Parameters
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.
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.
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
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network route-table route update
Update a route in a route table.
az network route-table route update [--add]
[--address-prefix]
[--force-string]
[--ids]
[--name]
[--next-hop-ip-address]
[--next-hop-type {Internet, None, VirtualAppliance, VirtualNetworkGateway, VnetLocal}]
[--remove]
[--resource-group]
[--route-table-name]
[--set]
[--subscription]
Examples
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. (autogenerated)
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 --route-table-name MyRouteTable
Optional Parameters
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.
Remove a property or an element from a list. Example: --remove property.list 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=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Increase logging verbosity. Use --debug for full debug logs.