通过

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

Set Secret - Set Secret

  • 参考
服务:
Key Vault
API 版本:
7.4

在指定的密钥保管库中设置机密。
SET作将机密添加到 Azure Key Vault。 如果已存在命名机密，Azure Key Vault 将创建该机密的新版本。 此作需要机密/设置权限。

PUT {vaultBaseUrl}/secrets/{secret-name}?api-version=7.4

URI 参数

名称 在 必需 类型 说明
secret-name
 path True

string

pattern: ^[0-9a-zA-Z-]+$

机密的名称。 为了运行服务，可能会全局复制你提供的值。 提供的值不应包含个人身份或敏感信息。
vaultBaseUrl
 path True

string

保管库名称，例如 https://myvault.vault.azure.net。
api-version
 query True

string

客户端 API 版本。

请求正文

名称 必需 类型 说明
value True

string

机密的值。
attributes

SecretAttributes

机密管理属性。
contentType

string

密码等机密值的类型。
tags

object

以键值对的形式的应用程序特定元数据。

响应

名称 类型 说明
200 OK

SecretBundle

包含设置机密请求结果的机密捆绑包。
Other Status Codes

KeyVaultError

Key Vault 错误响应，描述作失败的原因。

示例

SetSecret

示例请求

PUT https://myvault.vault.azure.net//secrets/crpsecret?api-version=7.4

{
  "value": "mysecretvalue"
}

示例响应

状态代码:
200 
{
  "value": "mysecretvalue",
  "id": "https://myvault.vault.azure.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441",
  "attributes": {
    "enabled": true,
    "created": 1493938459,
    "updated": 1493938459,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

定义

名称 说明
DeletionRecoveryLevel

反映当前保管库中机密当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除机密;否则，只有系统才能在保留间隔结束时清除机密。
Error

密钥保管库服务器错误。
KeyVaultError

密钥保管库错误异常。
SecretAttributes

机密管理属性。
SecretBundle

由值、ID 及其属性组成的机密。
SecretSetParameters

机密集参数。

DeletionRecoveryLevel

枚举

反映当前保管库中机密当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除机密;否则，只有系统才能在保留间隔结束时清除机密。

值 说明
CustomizedRecoverable

表示一个保管库状态，在该状态下可以恢复删除，且无法立即和永久删除（即当 7<= SoftDeleteRetentionInDays < 90 时清除）。此级别保证在保留时间间隔内以及订阅仍可用期间已删除实体的可恢复性。
CustomizedRecoverable+ProtectedSubscription

表示不允许恢复、立即和永久删除（即清除）的保管库和订阅状态，当 7<= SoftDeleteRetentionInDays < 90 时，订阅本身将无法永久取消。 此级别保证在保留时间间隔内删除实体的可恢复性，还反映了无法取消订阅本身的事实。
CustomizedRecoverable+Purgeable

表示可恢复删除的保管库状态，同时允许立即和永久删除（即在 7<= SoftDeleteRetentionInDays < 90 时清除）。 此级别保证在保留间隔期间删除的实体的可恢复性，除非请求清除作或取消订阅。
Purgeable

表示删除作不可逆的保管库状态，而无法进行恢复。 此级别对应于不可用于删除作的保护;在接受实体级别或更高级别的删除作（保管库、资源组、订阅等）时，数据将不可挽回地丢失。
Recoverable

表示可恢复删除的保管库状态，而无法立即和永久删除（即清除）。 此级别保证在保留间隔（90 天）期间删除的实体的可恢复性，同时订阅仍可用。 系统在 90 天后永久删除它（如果未恢复）
Recoverable+ProtectedSubscription

表示不允许在保留间隔（90 天）、立即和永久删除（即清除）内恢复删除的保管库和订阅状态，并且不允许永久取消订阅本身。 系统在 90 天后永久删除它（如果未恢复）
Recoverable+Purgeable

表示可恢复删除的保管库状态，同时允许立即和永久删除（即清除）。 此级别保证在保留间隔（90 天）期间删除的实体的可恢复性，除非请求清除作或取消订阅。 系统在 90 天后永久删除它（如果未恢复）

Error

Object

密钥保管库服务器错误。

名称 类型 说明
code

string

错误代码。
innererror

Error

密钥保管库服务器错误。
message

string

错误消息。

KeyVaultError

Object

密钥保管库错误异常。

名称 类型 说明
error

Error

密钥保管库服务器错误。

SecretAttributes

Object

机密管理属性。

名称 类型 说明
created

integer (unixtime)

以 UTC 为单位的创建时间。
enabled

boolean

确定是否启用对象。
exp

integer (unixtime)

UTC 格式的到期日期。
nbf

integer (unixtime)

不早于 UTC 的日期。
recoverableDays

integer (int32)

softDelete 数据保留天数。 启用 softDelete 时，值应 >=7，<=90;否则为 0。
recoveryLevel

DeletionRecoveryLevel

反映当前保管库中机密当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除机密;否则，只有系统才能在保留间隔结束时清除机密。
updated

integer (unixtime)

UTC 的上次更新时间。

SecretBundle

Object

由值、ID 及其属性组成的机密。

名称 类型 说明
attributes

SecretAttributes

机密管理属性。
contentType

string

机密的内容类型。
id

string

机密 ID。
kid

string

如果这是支持 KV 证书的机密，则此字段指定支持 KV 证书的相应密钥。
managed

boolean

如此 如果机密的生存期由密钥保管库管理。 如果这是支持证书的机密，则托管将为 true。
tags

object

以键值对的形式的应用程序特定元数据。
value

string

机密值。

SecretSetParameters

Object

机密集参数。

名称 类型 说明
attributes

SecretAttributes

机密管理属性。
contentType

string

密码等机密值的类型。
tags

object

以键值对的形式的应用程序特定元数据。
value

string

机密的值。