Note

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

Access to this page requires authorization. You can try .

az network routeserver

Manage the route server.

Commands

Name Description Type Status
az network routeserver create

Create a route server.

 Core GA
az network routeserver delete

Delete a route server under a resource group.

 Core GA
az network routeserver list

List all route servers under a subscription or a resource group.

 Core GA
az network routeserver peering

Manage the route server peering.

 Core GA
az network routeserver peering create

Create a route server peering.

 Core GA
az network routeserver peering delete

Delete a route server peering.

 Core GA
az network routeserver peering list

List all route server peerings under a resource group.

 Core GA
az network routeserver peering list-advertised-routes

List all routes the route server bgp connection is advertising to the specified peer.

 Core GA
az network routeserver peering list-learned-routes

List all routes the route server bgp connection has learned.

 Core GA
az network routeserver peering show

Show a route server peering.

 Core GA
az network routeserver peering update

Update a route server peering.

 Core GA
az network routeserver peering wait

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

 Core GA
az network routeserver show

Show a route server.

 Core GA
az network routeserver update

Update a route server.

 Core GA
az network routeserver wait

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

 Core GA

az network routeserver create

Create a route server.

az network routeserver create --hosted-subnet
 --name
 --public-ip-address
 --resource-group
 [--acquire-policy-token]
 [--auto-scale-config]
 [--change-reference]
 [--hub-routing-preference {ASPath, ExpressRoute, VpnGateway}]
 [--location]
 [--tags]

Examples

Create a route server.

az network routeserver create --resource-group myresourcegroup --name myrouteserver --hosted-subnet my_subnet_id --public-ip-address my_public_ip

Required Parameters

--hosted-subnet

ID of a subnet where route server would be deployed.

--name -n

Name of the route server.

--public-ip-address

Name or ID of the public IP address.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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
--auto-scale-config

VirtualHub Router autoscale configuration. Use space-separated property=value [property=value ...].

Supported properties: min-capacity: The minimum number of scale units for VirtualHub Router.

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--hub-routing-preference

Routing preference of the route server.

Property Value
Accepted values: ASPath, ExpressRoute, VpnGateway
--location -l

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

--tags

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

az network routeserver delete

Delete a route server under a resource group.

az network routeserver delete [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name]
 [--no-wait]
 [--resource-group]
 [--subscription]
 [--yes]

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

Name of the route server.

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

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

Property Value
Default value: False
--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
--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
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False

az network routeserver list

List all route servers under a subscription or a resource group.

az network routeserver list [--max-items]
 [--next-token]
 [--resource-group]

Examples

List a route server.

az network routeserver list -g MyResourceGroup

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--resource-group -g

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

az network routeserver show

Show a route server.

az network routeserver show [--ids]
 [--name]
 [--resource-group]
 [--subscription]

Examples

Show a route server.

az network routeserver show -g MyResourceGroup -n MyRouteServer

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

Name of the route server.

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

Update a route server.

az network routeserver update [--acquire-policy-token]
 [--add]
 [--allow-b2b-traffic {0, 1, f, false, n, no, t, true, y, yes}]
 [--auto-scale-config]
 [--change-reference]
 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
 [--hub-routing-preference {ASPath, ExpressRoute, VpnGateway}]
 [--ids]
 [--name]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--remove]
 [--resource-group]
 [--set]
 [--subscription]
 [--tags]

Examples

Update a route server.

az network routeserver update --name myrouteserver --resource-group myresourcegroup --allow-b2b-traffic

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
--allow-b2b-traffic

Whether to allow branch to branch traffic.

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

The VirtualHub Router autoscale configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--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
--hub-routing-preference

Routing preference of the route server.

Property Value
Accepted values: ASPath, ExpressRoute, VpnGateway
--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

Name of the route server.

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

Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

az network routeserver wait

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

az network routeserver wait [--acquire-policy-token]
 [--change-reference]
 [--created]
 [--custom]
 [--deleted]
 [--exists]
 [--ids]
 [--interval]
 [--name]
 [--resource-group]
 [--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

Name of the route server.

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