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

az network vhub route-map

注意

此参考是 Azure CLI(版本 2.55.0 或更高版本)的虚拟 wan 扩展的一部分。 该扩展将在首次运行 az network vhub route-map 命令时自动安装。 详细了解扩展。

管理路线图。

命令

名称 说明 类型 状态
az network vhub route-map create

创建路线图。

扩展 GA
az network vhub route-map delete

删除路线图。

扩展 GA
az network vhub route-map get-inbound-routes

获取为特定连接上的虚拟中心配置的入站路由。

扩展 GA
az network vhub route-map get-outbound-routes

获取在特定连接上为虚拟中心配置的出站路由。

扩展 GA
az network vhub route-map list

按资源组列出路由映射。

扩展 GA
az network vhub route-map rule

管理路由映射规则。

扩展 GA
az network vhub route-map rule add

添加路由映射规则。

扩展 GA
az network vhub route-map rule delete

删除路由映射规则。

扩展 GA
az network vhub route-map rule list

列出路由映射规则。

扩展 GA
az network vhub route-map rule show

显示路线地图规则。

扩展 GA
az network vhub route-map rule wait

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

扩展 GA
az network vhub route-map show

显示路线图的详细信息。

扩展 GA
az network vhub route-map update

更新路线图。

扩展 GA
az network vhub route-map wait

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

扩展 GA

az network vhub route-map create

创建路线图。

az network vhub route-map create --name
                                 --resource-group
                                 --vhub-name
                                 [--inbound-connection]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--outbound-connections]
                                 [--rules]

示例

创建路线图

az network vhub route-map create -n route-map-name -g rg --vhub-name vhub-name

必需参数

--name --route-map-name -n

RouteMap 的名称。

--resource-group -g

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

--vhub-name

包含 RouteMap 的 VirtualHub 的名称。

可选参数

--inbound-connection

与此 RoutMap 关联的入站流量的连接列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--no-wait

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

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

与此 RoutMap 关联的出站流量的连接列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--rules

要应用的 RouteMap 规则列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

全局参数
--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 vhub route-map delete

删除路线图。

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

示例

删除路线图

az network vhub route-map delete -n route-map-name -g rg --vhub-name vhub-name

可选参数

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--name --route-map-name -n

RouteMap 的名称。

--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 配置默认订阅。

--vhub-name

包含 RouteMap 的 VirtualHub 的名称。

--yes -y

不提示确认。

默认值: 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 获取完整的调试日志。

az network vhub route-map get-inbound-routes

获取为特定连接上的虚拟中心配置的入站路由。

az network vhub route-map get-inbound-routes [--connection-type]
                                             [--ids]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--resource-group]
                                             [--resource-uri]
                                             [--subscription]
                                             [--vhub-name]

示例

获取入站路由

az network vhub route-map get-inbound-routes -g rg --vhub-name vhub-name --connection-type ExpressRouteConnection --resource-uri /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1

可选参数

--connection-type

指定的连接资源的类型,例如 ExpressRoute连接ion、HubVirtualNetwork连接ion、Vpn连接ion 和 P2S连接ion。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--no-wait

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

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

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

--resource-uri

请求其入站路由的连接资源。

--subscription

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

--vhub-name

VirtualHub 的名称。

全局参数
--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 vhub route-map get-outbound-routes

获取在特定连接上为虚拟中心配置的出站路由。

az network vhub route-map get-outbound-routes [--connection-type]
                                              [--ids]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--resource-uri]
                                              [--subscription]
                                              [--vhub-name]

示例

获取出站路由

az network vhub route-map get-outbound-routes -g rg --vhub-name vhub-name --connection-type ExpressRouteConnection --resource-uri /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1

可选参数

--connection-type

指定的连接资源的类型,例如 ExpressRoute连接ion、HubVirtualNetwork连接ion、Vpn连接ion 和 P2S连接ion。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--no-wait

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

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

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

--resource-uri

请求其出站路由的连接资源。

--subscription

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

--vhub-name

VirtualHub 的名称。

全局参数
--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 vhub route-map list

按资源组列出路由映射。

az network vhub route-map list --resource-group
                               --vhub-name

示例

按资源组列出路由映射

az network vhub route-map list -g rg --vhub-name vhub-name

必需参数

--resource-group -g

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

--vhub-name

包含 RouteMap 的 VirtualHub 的名称。

全局参数
--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 vhub route-map show

显示路线图的详细信息。

az network vhub route-map show [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--vhub-name]

示例

推路线图

az network vhub route-map show -n route-map-name -g rg --vhub-name vhub-name

可选参数

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--name --route-map-name -n

RouteMap 的名称。

--resource-group -g

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

--subscription

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

--vhub-name

包含 RouteMap 的 VirtualHub 的名称。

全局参数
--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 vhub route-map update

更新路线图。

az network vhub route-map update [--add]
                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--ids]
                                 [--inbound-connection]
                                 [--name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--outbound-connections]
                                 [--remove]
                                 [--resource-group]
                                 [--rules]
                                 [--set]
                                 [--subscription]
                                 [--vhub-name]

示例

更新路由映射

az network vhub route-map update -n route-map-name -g rg --vhub-name vhub-name --rules "[{name:rule1,matchCriteria:[{matchCondition:Contains,routePrefix:[10.0.0.0/8]}],actions:[{type:Add,parameters:[{asPath:[22334]}]}]}]"

可选参数

--add

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

--force-string

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

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

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--inbound-connection

与此 RoutMap 关联的入站流量的连接列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--name --route-map-name -n

RouteMap 的名称。

--no-wait

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

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

与此 RoutMap 关联的出站流量的连接列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--remove

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

--resource-group -g

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

--rules

要应用的 RouteMap 规则列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--set

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

--subscription

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

--vhub-name

包含 RouteMap 的 VirtualHub 的名称。

全局参数
--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 vhub route-map wait

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

az network vhub route-map wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--timeout]
                               [--updated]
                               [--vhub-name]

可选参数

--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--interval

轮询间隔(以秒为单位)。

默认值: 30
--name --route-map-name -n

RouteMap 的名称。

--resource-group -g

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

--subscription

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

--timeout

最大等待(以秒为单位)。

默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False
--vhub-name

包含 RouteMap 的 VirtualHub 的名称。

全局参数
--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 获取完整的调试日志。