az network route-table route

  • Reference

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

Edit

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}]

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

--address-prefix

The destination CIDR to which the route applies.

--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.

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

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 route-table route delete

Edit

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]

Examples

Delete a route from a route table.

az network route-table route delete -g MyResourceGroup --route-table-name MyRouteTable -n MyRoute

Optional Parameters

--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.

--name -n

Route name.

--no-wait

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

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>.

--route-table-name

Route table name.

--subscription

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

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 route-table route list

Edit

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.

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 route-table route show

Edit

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

--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.

--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.

--subscription

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

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 route-table route update

Edit

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]

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

--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>.

--address-prefix

The destination CIDR to which the route applies.

--force-string

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

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.

--name -n

Route name.

--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.

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

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

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.

--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.

--set

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

--subscription

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

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 route-table route wait

Edit

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]

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
--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.

--interval

Polling interval in seconds.

Default value: 30
--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.

--subscription

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

--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.