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

az afd secret

管理指定配置文件中的机密。

命令

名称 说明 类型 状态
az afd secret create

在指定的配置文件中创建新的机密。

核心 GA
az afd secret delete

删除配置文件中的现有机密。

核心 GA
az afd secret list

列出现有的 AzureFrontDoor 机密。

核心 GA
az afd secret show

获取配置文件中的现有机密。

核心 GA
az afd secret update

更新指定配置文件中的新机密。

核心 GA
az afd secret wait

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

核心 GA

az afd secret create

在指定的配置文件中创建新的机密。

az afd secret create --name
                     --profile-name
                     --resource-group
                     --secret-source
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--secret-version]
                     [--use-latest-version {0, 1, f, false, n, no, t, true, y, yes}]

示例

使用指定的证书版本创建机密。

az afd secret create -g group --profile-name profile --secret-name secret1 --secret-version version1 --secret-source /subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.KeyVault/vaults/vault1/secrets/cert1

必需参数

--name --secret-name -n

配置文件下机密的名称。

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--resource-group -g

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

--secret-source

Azure 密钥库证书的资源 ID,预期格式类似于/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.KeyVault/vaults/vault1/secrets/cert1。

可选参数

--no-wait

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

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

要使用的证书的版本。

--use-latest-version

是否对证书使用最新版本。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
全局参数
--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 afd secret delete

删除配置文件中的现有机密。

az afd secret delete [--ids]
                     [--name]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--profile-name]
                     [--resource-group]
                     [--subscription]
                     [--yes]

可选参数

--ids

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

--name --secret-name -n

配置文件下机密的名称。

--no-wait

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

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

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--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 afd secret list

列出现有的 AzureFrontDoor 机密。

az afd secret list --profile-name
                   --resource-group
                   [--max-items]
                   [--next-token]

必需参数

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--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 afd secret show

获取配置文件中的现有机密。

az afd secret show [--ids]
                   [--name]
                   [--profile-name]
                   [--resource-group]
                   [--subscription]

可选参数

--ids

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

--name --secret-name -n

配置文件下机密的名称。

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--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 afd secret update

更新指定配置文件中的新机密。

az afd secret update [--add]
                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                     [--ids]
                     [--name]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--profile-name]
                     [--remove]
                     [--resource-group]
                     [--secret-source]
                     [--secret-version]
                     [--set]
                     [--subscription]
                     [--use-latest-version {0, 1, f, false, n, no, t, true, y, yes}]

示例

更新指定的机密以使用证书的最新版本。

az afd secret update -g group --profile-name profile --secret-name secret1 --use-latest-version

可选参数

--add

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

--force-string

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

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

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

--name --secret-name -n

配置文件下机密的名称。

--no-wait

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

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

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--remove

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

--resource-group -g

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

--secret-source

Azure 密钥库证书的资源 ID,预期格式类似于/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.KeyVault/vaults/vault1/secrets/cert1。

--secret-version

要使用的证书的版本。

--set

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

--subscription

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

--use-latest-version

是否对证书使用最新版本。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
全局参数
--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 afd secret wait

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

az afd secret wait [--created]
                   [--custom]
                   [--deleted]
                   [--exists]
                   [--ids]
                   [--interval]
                   [--name]
                   [--profile-name]
                   [--resource-group]
                   [--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
--name --secret-name -n

配置文件下机密的名称。

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

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