Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az network route-table route

Manage routes in a route table.

Commands

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

az network route-table route create

Create a route in a route table.

az network route-table route create --name
 --resource-group
 --route-table-name
 [--acquire-policy-token]
 [--address-prefix]
 [--change-reference]
 [--next-hop-ip-address]
 [--next-hop-type {Internet, None, VirtualAppliance, VirtualNetworkGateway, VnetLocal}]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

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

--name -n

Route name.

--resource-group -g

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

--route-table-name

Route table name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--address-prefix

The destination CIDR to which the route applies.

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--next-hop-ip-address

The IP address packets should be forwarded to when using the VirtualAppliance hop type.

--next-hop-type

The type of Azure hop the packet should be sent to.

Property Value
Accepted values: Internet, None, VirtualAppliance, VirtualNetworkGateway, VnetLocal
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes

az network route-table route delete

Delete a route from a route table.

az network route-table route delete [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--name -n

Route name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--route-table-name

Route table name.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments

az network route-table route list

List routes in a route table.

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

Examples

List routes in a route table.

az network route-table route list -g MyResourceGroup --route-table-name MyRouteTable

Required Parameters

--resource-group -g

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

--route-table-name

Route table name.

az network route-table route show

Get the details of a route in a route table.

az network route-table route show [--ids]
 [--name]
 [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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.

Property Value
Parameter group: Resource Id Arguments
--name -n

Route name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--route-table-name

Route table name.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments

az network route-table route update

Update a route in a route table.

az network route-table route update [--acquire-policy-token]
 [--add]
 [--address-prefix]
 [--change-reference]
 [--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]

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.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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>.

Property Value
Parameter group: Generic Update Arguments
--address-prefix

The destination CIDR to which the route applies.

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--name -n

Route name.

Property Value
Parameter group: Resource Id Arguments
--next-hop-ip-address

The IP address packets should be forwarded to when using the VirtualAppliance hop type.

--next-hop-type

The type of Azure hop the packet should be sent to.

Property Value
Accepted values: Internet, None, VirtualAppliance, VirtualNetworkGateway, VnetLocal
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--route-table-name

Route table name.

Property Value
Parameter group: Resource Id Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments

az network route-table route wait

Place the CLI in a waiting state until a condition is met.

az network route-table route wait [--acquire-policy-token]
 [--change-reference]
 [--created]
 [--custom]
 [--deleted]
 [--exists]
 [--ids]
 [--interval]
 [--name]
 [--resource-group]
 [--route-table-name]
 [--subscription]
 [--timeout]
 [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name -n

Route name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--route-table-name

Route table name.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False

Feedback

Was this page helpful?