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

az network custom-ip prefix

管理自定义 IP 前缀资源。

命令

名称 说明 类型 Status
az network custom-ip prefix create

创建自定义 IP 前缀资源。

核心 GA
az network custom-ip prefix delete

删除自定义 IP 前缀资源。

核心 GA
az network custom-ip prefix list

列出自定义 IP 前缀资源。

核心 GA
az network custom-ip prefix show

获取自定义 IP 前缀资源的详细信息。

核心 GA
az network custom-ip prefix update

更新自定义 IP 前缀资源。

核心 GA
az network custom-ip prefix wait

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

核心 GA

az network custom-ip prefix create

创建自定义 IP 前缀资源。

az network custom-ip prefix create --name
                                   --resource-group
                                   [--asn]
                                   [--authorization-message]
                                   [--cidr]
                                   [--cip-prefix-parent]
                                   [--express-route-advertise {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--geo {AFRI, APAC, AQ, EURO, GLOBAL, LATAM, ME, NAM, OCEANIA}]
                                   [--is-parent {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--location]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--prefix-type {Child, Parent, Singular}]
                                   [--signed-message]
                                   [--tags]
                                   [--zone]

示例

创建自定义 IP 前缀资源。

az network custom-ip prefix create --location westus2 --name MyCustomIpPrefix --resource-group MyResourceGroup

必需参数

--name -n

自定义 IP 前缀的名称。

--resource-group -g

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

可选参数

--asn

CIDR 广告的 ASN。 应为字符串的整数。

--authorization-message

WAN 验证的授权消息。

--cidr

CIDR 表示法中的前缀范围。 应包括起始地址和前缀长度。

--cip-prefix-parent -c

IPv6 /64 CustomIpPrefix 的父 CustomIpPrefix。

--express-route-advertise --is-advertised

是否执行快速路由播发。

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

CIDR 广告的 Geo。 应为地理代码。

接受的值: AFRI, APAC, AQ, EURO, GLOBAL, LATAM, ME, NAM, OCEANIA
--is-parent

表示正在创建该资源作为父 CustomIpPrefix。

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

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

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

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

自定义 IP 前缀的类型。 应为单一、父级或子级。

接受的值: Child, Parent, Singular
--signed-message

用于 WAN 验证的签名消息。

--tags

空格分隔标记:key[=value] [key[=value] ...]。支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--zone -z

要在其中预配资源的可用性区域的空间分隔列表。 允许的值:1、2、3。 支持速记语法、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 custom-ip prefix delete

删除自定义 IP 前缀资源。

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

示例

删除自定义 IP 前缀资源。

az network custom-ip prefix delete --name MyCustomIpPrefix --resource-group MyResourceGroup

可选参数

--ids

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

--name -n

自定义 IP 前缀的名称。

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

全局参数
--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 custom-ip prefix list

列出自定义 IP 前缀资源。

az network custom-ip prefix list [--max-items]
                                 [--next-token]
                                 [--resource-group]

示例

列出自定义 IP 前缀资源。

az network custom-ip prefix list --resource-group MyResourceGroup

可选参数

--max-items

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

--next-token

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

--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 network custom-ip prefix show

获取自定义 IP 前缀资源的详细信息。

az network custom-ip prefix show [--expand]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

示例

获取自定义 IP 前缀资源的详细信息。

az network custom-ip prefix show --name MyCustomIpPrefix --resource-group MyResourceGroup --subscription MySubscription

可选参数

--expand

展开引用的资源。 默认值为无。

--ids

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

--name -n

自定义 IP 前缀的名称。

--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 custom-ip prefix update

更新自定义 IP 前缀资源。

az network custom-ip prefix update [--add]
                                   [--authorization-message]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--name]
                                   [--no-internet-advertise {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--signed-message]
                                   [--state {commission, decommission, deprovision, provision}]
                                   [--subscription]
                                   [--tags]

示例

更新自定义 IP 前缀资源。

az network custom-ip prefix update --name MyCustomIpPrefix --resource-group MyResourceGroup --tags foo=bar

可选参数

--add

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

--authorization-message

WAN 验证的授权消息。

--force-string

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

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

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

--name -n

自定义 IP 前缀的名称。

--no-internet-advertise

是否将范围播发到 Internet。

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

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

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

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

--resource-group -g

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

--set

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

--signed-message

用于 WAN 验证的签名消息。

--state

自定义 IP 前缀的委托状态。

接受的值: commission, decommission, deprovision, provision
--subscription

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

--tags

空格分隔标记:key[=value] [key[=value] ...]。支持速记语法、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 custom-ip prefix wait

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

az network custom-ip prefix wait [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--expand]
                                 [--ids]
                                 [--interval]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--timeout]
                                 [--updated]

可选参数

--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--expand

展开引用的资源。 默认值为无。

--ids

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

--interval

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

默认值: 30
--name -n

自定义 IP 前缀的名称。

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