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

az network manager connect-config

参考

注意

此参考是 Azure CLI（版本 2.57.0 或更高版本）的虚拟网络管理器扩展的一部分。该扩展将在首次运行 az network manager connect-config 命令时自动安装。详细了解扩展。

使用网络管理连接配置。

命令

名称	说明	类型	Status
az network manager connect-config create	创建新的网络管理器连接配置。	扩展	GA
az network manager connect-config delete	删除由资源组、网络管理器名称和连接配置名称指定的网络管理器连接配置。	扩展	GA
az network manager connect-config list	列出指定网络管理器中的所有网络管理器连接配置。	扩展	GA
az network manager connect-config show	获取由资源组、网络管理器名称和连接配置名称指定的网络连接配置。	扩展	GA
az network manager connect-config update	更新新的网络管理器连接配置。	扩展	GA
az network manager connect-config wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az network manager connect-config create

创建新的网络管理器连接配置。

az network manager connect-config create --configuration-name
                                         --name
                                         --resource-group
                                         [--applies-to-group]
                                         [--connectivity-topology {HubAndSpoke, Mesh}]
                                         [--delete-existing-peering {False, True}]
                                         [--description]
                                         [--hub]
                                         [--is-global {False, True}]

示例

创建/更新 Azure 虚拟网络 Manager 连接配置

az network manager connect-config create --configuration-name "myTestConnectivityConfig" --description "Sample Configuration" --applies-to-group group-connectivity="None" is-global=false network-group-id="/subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkManagerGroups/group1" use-hub-gateway=true --connectivity-topology "HubAndSpoke" --delete-existing-peering true --hub resource-id="subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Micr osoft.Network/virtualNetworks/myTestConnectivityConfig" resource- type="Microsoft.Network/virtualNetworks" --is-global true --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

必需参数

--configuration-name

网络管理器连接配置的名称。

--name --network-manager-name -n

网络管理器的名称。

--resource-group -g

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

可选参数

--applies-to-group --applies-to-groups

配置支持速记语法、json-file 和 yaml-file 的组。请尝试“？？” 以显示更多内容。单一标志： --applies-to-group。

--connectivity-topology

连接拓扑类型。

接受的值: HubAndSpoke, Mesh

--delete-existing-peering

如果需要删除当前的现有对等互连，则标记。

接受的值: False, True

--description

连接配置的说明。

--hub --hubs

hubItems 支持速记语法、json-file 和 yaml-file 列表。请尝试“？？” 以显示更多内容。单一标志： --hub。

--is-global

如果支持全局网格，则标记。

接受的值: False, True

全局参数

--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 manager connect-config delete

删除由资源组、网络管理器名称和连接配置名称指定的网络管理器连接配置。

az network manager connect-config delete [--configuration-name]
                                         [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

示例

删除 Azure 虚拟网络 Manager 连接配置

az network manager connect-config delete --configuration-name "myTestConnectivityConfig" --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

可选参数

--configuration-name

网络管理器连接配置的名称。

--force

即使资源是已部署配置的一部分，也会删除该资源。如果已部署配置，则服务将在删除之前在后台执行清理部署。

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

--ids

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

--name --network-manager-name -n

网络管理器的名称。

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

--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 manager connect-config list

列出指定网络管理器中的所有网络管理器连接配置。

az network manager connect-config list --name
                                       --resource-group
                                       [--max-items]
                                       [--next-token]
                                       [--skip-token]
                                       [--top]

示例

列出 Azure 虚拟网络 Manager Connecitivity 配置

az network manager connect-config list --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

必需参数

--name --network-manager-name -n

网络管理器的名称。

--resource-group -g

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

可选参数

--max-items

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

--next-token

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

--skip-token

仅当以前的操作返回了部分结果时，才使用 SkipToken。如果以前的响应包含 nextLink 元素，则 nextLink 元素的值将包含一个 skipToken 参数，该参数指定用于后续调用的起点。

--top

可选查询参数，它指定要由服务器返回的最大记录数。

全局参数

--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 manager connect-config show

获取由资源组、网络管理器名称和连接配置名称指定的网络连接配置。

az network manager connect-config show [--configuration-name]
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

示例

获取 Azure 虚拟网络 Manager 连接配置

az network manager connect-config show --configuration-name "myTestConnectivityConfig" --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

可选参数

--configuration-name

网络管理器连接配置的名称。

--ids

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

--name --network-manager-name -n

网络管理器的名称。

--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 manager connect-config update

更新新的网络管理器连接配置。

az network manager connect-config update [--add]
                                         [--applies-to-group]
                                         [--configuration-name]
                                         [--connectivity-topology {HubAndSpoke, Mesh}]
                                         [--delete-existing-peering {False, True}]
                                         [--description]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--hub]
                                         [--ids]
                                         [--is-global {False, True}]
                                         [--name]
                                         [--remove]
                                         [--resource-group]
                                         [--set]
                                         [--subscription]

可选参数

--add

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

--applies-to-group --applies-to-groups

配置支持速记语法、json-file 和 yaml-file 的组。请尝试“？？” 以显示更多内容。单一标志： --applies-to-group。

--configuration-name

网络管理器连接配置的名称。

--connectivity-topology

连接拓扑类型。

接受的值: HubAndSpoke, Mesh

--delete-existing-peering

如果需要删除当前的现有对等互连，则标记。

接受的值: False, True

--description

连接配置的说明。

--force-string

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

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

--hub --hubs

hubItems 支持速记语法、json-file 和 yaml-file 列表。请尝试“？？” 以显示更多内容。单一标志： --hub。

--ids

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

--is-global

如果支持全局网格，则标记。

接受的值: False, True

--name --network-manager-name -n

网络管理器的名称。

--remove

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

--resource-group -g

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

--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 manager connect-config wait

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

az network manager connect-config wait [--configuration-name]
                                       [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

可选参数

--configuration-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 --network-manager-name -n

网络管理器的名称。

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

通过

az network manager connect-config

命令

az network manager connect-config create

示例

必需参数

可选参数

az network manager connect-config delete

示例

可选参数

az network manager connect-config list

示例

必需参数

可选参数

az network manager connect-config show

示例

可选参数

az network manager connect-config update

可选参数

az network manager connect-config wait

可选参数

其他资源