az network route-table

Manage route tables.

Commands

az network route-table create

Create a route table.

az network route-table delete

Delete a route table.

az network route-table list

List route tables.

az network route-table route

Manage routes in a route table.

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 show

Get the details of a route table.

az network route-table update

Update a route table.

az network route-table create

Create a route table.

az network route-table create --name
                              --resource-group
                              [--disable-bgp-route-propagation {false, true}]
                              [--location]
                              [--subscription]
                              [--tags]

Examples

Create a route table.

az network route-table create -g MyResourceGroup -n MyRouteTable

Required Parameters

--name -n

Name of the route table.

--resource-group -g

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

Optional Parameters

--disable-bgp-route-propagation

Disable routes learned by BGP.

accepted values: false, true
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az network route-table delete

Delete a route table.

az network route-table delete [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

Examples

Delete a route table.

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

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

Name of the route table.

--resource-group -g

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

--subscription

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

az network route-table list

List route tables.

az network route-table list [--query-examples]
                            [--resource-group]
                            [--subscription]

Examples

List all route tables in a subscription.

az network route-table list -g MyResourceGroup

Optional Parameters

--query-examples

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.

--resource-group -g

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

--subscription

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

az network route-table show

Get the details of a route table.

az network route-table show [--expand]
                            [--ids]
                            [--name]
                            [--query-examples]
                            [--resource-group]
                            [--subscription]

Examples

Get the details of a route table.

az network route-table show -g MyResourceGroup -n MyRouteTable

Optional Parameters

--expand

Expands referenced resources.

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

Name of the route table.

--query-examples

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.

--resource-group -g

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

--subscription

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

az network route-table update

Update a route table.

az network route-table update [--add]
                              [--disable-bgp-route-propagation {false, true}]
                              [--force-string]
                              [--ids]
                              [--name]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--subscription]
                              [--tags]

Examples

Update a route table to disable BGP route propogation.

az network route-table update -g MyResourceGroup -n MyRouteTable --disable-bgp-route-propagation true

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

--disable-bgp-route-propagation

Disable routes learned by BGP.

accepted values: false, true
--force-string

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

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

Name of the route table.

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.