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

az network vhub connection

Note

This reference is part of the virtual-wan extension for the Azure CLI (version 2.55.0 or higher). 该扩展会在首次运行 az network vhub connection 命令时自动安装。 Learn more about extensions.

管理虚拟中心 VNet 连接。

命令

名称	说明	类型	Status
az network vhub connection create	创建虚拟中心 VNet 连接。	Extension	GA
az network vhub connection delete	删除虚拟中心 VNet 连接。	Extension	GA
az network vhub connection list	列出虚拟中心 VNet 连接。	Extension	GA
az network vhub connection show	获取虚拟中心 VNet 连接的详细信息。	Extension	GA
az network vhub connection update	更新虚拟中心连接的设置。	Extension	GA
az network vhub connection wait	将 CLI 置于等待状态，直到满足条件。	Extension	GA

az network vhub connection create

创建虚拟中心 VNet 连接。

az network vhub connection create --name
                                  --remote-vnet
                                  --resource-group
                                  --vhub-name
                                  [--address-prefixes]
                                  [--associated --associated-route-table]
                                  [--associated-inbound-routemap]
                                  [--associated-outbound-routemap]
                                  [--internet-security {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--labels]
                                  [--next-hop]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--propagated --propagated-route-tables]
                                  [--remote-vnet-transit {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--route-name]
                                  [--use-hub-vnet-gateways {0, 1, f, false, n, no, t, true, y, yes}]

示例

在不配置路由的情况下创建虚拟中心 VNet 连接。

az network vhub connection create -n MyConnection --vhub-name MyHub -g MyRG --remote-vnet MyVNet

使用路由配置创建虚拟中心 VNet 连接。

az network vhub connection create -n MyConnection --vhub-name MyHub -g MyRG --remote-vnet MyVNet --associated-route-table /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable1 --propagated-route-tables /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable1 /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable2 --labels label1 label2 --route-name route1 --next-hop 70.0.0.2 --address-prefixes 10.80.0.0/16 10.90.0.0/16

必需参数

--name -n

连接的名称。

--remote-vnet

要连接到的远程 VNet 的 ID 的名称。

--resource-group -g

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

--vhub-name

虚拟中心的名称。

可选参数

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

--address-prefixes

预览

所有地址前缀的空格分隔列表。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Routing Configuration Arguments

--associated --associated-route-table

预览

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

属性	值
Parameter group:	Routing Configuration Arguments

--associated-inbound-routemap

此连接的路由配置的入站路由映射的资源 URI。

属性	值
Parameter group:	Routing Configuration Arguments

--associated-outbound-routemap

此连接的路由配置的出站路由映射的资源 URI。

属性	值
Parameter group:	Routing Configuration Arguments

--internet-security

启用 Internet 安全性并启用默认值。

属性	值
默认值:	True
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--labels

预览

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

属性	值
Parameter group:	Routing Configuration Arguments

--next-hop

预览

下一跃点的 IP 地址。

属性	值
Parameter group:	Routing Configuration Arguments

--no-wait

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

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

--propagated --propagated-route-tables

预览

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

属性	值
Parameter group:	Routing Configuration Arguments

--remote-vnet-transit

已弃用：启用中心到远程 VNet 传输。

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

--route-name

预览

在 VNet 路由中唯一的静态路由的名称。

属性	值
Parameter group:	Routing Configuration Arguments

--use-hub-vnet-gateways

已弃用：允许远程 VNet 使用中心的 VNet 网关。

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az network vhub connection delete

删除虚拟中心 VNet 连接。

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

示例

删除虚拟中心 VNet 连接。

az network vhub connection delete -n MyConnection --vhub-name MyHub -g MyRG

可选参数

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

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--name -n

连接的名称。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

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

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

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

--vhub-name

虚拟中心的名称。

属性	值
Parameter group:	Resource Id Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

属性	值
默认值:	False

az network vhub connection list

列出虚拟中心 VNet 连接。

az network vhub connection list --resource-group
                                --vhub-name
                                [--max-items]
                                [--next-token]

示例

列出给定虚拟中心中的 VNet 连接。

az network vhub connection list --vhub-name MyHub -g MyRG

必需参数

--resource-group -g

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

--vhub-name

虚拟中心的名称。

可选参数

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

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性	值
Parameter group:	Pagination Arguments

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

属性	值
Parameter group:	Pagination Arguments

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az network vhub connection show

获取虚拟中心 VNet 连接的详细信息。

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

示例

获取虚拟中心 VNet 连接的详细信息。

az network vhub connection show -n MyConnection --vhub-name MyHub -g MyRG

可选参数

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

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--name -n

连接的名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

--vhub-name

虚拟中心的名称。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

属性	值
默认值:	False

az network vhub connection update

更新虚拟中心连接的设置。

az network vhub connection update [--add]
                                  [--associated --associated-route-table]
                                  [--associated-inbound-routemap]
                                  [--associated-outbound-routemap]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--ids]
                                  [--labels]
                                  [--name]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--propagated --propagated-route-tables]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--subscription]
                                  [--vhub-name]

示例

在路由配置下为传播的路由表添加标签。

az network vhub connection update -n MyConnection --vhub-name MyHub -g MyRG --labels Newlabel1 Newlabel2

可选参数

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

--add

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

属性	值
Parameter group:	Generic Update Arguments

--associated --associated-route-table

预览

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

属性	值
Parameter group:	Routing Configuration Arguments

--associated-inbound-routemap

此连接的路由配置的入站路由映射的资源 URI。

属性	值
Parameter group:	Routing Configuration Arguments

--associated-outbound-routemap

此连接的路由配置的出站路由映射的资源 URI。

属性	值
Parameter group:	Routing Configuration Arguments

--force-string

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

属性	值
Parameter group:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--labels

预览

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

属性	值
Parameter group:	Routing Configuration Arguments

--name -n

连接的名称。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

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

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

--propagated --propagated-route-tables

预览

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

属性	值
Parameter group:	Routing Configuration Arguments

--remove

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

属性	值
Parameter group:	Generic Update Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--set

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

属性	值
Parameter group:	Generic Update Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

--vhub-name

虚拟中心的名称。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

属性	值
默认值:	False

az network vhub connection wait

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

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

可选参数

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

--created

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

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--custom

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

属性	值
Parameter group:	Wait Condition Arguments

--deleted

等到删除为止。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--exists

等待资源存在。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--interval

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

属性	值
Parameter group:	Wait Condition Arguments
默认值:	30

--name -n

连接的名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

--timeout

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

属性	值
Parameter group:	Wait Condition Arguments
默认值:	3600

--updated

等到 provisioningState 更新为“Succeeded”。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--vhub-name

虚拟中心的名称。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

属性	值
默认值:	False

通过

az network vhub connection

命令

az network vhub connection create

示例

必需参数

可选参数

az network vhub connection delete

示例

可选参数

az network vhub connection list

示例

必需参数

可选参数

az network vhub connection show

示例

可选参数

az network vhub connection update

示例

可选参数

az network vhub connection wait

可选参数

反馈