az nginx deployment api-key

参考

注释

此参考是 Azure CLI 的 nginx 扩展（版本 2.68.0 或更高版本）的一部分。该扩展将在首次运行 az nginx deployment api-key 命令时自动安装。了解更多关于扩展的相关信息。

管理 Nginxaas 部署 API 密钥。

命令

名称	说明	类型	Status
az nginx deployment api-key create	为 Nginx 部署创建 API 密钥，以便访问数据平面 API 终结点。	扩展	GA
az nginx deployment api-key delete	删除 Nginx 部署的 API 密钥。	扩展	GA
az nginx deployment api-key list	列出给定 Nginx 部署的所有 API 密钥。	扩展	GA
az nginx deployment api-key show	获取给定 Nginx 部署的指定 API 密钥。	扩展	GA
az nginx deployment api-key update	更新 Nginx 部署的 API 密钥，以便访问数据平面 API 终结点。	扩展	GA

az nginx deployment api-key create

为 Nginx 部署创建 API 密钥，以便访问数据平面 API 终结点。

az nginx deployment api-key create --api-key-name --name
                                   --deployment-name
                                   --resource-group
                                   [--end-date-time]
                                   [--secret-text]

必需参数

--api-key-name --name -n

API 密钥的资源名称。

--deployment-name

目标 NGINX 部署的名称。

--resource-group -g

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

可选参数

--end-date-time

此数据平面 API 密钥不再有效的时间。

--secret-text

要用作数据平面 API 密钥的机密文本。这是永远无法读回的仅写属性，但前三个字符将在“hint”属性中返回。如果值为空，则从 tty 中询问该值。

全局参数

--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 nginx deployment api-key delete

删除 Nginx 部署的 API 密钥。

az nginx deployment api-key delete [--api-key-name --name]
                                   [--deployment-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

可选参数

--api-key-name --name -n

API 密钥的资源名称。

--deployment-name

目标 NGINX 部署的名称。

--ids

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

--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 nginx deployment api-key list

列出给定 Nginx 部署的所有 API 密钥。

az nginx deployment api-key list --deployment-name
                                 --resource-group
                                 [--max-items]
                                 [--next-token]

必需参数

--deployment-name

目标 NGINX 部署的名称。

--resource-group -g

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

可选参数

--max-items

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

--next-token

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

全局参数

--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 nginx deployment api-key show

获取给定 Nginx 部署的指定 API 密钥。

az nginx deployment api-key show [--api-key-name --name]
                                 [--deployment-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

可选参数

--api-key-name --name -n

API 密钥的资源名称。

--deployment-name

目标 NGINX 部署的名称。

--ids

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

--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 nginx deployment api-key update

更新 Nginx 部署的 API 密钥，以便访问数据平面 API 终结点。

az nginx deployment api-key update [--add]
                                   [--api-key-name --name]
                                   [--deployment-name]
                                   [--end-date-time]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--remove]
                                   [--resource-group]
                                   [--secret-text]
                                   [--set]
                                   [--subscription]

可选参数

--add

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

--api-key-name --name -n

API 密钥的资源名称。

--deployment-name

目标 NGINX 部署的名称。

--end-date-time

此数据平面 API 密钥不再有效的时间。

--force-string

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

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

--ids

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

--remove

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

--resource-group -g

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

--secret-text

要用作数据平面 API 密钥的机密文本。这是永远无法读回的仅写属性，但前三个字符将在“hint”属性中返回。如果值为空，则从 tty 中询问该值。

--set

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

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