Share via

az network express-route gateway connection

Manage ExpressRoute gateway connections.

Commands

Name Description Type Status
az network express-route gateway connection create

Create an ExpressRoute gateway connection.

 Core GA
az network express-route gateway connection delete

Delete an ExpressRoute gateway connection.

 Core GA
az network express-route gateway connection list

List ExpressRoute gateway connections.

 Core GA
az network express-route gateway connection show

Get the details of an ExpressRoute gateway connection.

 Core GA
az network express-route gateway connection update

Update an ExpressRoute gateway connection.

 Core GA
az network express-route gateway connection wait

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

 Core GA

az network express-route gateway connection create

Edit

Create an ExpressRoute gateway connection.

az network express-route gateway connection create --gateway-name
                                                   --name
                                                   --resource-group
                                                   [--associated --associated-route-table]
                                                   [--authorization-key]
                                                   [--circuit-name]
                                                   [--inbound-route-map]
                                                   [--internet-security {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--labels]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--outbound-route-map]
                                                   [--peering]
                                                   [--propagated --propagated-route-tables]
                                                   [--routing-weight]

Examples

Create an ExpressRoute gateway connection.

az network express-route gateway connection create --gateway-name MyGateway -n MyExpressRouteConnection -g MyResourceGroup --peering /subscriptions/MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/expressRouteCircuits/MyCircuit/peerings/AzurePrivatePeering --associated-route-table /MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 --propagated-route-tables [/MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1,/MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable2] --labels [label1,label2]

Create an ExpressRoute gateway connection. (autogenerated)

az network express-route gateway connection create --gateway-name MyGateway --name MyExpressRouteConnection --peering /subscriptions/MySub/resourceGroups/MyResourceGroup/provi ders/Microsoft.Network/expressRouteCircuits/MyCircuit/peerings/AzurePrivatePeering --resource-group MyResourceGroup

Required Parameters

--gateway-name

ExpressRoute gateway name.

--name -n

ExpressRoute connection name.

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

--associated --associated-route-table
Preview

The resource id of route table associated with this routing configuration.

Property Value
Parameter group: Routing Configuration Arguments
--authorization-key

Authorization key to establish the connection.

--circuit-name

ExpressRoute circuit name.

Property Value
Parameter group: Peering Arguments
--inbound-route-map

The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: RoutingConfiguration Arguments
--internet-security

Enable internet security. A virtual hub can have the ability to propagate a learned default route to this ExpressRoute connection. This ref https://review.learn.microsoft.com/en-us/azure/virtual-wan/effective-routes-virtual-hub?branch=pr-en-us-91866#aboutdefaultroute might be helpful. Allowed values: false, true.

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

Space-separated list of labels for propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Routing Configuration 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
--outbound-route-map

The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: RoutingConfiguration Arguments
--peering

Name or ID of an ExpressRoute peering.

Property Value
Parameter group: Peering Arguments
--propagated --propagated-route-tables
Preview

Space-separated list of resource id of propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Routing Configuration Arguments
--routing-weight

Routing weight associated with the connection.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network express-route gateway connection delete

Edit

Delete an ExpressRoute gateway connection.

az network express-route gateway connection delete [--gateway-name]
                                                   [--ids]
                                                   [--name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--subscription]

Examples

Delete an ExpressRoute gateway connection. (autogenerated)

az network express-route gateway connection delete --gateway-name MyGateway --name MyExpressRouteConnection --resource-group 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.

--gateway-name

ExpressRoute gateway name.

Property Value
Parameter group: Resource Id 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

ExpressRoute connection 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
--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
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network express-route gateway connection list

Edit

List ExpressRoute gateway connections.

az network express-route gateway connection list --gateway-name
                                                 --resource-group

Examples

List ExpressRoute gateway connections. (autogenerated)

az network express-route gateway connection list --gateway-name MyGateway --resource-group MyResourceGroup

Required Parameters

--gateway-name

ExpressRoute gateway name.

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network express-route gateway connection show

Edit

Get the details of an ExpressRoute gateway connection.

az network express-route gateway connection show [--gateway-name]
                                                 [--ids]
                                                 [--name]
                                                 [--resource-group]
                                                 [--subscription]

Examples

Get the details of an ExpressRoute gateway connection. (autogenerated)

az network express-route gateway connection show --gateway-name MyGateway --name MyExpressRouteConnection --resource-group 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.

--gateway-name

ExpressRoute gateway name.

Property Value
Parameter group: Resource Id 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

ExpressRoute connection 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
--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
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network express-route gateway connection update

Edit

Update an ExpressRoute gateway connection.

az network express-route gateway connection update [--add]
                                                   [--associated --associated-route-table]
                                                   [--authorization-key]
                                                   [--circuit-name]
                                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--gateway-name]
                                                   [--ids]
                                                   [--inbound-route-map]
                                                   [--internet-security {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--labels]
                                                   [--name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--outbound-route-map]
                                                   [--peering]
                                                   [--propagated --propagated-route-tables]
                                                   [--remove]
                                                   [--resource-group]
                                                   [--routing-weight]
                                                   [--set]
                                                   [--subscription]

Examples

Update an ExpressRoute gateway connection.

az network express-route gateway connection update --gateway-name MyGateway -n MyExpressRouteConnection -g MyResourceGroup --peering /subscriptions/MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/expressRouteCircuits/MyCircuit/peerings/AzurePrivatePeering --associated-route-table /MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 --propagated-route-tables [/MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1,/MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable2] --labels [label1,label2]

Optional Parameters

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

--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
--associated --associated-route-table
Preview

The resource id of route table associated with this routing configuration.

Property Value
Parameter group: Routing Configuration Arguments
--authorization-key

Authorization key to establish the connection.

--circuit-name

ExpressRoute circuit name.

Property Value
Parameter group: Peering 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
--gateway-name

ExpressRoute gateway name.

Property Value
Parameter group: Resource Id 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
--inbound-route-map

The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: RoutingConfiguration Arguments
--internet-security

Enable internet security. A virtual hub can have the ability to propagate a learned default route to this ExpressRoute connection. This ref https://review.learn.microsoft.com/en-us/azure/virtual-wan/effective-routes-virtual-hub?branch=pr-en-us-91866#aboutdefaultroute might be helpful.

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

Space-separated list of labels for propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Routing Configuration Arguments
--name -n

ExpressRoute connection 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
--outbound-route-map

The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: RoutingConfiguration Arguments
--peering

Name or ID of an ExpressRoute peering.

Property Value
Parameter group: Peering Arguments
--propagated --propagated-route-tables
Preview

Space-separated list of resource id of propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Routing Configuration Arguments
--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
--routing-weight

Routing weight associated with the connection.

--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
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network express-route gateway connection wait

Edit

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

az network express-route gateway connection wait [--created]
                                                 [--custom]
                                                 [--deleted]
                                                 [--exists]
                                                 [--gateway-name]
                                                 [--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.

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

ExpressRoute gateway name.

Property Value
Parameter group: Resource Id 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
--interval

Polling interval in seconds.

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

ExpressRoute connection 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
--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
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False