az network vhub
Note
此参考是 Azure CLI(版本 2.55.0 或更高版本) 的虚拟 wan 扩展的一部分。 该扩展将在首次运行 az network vhub 命令时自动安装。 了解更多关于扩展的信息。
管理虚拟中心。
命令
az network vhub create
创建虚拟中心。
az network vhub create --name
--resource-group
[--address-prefix]
[--allow-b2b-traffic {0, 1, f, false, n, no, t, true, y, yes}]
[--asn]
[--auto-scale-config]
[--hub-routing-preference {ASPath, ExpressRoute, VpnGateway}]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--sku]
[--tags]
[--vwan]
示例
创建虚拟中心。
az network vhub create -g MyRG -n MyVHub --vwan MyVWan --address-prefix 10.0.0.0/24 -l SouthCentralUS --sku Standard
必需参数
虚拟中心的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
虚拟中心的 CIDR 地址前缀。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
用于控制 VirtualRouter 中心的分支到分支流量的标志。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
VirtualRouter ASN。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
VirtualHub 路由器自动缩放配置。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
中心路由首选项网关类型。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
| 接受的值: | ASPath, ExpressRoute, VpnGateway |
Location.
az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。 如果未指定,将使用资源组的位置。
| 属性 | 值 |
|---|---|
| 参数组: | VirtualHubParameters Arguments |
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
VirtualHub 的 SKU。 允许的值:基本值、标准值。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
空格分隔标记:key[=value] [key[=value] ...]。支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
| 属性 | 值 |
|---|---|
| 参数组: | VirtualHubParameters Arguments |
虚拟 WAN 的名称或 ID。
| 属性 | 值 |
|---|---|
| 参数组: | VirtualWan Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az network vhub delete
删除虚拟中心。
az network vhub delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
示例
删除虚拟中心。
az network vhub delete -n MyVHub -g MyRG
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
虚拟中心的名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
不要提示确认。
| 属性 | 值 |
|---|---|
| 默认值: | False |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az network vhub get-effective-routes
获取为虚拟中心资源或指定资源配置的有效路由。
az network vhub get-effective-routes [--ids]
[--name]
[--no-wait]
[--resource-group]
[--resource-id]
[--resource-type]
[--subscription]
示例
获取为虚拟中心中的路由表配置的有效路由。
az network vhub get-effective-routes --resource-type RouteTable --resource-id /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable -g MyRG -n MyHub
获取为虚拟中心中的 P2S 连接配置的有效路由。
az network vhub get-effective-routes --resource-type P2SConnection --resource-id /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/p2sVpnGateways/MyGateway/p2sConnectionConfigurations/MyConnection -g MyRG -n MyHub
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
虚拟中心的名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 默认值: | False |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
请求其有效路由的资源。
指定资源的类型,如 RouteTable、ExpressRouteConnection、HubVirtualNetworkConnection、VpnConnection 和 P2SConnection。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az network vhub list
列出虚拟中心。
az network vhub list [--resource-group]
示例
列出虚拟中心。
az network vhub list -g MyRG
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az network vhub show
获取虚拟中心的详细信息。
az network vhub show [--ids]
[--name]
[--resource-group]
[--subscription]
示例
获取虚拟中心的详细信息。
az network vhub show -n MyVHub -g MyRG
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
虚拟中心的名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az network vhub update
更新虚拟中心的设置。
az network vhub update [--add]
[--address-prefix]
[--allow-b2b-traffic {0, 1, f, false, n, no, t, true, y, yes}]
[--asn]
[--auto-scale-config]
[--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]
[--sku]
[--subscription]
[--tags]
[--vwan]
示例
更新虚拟中心的设置。
az network vhub update -g MyRG -n MyVHub --sku Basic --hub-routing-preference VpnGateway
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>。
| 属性 | 值 |
|---|---|
| 参数组: | Generic Update Arguments |
虚拟中心的 CIDR 地址前缀。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
用于控制 VirtualRouter 中心的分支到分支流量的标志。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
VirtualRouter ASN。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
VirtualHub 路由器自动缩放配置。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。
| 属性 | 值 |
|---|---|
| 参数组: | Generic Update Arguments |
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
中心路由首选项网关类型。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
| 接受的值: | ASPath, ExpressRoute, VpnGateway |
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
虚拟中心的名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
从列表中删除属性或元素。 示例: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| 属性 | 值 |
|---|---|
| 参数组: | Generic Update Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>。
| 属性 | 值 |
|---|---|
| 参数组: | Generic Update Arguments |
VirtualHub 的 SKU。
| 属性 | 值 |
|---|---|
| 参数组: | Properties Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
空格分隔标记:key[=value] [key[=value] ...]。支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
| 属性 | 值 |
|---|---|
| 参数组: | VirtualHubParameters Arguments |
虚拟 WAN 的名称或 ID。
| 属性 | 值 |
|---|---|
| 参数组: | VirtualWan Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az network vhub wait
将 CLI 置于等待状态,直到满足条件。
az network vhub wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
等待在“Succeeded”中使用“provisioningState”创建。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | False |
等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
等到删除为止。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | False |
等待资源存在。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | False |
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
轮询间隔(以秒为单位)。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | 30 |
虚拟中心的名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
最大等待(以秒为单位)。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | 3600 |
等到 provisioningState 更新为“Succeeded”。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | False |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |