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
Create an ExpressRoute gateway connection.
az network express-route gateway connection create --gateway-name
--name
--resource-group
[--associated]
[--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]
[--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
ExpressRoute gateway name.
ExpressRoute connection name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The resource id of route table associated with this routing configuration.
Authorization key to establish the connection.
ExpressRoute circuit name.
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.
Enable internet security. A virtual hub can have the ability to propagate a learned default route to this ExpressRoute connection. This ref https://review.docs.microsoft.com/en-us/azure/virtual-wan/effective-routes-virtual-hub?branch=pr-en-us-91866#aboutdefaultroute might be helpful. Allowed values: false, true.
Space-separated list of labels for propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
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.
Name or ID of an ExpressRoute peering.
Space-separated list of resource id of propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Routing weight associated with the connection.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network express-route gateway connection delete
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
ExpressRoute gateway name.
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.
ExpressRoute connection name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network express-route gateway connection list
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
ExpressRoute gateway name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network express-route gateway connection show
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
ExpressRoute gateway name.
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.
ExpressRoute connection name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network express-route gateway connection update
Update an ExpressRoute gateway connection.
az network express-route gateway connection update [--add]
[--associated]
[--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]
[--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
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>
.
The resource id of route table associated with this routing configuration.
Authorization key to establish the connection.
ExpressRoute circuit name.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
ExpressRoute gateway name.
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.
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.
Enable internet security. A virtual hub can have the ability to propagate a learned default route to this ExpressRoute connection. This ref https://review.docs.microsoft.com/en-us/azure/virtual-wan/effective-routes-virtual-hub?branch=pr-en-us-91866#aboutdefaultroute might be helpful.
Space-separated list of labels for propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
ExpressRoute connection name.
Do not wait for the long-running operation to finish.
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.
Name or ID of an ExpressRoute peering.
Space-separated list of resource id of propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Routing weight associated with the connection.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network express-route gateway connection wait
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
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
ExpressRoute gateway name.
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.
Polling interval in seconds.
ExpressRoute connection name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.