你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az network express-route gateway connection

  • 参考

管理 ExpressRoute 网关连接。

命令

名称 说明 类型 状态
az network express-route gateway connection create

创建 ExpressRoute 网关连接。

 核心 GA
az network express-route gateway connection delete

删除 ExpressRoute 网关连接。

 核心 GA
az network express-route gateway connection list

列出 ExpressRoute 网关连接。

 核心 GA
az network express-route gateway connection show

获取 ExpressRoute 网关连接的详细信息。

 核心 GA
az network express-route gateway connection update

更新 ExpressRoute 网关连接。

 核心 GA
az network express-route gateway connection wait

将 CLI 置于等待状态，直到满足条件。

 核心 GA

az network express-route gateway connection create

编辑

创建 ExpressRoute 网关连接。

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]

示例

创建 ExpressRoute 网关连接。

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]

创建 ExpressRoute 网关连接。 （自动生成）

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

必需参数

--gateway-name

ExpressRoute 网关名称。

--name -n

ExpressRoute 连接名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--associated --associated-route-table
预览

与此路由配置关联的路由表的资源 ID。

--authorization-key

用于建立连接的授权密钥。

--circuit-name

ExpressRoute 线路名称。

--inbound-route-map

与此 RoutingConfiguration 关联的 RouteMap 的资源 ID，用于入站学习的路由。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--internet-security

启用 Internet 安全性。 虚拟中心可以传播学习的默认路由到此 ExpressRoute 连接。 此 ref https://review.docs.microsoft.com/en-us/azure/virtual-wan/effective-routes-virtual-hub?branch=pr-en-us-91866#aboutdefaultroute 可能很有用。 允许的值：false、true。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--labels
预览

传播的路由表的标签空间分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--outbound-route-map

与此 RoutingConfiguration 关联的RouteMap 的资源 ID，用于出站播发路由。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--peering

ExpressRoute 对等互连的名称或 ID。

--propagated --propagated-route-tables
预览

传播的路由表的资源 ID 的空间分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--routing-weight

与连接关联的路由权重。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az network express-route gateway connection delete

编辑

删除 ExpressRoute 网关连接。

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]

示例

删除 ExpressRoute 网关连接。 （自动生成）

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

可选参数

--gateway-name

ExpressRoute 网关名称。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

ExpressRoute 连接名称。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az network express-route gateway connection list

编辑

列出 ExpressRoute 网关连接。

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

示例

列出 ExpressRoute 网关连接。 （自动生成）

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

必需参数

--gateway-name

ExpressRoute 网关名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az network express-route gateway connection show

编辑

获取 ExpressRoute 网关连接的详细信息。

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

示例

获取 ExpressRoute 网关连接的详细信息。 （自动生成）

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

可选参数

--gateway-name

ExpressRoute 网关名称。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

ExpressRoute 连接名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az network express-route gateway connection update

编辑

更新 ExpressRoute 网关连接。

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]

示例

更新 ExpressRoute 网关连接。

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]

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value、string 或 JSON 字符串>。

--associated --associated-route-table
预览

与此路由配置关联的路由表的资源 ID。

--authorization-key

用于建立连接的授权密钥。

--circuit-name

ExpressRoute 线路名称。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--gateway-name

ExpressRoute 网关名称。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--inbound-route-map

与此 RoutingConfiguration 关联的 RouteMap 的资源 ID，用于入站学习的路由。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--internet-security

启用 Internet 安全性。 虚拟中心可以传播学习的默认路由到此 ExpressRoute 连接。 此 ref https://review.docs.microsoft.com/en-us/azure/virtual-wan/effective-routes-virtual-hub?branch=pr-en-us-91866#aboutdefaultroute 可能很有用。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--labels
预览

传播的路由表的标签空间分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--name -n

ExpressRoute 连接名称。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--outbound-route-map

与此 RoutingConfiguration 关联的RouteMap 的资源 ID，用于出站播发路由。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--peering

ExpressRoute 对等互连的名称或 ID。

--propagated --propagated-route-tables
预览

传播的路由表的资源 ID 的空间分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--remove

从列表中删除属性或元素。 示例：--remove property.list OR --remove propertyToRemove。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--routing-weight

与连接关联的路由权重。

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az network express-route gateway connection wait

编辑

将 CLI 置于等待状态，直到满足条件。

az network express-route gateway connection wait [--created]
                                                 [--custom]
                                                 [--deleted]
                                                 [--exists]
                                                 [--gateway-name]
                                                 [--ids]
                                                 [--interval]
                                                 [--name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--timeout]
                                                 [--updated]

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--gateway-name

ExpressRoute 网关名称。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30
--name -n

ExpressRoute 连接名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--timeout

最大等待（以秒为单位）。

默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。