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

az apim nv

参考

管理 Azure API 管理命名值。

命令

名称	说明	类型	Status
az apim nv create	创建API 管理命名值。	核心	GA
az apim nv delete	删除API 管理命名值。	核心	GA
az apim nv list	列出API 管理命名值。	核心	GA
az apim nv show	显示API 管理命名值的详细信息。	核心	GA
az apim nv show-secret	获取API 管理命名值的机密。	核心	GA
az apim nv update	更新API 管理命名值。	核心	GA
az apim nv wait	将 CLI 置于等待状态，直到满足 apim 命名值的条件。	核心	GA

az apim nv create

编辑

创建API 管理命名值。

az apim nv create --display-name
                  --named-value-id
                  --resource-group
                  --service-name
                  [--if-match]
                  [--no-wait]
                  [--secret {false, true}]
                  [--tags]
                  [--value]

示例

创建命名值。

az apim nv create --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --display-name 'My Named Value' --value 'foo'

必需参数

--display-name

命名值的显示名称。

--named-value-id

要创建命名值的唯一名称。

在当前API 管理服务实例中必须是唯一的。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

--if-match

实体的 ETag。

--no-wait

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

默认值: False

--secret

确定值是否为密钥以及是否应加密。默认值为 false。

接受的值: false, true

默认值: False

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--value

命名值的值。

全局参数

--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 apim nv delete

编辑

删除API 管理命名值。

az apim nv delete --named-value-id
                  --resource-group
                  --service-name
                  [--yes]

必需参数

--named-value-id

NamedValue 的标识符。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

--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 apim nv list

编辑

列出API 管理命名值。

az apim nv list --resource-group
                --service-name

必需参数

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

全局参数

--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 apim nv show

编辑

显示API 管理命名值的详细信息。

az apim nv show --named-value-id
                --resource-group
                --service-name

必需参数

--named-value-id

NamedValue 的标识符。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

全局参数

--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 apim nv show-secret

编辑

获取API 管理命名值的机密。

az apim nv show-secret --named-value-id
                       --resource-group
                       --service-name

必需参数

--named-value-id

NamedValue 的标识符。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

全局参数

--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 apim nv update

编辑

更新API 管理命名值。

az apim nv update --named-value-id
                  --resource-group
                  --service-name
                  [--add]
                  [--force-string]
                  [--if-match]
                  [--remove]
                  [--secret {false, true}]
                  [--set]
                  [--tags]
                  [--value]

示例

创建基本 API。

az apim nv update --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --value foo

必需参数

--named-value-id

要创建的 API 的唯一名称。

在当前API 管理服务实例中必须是唯一的。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

--add

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

默认值: []

--force-string

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

默认值: False

--if-match

实体的 ETag。

--remove

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

默认值: []

--secret

确定值是否为密钥以及是否应加密。默认值为 false。

接受的值: false, true

--set

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

默认值: []

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--value

命名值的值。

全局参数

--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 apim nv wait

编辑

将 CLI 置于等待状态，直到满足 apim 命名值的条件。

az apim nv wait --named-value-id
                --resource-group
                --service-name
                [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--interval]
                [--timeout]
                [--updated]

示例

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

az apim nv wait --created --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --resource-group MyResourceGroup

必需参数

--named-value-id

NamedValue 的标识符。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

--created

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

默认值: False

--custom

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

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--interval

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

默认值: 30

--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 apim nv

命令

az apim nv create

示例

必需参数

可选参数

az apim nv delete

必需参数

可选参数

az apim nv list

必需参数

az apim nv show

必需参数

az apim nv show-secret

必需参数

az apim nv update

示例

必需参数

可选参数

az apim nv wait

示例

必需参数

可选参数

其他资源