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

az keyvault secret

管理机密。

命令

名称	说明	类型	Status
az keyvault secret backup	备份指定的机密。	核心	GA
az keyvault secret delete	删除机密的所有版本。	核心	已放弃
az keyvault secret download	从 KeyVault 下载机密。	核心	GA
az keyvault secret list	列出指定密钥保管库中的机密。	核心	GA
az keyvault secret list-deleted	列出指定保管库的已删除机密。	核心	GA
az keyvault secret list-versions	列出指定机密的所有版本。	核心	GA
az keyvault secret purge	永久删除指定的机密。	核心	GA
az keyvault secret recover	将已删除的机密恢复到最新版本。	核心	GA
az keyvault secret restore	将备份的机密还原到保管库。	核心	GA
az keyvault secret set	创建机密（如果不存在）或更新 KeyVault 中的机密。	核心	GA
az keyvault secret set-attributes	汇报与给定密钥保管库中的指定机密关联的属性。	核心	GA
az keyvault secret show	从给定密钥保管库获取指定的机密。	核心	GA
az keyvault secret show-deleted	获取指定的已删除机密。	核心	GA

az keyvault secret backup

备份指定的机密。

请求将指定机密的备份下载到客户端。 将下载所有版本的机密。 此操作需要机密/备份权限。

az keyvault secret backup --file
                          [--id]
                          [--name]
                          [--vault-name]

必需参数

--file -f

要接收机密内容的文件。

可选参数

--id

机密的 ID。 如果指定了所有其他“Id”参数，则应省略。

--name -n

机密的名称。 如果未指定 --id，则为必需。

--vault-name

密钥库的名称。 如果未指定 --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 keyvault secret delete

已放弃

警告！ 如果对此密钥保管库启用了软删除保护，此机密将移动到软删除状态。 在从软删除状态中清除机密之前，将无法在此密钥保管库中创建具有相同名称的机密。 有关其他指南，请参阅以下文档。 https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview

删除机密的所有版本。

需要机密/删除权限。 当此方法返回密钥库已开始删除机密时。 在启用了软删除的保管库中，删除可能需要几秒钟的时间。 因此，此方法返回一个轮询程序，使你能够等待删除完成。

az keyvault secret delete [--id]
                          [--name]
                          [--vault-name]

可选参数

--id

机密的 ID。 如果指定了所有其他“Id”参数，则应省略。

--name -n

机密的名称。 如果未指定 --id，则为必需。

--vault-name

密钥库的名称。 如果未指定 --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 keyvault secret download

从 KeyVault 下载机密。

