通过

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

az networkfabric externalnetwork

  • 参考

注意

此参考是 Azure CLI（版本 2.49.0 或更高版本）的 managednetworkfabric 扩展的一部分。 该扩展将在首次运行 az networkfabric externalnetwork 命令时自动安装。 详细了解扩展。

管理外部网络资源。

命令

名称 说明 类型 Status
az networkfabric externalnetwork create

创建外部网络资源。

 扩展 GA
az networkfabric externalnetwork delete

删除外部网络资源。

 扩展 GA
az networkfabric externalnetwork list

列出提供资源组中的所有外部网络。

 扩展 GA
az networkfabric externalnetwork show

显示提供的外部网络资源的详细信息。

 扩展 GA
az networkfabric externalnetwork update

更新外部网络资源。

 扩展 GA
az networkfabric externalnetwork wait

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

 扩展 GA

az networkfabric externalnetwork create

创建外部网络资源。

az networkfabric externalnetwork create --l3-isolation-domain-name
                                        --peering-option {OptionA, OptionB}
                                        --resource-group
                                        --resource-name
                                        [--annotation]
                                        [--export-route-policy]
                                        [--export-route-policy-id]
                                        [--import-route-policy]
                                        [--import-route-policy-id]
                                        [--nni-id]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--option-a-properties]
                                        [--option-b-properties]

示例

使用选项 B 属性创建外部网络

az networkfabric externalnetwork create --resource-group "example-rg" --l3domain "example-l3domain" --resource-name "example-externalNetwork" --peering-option "OptionB" --option-b-properties "{routeTargets:{exportIpv4RouteTargets:['65046:10039'],exportIpv6RouteTargets:['65046:10039'],importIpv4RouteTargets:['65046:10039'],importIpv6RouteTargets:['65046:10039']}}" --import-route-policy "{importIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',importIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}" --export-route-policy "{exportIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',exportIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}"

使用选项 A 属性创建外部网络

az networkfabric externalnetwork create --resource-group "example-rg" --l3domain "example-l3domain" --resource-name "example-externalNetwork" --peering-option "OptionA" --option-a-properties "{peerASN:65234,vlanId:501,mtu:1500,primaryIpv4Prefix:'172.23.1.0/31',secondaryIpv4Prefix:'172.23.1.2/31',bfdConfiguration:{multiplier:5,intervalInMilliSeconds:300}}" --import-route-policy "{importIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',importIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}" --export-route-policy "{exportIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',exportIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}"

可以使用速记语法“？？”查看特定父级下子参数的帮助文本。 有关速记语法的详细信息，请参阅 https://github.com/Azure/azure-cli/tree/dev/doc/shorthand_syntax.md 。

az networkfabric externalnetwork create --option-a-properties "??"

必需参数

--l3-isolation-domain-name --l3domain

L3 隔离域的名称。

--peering-option

对等互连选项列表。

接受的值: OptionA, OptionB
--resource-group -g

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

--resource-name

外部网络的名称。

可选参数

--annotation

基础资源的说明。

--export-route-policy

导出路由策略（IPv4 或 IPv6）。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--export-route-policy-id

RoutePolicy 的 ARM 资源 ID。 这用于向后兼容性。

--import-route-policy

导入路由策略（IPv4 或 IPv6）。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--import-route-policy-id

RoutePolicy 的 ARM 资源 ID。 这用于向后兼容性。

--nni-id

ExternalNetwork 资源的 networkToNetworkInterconnectId 的 ARM 资源 ID。

--no-wait

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

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

选项 A 属性对象。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--option-b-properties

选项 B 属性对象。 支持速记语法、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 networkfabric externalnetwork delete

删除外部网络资源。

az networkfabric externalnetwork delete [--ids]
                                        [--l3-isolation-domain-name]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--resource-name]
                                        [--subscription]

示例

删除外部网络

az networkfabric externalnetwork delete --resource-group "example-rg" --l3domain "example-l3domain" --resource-name "example-externalnetwork"

可选参数

--ids

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

--l3-isolation-domain-name --l3domain

L3 隔离域的名称。

--no-wait

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

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

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

--resource-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 networkfabric externalnetwork list

列出提供资源组中的所有外部网络。

az networkfabric externalnetwork list --l3-isolation-domain-name
                                      --resource-group

示例

列出资源组的外部网络

az networkfabric externalnetwork list --resource-group "example-rg" --l3domain "example-l3domain"

必需参数

--l3-isolation-domain-name --l3domain

L3 隔离域的名称。

--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 networkfabric externalnetwork show

显示提供的外部网络资源的详细信息。

az networkfabric externalnetwork show [--ids]
                                      [--l3-isolation-domain-name]
                                      [--resource-group]
                                      [--resource-name]
                                      [--subscription]

示例

显示外部网络

az networkfabric externalnetwork show --resource-group "example-rg" --l3domain "example-l3domain" --resource-name "example-externalnetwork"

可选参数

--ids

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

--l3-isolation-domain-name --l3domain

L3 隔离域的名称。

--resource-group -g

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

--resource-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 networkfabric externalnetwork update

更新外部网络资源。

az networkfabric externalnetwork update [--annotation]
                                        [--export-route-policy]
                                        [--export-route-policy-id]
                                        [--ids]
                                        [--import-route-policy]
                                        [--import-route-policy-id]
                                        [--l3-isolation-domain-name]
                                        [--nni-id]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--option-a-properties]
                                        [--option-b-properties]
                                        [--peering-option {OptionA, OptionB}]
                                        [--resource-group]
                                        [--resource-name]
                                        [--subscription]

示例

使用选项 B 属性更新外部网络

az networkfabric externalnetwork update --resource-group "example-rg" --l3domain "example-l3domain" --resource-name "example-externalNetwork" --peering-option "OptionB" --option-b-properties "{routeTargets:{exportIpv4RouteTargets:['65046:10039'],exportIpv6RouteTargets:['65046:10039'],importIpv4RouteTargets:['65046:10039'],importIpv6RouteTargets:['65046:10039']}}" --import-route-policy "{importIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',importIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}" --export-route-policy "{exportIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',exportIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}"

使用选项 A 属性更新外部网络

az networkfabric externalnetwork update --resource-group "example-rg" --l3domain "example-l3domain" --resource-name "example-externalNetwork" --peering-option "OptionA" --nni-id "/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourcegroups/example-rg/providers/microsoft.managednetworkfabric/networkfabrics/example-fabric/networkToNetworkInterconnects/example-nni" --option-a-properties "{peerASN:65234,vlanId:501,mtu:1500,primaryIpv4Prefix:'172.23.1.0/31',secondaryIpv4Prefix:'172.23.1.2/31',bfdConfiguration:{multiplier:5,intervalInMilliSeconds:300}}" --import-route-policy "{importIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',importIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}" --export-route-policy "{exportIpv4RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy',exportIpv6RoutePolicyId:'/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxx/resourceGroups/example-rg/providers/microsoft.managednetworkfabric/routePolicies/example-routepolicy'}"

可以使用速记语法“？？”查看特定父级下子参数的帮助文本。 有关速记语法的详细信息，请参阅 https://github.com/Azure/azure-cli/tree/dev/doc/shorthand_syntax.md 。

az networkfabric externalnetwork update --option-a-properties "??"

可选参数

--annotation

基础资源的说明。

--export-route-policy

导出路由策略（IPv4 或 IPv6）。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--export-route-policy-id

RoutePolicy 的 ARM 资源 ID。 这用于向后兼容性。

--ids

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

--import-route-policy

导入路由策略（IPv4 或 IPv6）。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--import-route-policy-id

RoutePolicy 的 ARM 资源 ID。 这用于向后兼容性。

--l3-isolation-domain-name --l3domain

L3 隔离域的名称。

--nni-id

ExternalNetwork 资源的 networkToNetworkInterconnectId 的 ARM 资源 ID。

--no-wait

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

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

选项 A 属性对象。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--option-b-properties

选项 B 属性对象。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--peering-option

对等互连选项列表。

接受的值: OptionA, OptionB
--resource-group -g

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

--resource-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 networkfabric externalnetwork wait

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

az networkfabric externalnetwork wait [--created]
                                      [--custom]
                                      [--deleted]
                                      [--exists]
                                      [--ids]
                                      [--interval]
                                      [--l3-isolation-domain-name]
                                      [--resource-group]
                                      [--resource-name]
                                      [--subscription]
                                      [--timeout]
                                      [--updated]

可选参数

--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
--l3-isolation-domain-name --l3domain

L3 隔离域的名称。

--resource-group -g

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

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