az keyvault secret download --file
                            [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                            [--id]
                            [--name]
                            [--vault-name]
                            [--version]

必需参数

--file -f

要接收机密内容的文件。

可选参数

--encoding -e

机密的编码。 默认情况下，将在机密上查找“文件编码”标记。 否则将假定为“utf-8”。

接受的值: ascii, base64, hex, utf-16be, utf-16le, utf-8

--id

机密的 ID。 如果指定了所有其他“Id”参数，则应省略。

--name -n

机密的名称。 如果未指定 --id，则为必需。

--vault-name

密钥库的名称。 如果未指定 --id，则为必需。

--version -v

机密版本。 如果省略，请使用最新版本。

全局参数

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

列出指定密钥保管库中的机密。

获取机密操作适用于整个保管库。 但是，响应中仅提供基本机密标识符及其属性。 响应中未列出单个机密版本。 此操作需要机密/列表权限。

az keyvault secret list [--id]
                        [--include-managed {false, true}]
                        [--maxresults]
                        [--vault-name]

可选参数

--id

保管库的完整 URI。 如果指定了所有其他“Id”参数，则应省略。

--include-managed

包括托管机密。 默认值：false。

接受的值: false, true

默认值: False

--maxresults

在页面中返回的最大结果数。 如果未指定，服务将返回最多 25 个结果。

--vault-name

密钥库的名称。 如果未指定 --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 keyvault secret list-deleted

列出指定保管库的已删除机密。

Get Deleted Secrets 操作返回为已启用软删除的保管库删除的机密。 此操作需要机密/列表权限。

az keyvault secret list-deleted [--id]
                                [--maxresults]
                                [--vault-name]

可选参数

--id

保管库的完整 URI。 如果指定了所有其他“Id”参数，则应省略。

--maxresults

在页面中返回的最大结果数。 如果未指定，服务将返回最多 25 个结果。

--vault-name

密钥库的名称。 如果未指定 --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 keyvault secret list-versions

列出指定机密的所有版本。

响应中提供了完整的机密标识符和属性。 不会为机密返回任何值。 此操作需要机密/列表权限。

az keyvault secret list-versions [--id]
                                 [--maxresults]
                                 [--name]
                                 [--vault-name]

可选参数

--id

机密的 ID。 如果指定了所有其他“Id”参数，则应省略。

--maxresults

在页面中返回的最大结果数。 如果未指定，服务将返回最多 25 个结果。

--name -n

机密的名称。 如果未指定 --id，则为必需。

--vault-name

密钥库的名称。 如果未指定 --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 keyvault secret purge

永久删除指定的机密。

清除删除的机密操作会永久删除机密，且无法恢复。 只能在启用软删除的保管库上启用此操作。 此操作需要机密/清除权限。

az keyvault secret purge [--id]
                         [--name]
                         [--vault-name]

可选参数

--id

机密的恢复 ID。 如果指定了所有其他“Id”参数，则应省略。

--name -n

机密的名称。 如果未指定 --id，则为必需。

--vault-name

保管库的名称。 如果未指定 --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 keyvault secret recover

将已删除的机密恢复到最新版本。

恢复指定保管库中已删除的机密。 此操作只能在启用软删除的保管库上执行。 此操作需要机密/恢复权限。

az keyvault secret recover [--id]
                           [--name]
                           [--vault-name]

可选参数

--id

机密的恢复 ID。 如果指定了所有其他“Id”参数，则应省略。

--name -n

机密的名称。 如果未指定 --id，则为必需。

--vault-name

保管库的名称。 如果未指定 --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 keyvault secret restore

将备份的机密还原到保管库。

将备份的机密及其所有版本还原到保管库。 此操作需要机密/还原权限。

az keyvault secret restore --file
                           --vault-name

必需参数

--file -f

要接收机密内容的文件。

--vault-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 keyvault secret set

创建机密（如果不存在）或更新 KeyVault 中的机密。

az keyvault secret set --name
                       --vault-name
                       [--content-type]
                       [--disabled {false, true}]
                       [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                       [--expires]
                       [--file]
                       [--not-before]
                       [--tags]
                       [--value]

示例

创建机密（如果不存在）或更新 KeyVault 中的机密。

az keyvault secret set --name MySecretName --vault-name MyKeyVault --value MyVault

创建机密（如果不存在）或通过文件更新 KeyVault 中的机密。

az keyvault secret set --name MySecretName --vault-name MyKeyVault --file /path/to/file --encoding MyEncoding

必需参数

--name -n

机密的名称。

--vault-name

保管库的名称。

可选参数

--content-type --description

机密内容的说明（例如密码、连接字符串等）。

--disabled

创建处于禁用状态的机密。

接受的值: false, true

--encoding -e

源文件编码。 该值保存为标记（file-encoding=<val>），并在下载过程中用于自动对生成的文件进行编码。

接受的值: ascii, base64, hex, utf-16be, utf-16le, utf-8

默认值: utf-8

--expires

到期 UTC 日期时间（Y-m-d'T'H：M：S'Z'）。

--file -f

机密的源文件。 与“--encoding”结合使用。

--not-before

在提供的 UTC 日期时间（Y-m-d'T'H：M：S'Z'）之前无法使用机密。

--tags

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

--value

纯文本机密值。 不能与“--file”或“--encoding”一起使用。

全局参数

--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 keyvault secret set-attributes

汇报与给定密钥保管库中的指定机密关联的属性。

UPDATE 操作更改现有存储机密的指定属性。 未在请求中指定的属性保持不变。 无法更改机密本身的值。 该操作需要 secrets/set 权限。

az keyvault secret set-attributes [--content-type]
                                  [--enabled {false, true}]
                                  [--expires]
                                  [--id]
                                  [--name]
                                  [--not-before]
                                  [--tags]
                                  [--vault-name]
                                  [--version]

可选参数

--content-type

密码等机密值的类型。

--enabled

启用机密。

接受的值: false, true

--expires

到期 UTC 日期时间（Y-m-d'T'H：M：S'Z'）。

--id

机密的 ID。 如果指定了所有其他“Id”参数，则应省略。

--name -n

机密的名称。 如果未指定 --id，则为必需。

--not-before

在提供的 UTC 日期时间（Y-m-d'T'H：M：S'Z'）之前无法使用机密。

--tags

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

--vault-name

密钥库的名称。 如果未指定 --id，则为必需。

--version -v

机密版本。 如果省略，请使用最新版本。

全局参数

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

从给定密钥保管库获取指定的机密。

GET 操作适用于 Azure 密钥库中存储的任何机密。 此操作需要机密/获取权限。

az keyvault secret show [--id]
                        [--name]
                        [--vault-name]
                        [--version]

可选参数

--id

机密的 ID。 如果指定了所有其他“Id”参数，则应省略。

--name -n

机密的名称。 如果未指定 --id，则为必需。

--vault-name

密钥库的名称。 如果未指定 --id，则为必需。

--version -v

机密版本。 如果省略，请使用最新版本。

全局参数

--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 keyvault secret show-deleted

获取指定的已删除机密。

Get Deleted Secret 操作返回指定的已删除机密及其属性。 此操作需要机密/获取权限。

az keyvault secret show-deleted [--id]
                                [--name]
                                [--vault-name]

可选参数

--id

机密的恢复 ID。 如果指定了所有其他“Id”参数，则应省略。

--name -n

机密的名称。 如果未指定 --id，则为必需。

--vault-name

保管库的名称。 如果未指定 --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 获取完整的调试日志。