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

Set Secret - Set Secret

  • 参考
Service:
Key Vault
API Version:
7.3

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

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

URI 参数

Name In Required Type Description
secret-name
 path True
  • string

机密的名称。

Regex pattern: ^[0-9a-zA-Z-]+$
vaultBaseUrl
 path True
  • string

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

客户端 API 版本。

请求正文

Name Required Type Description
value True
  • string

机密的值。
attributes

机密管理属性。
contentType
  • string

密码等机密值的类型。
tags
  • object

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

响应

Name Type Description
200 OK

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

密钥保管库错误响应，描述操作失败的原因。

示例

SetSecret

Sample Request

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

{
  "value": "mysecretvalue"
}

Sample Response

Status code:
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

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

Name Type Description
CustomizedRecoverable
  • string

表示可恢复删除的保管库状态，而无需立即和永久删除 (，即在 7<= SoftDeleteRetentionInDays < 90) 时清除。此级别保证在保留间隔期间已删除实体的可恢复性，同时订阅仍可用。
CustomizedRecoverable+ProtectedSubscription
  • string

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

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

表示删除是不可逆操作的保管库状态，而无法恢复。 此级别对应于不可用于删除操作的保护;接受实体级别或更高 (保管库、资源组、订阅 ) 等删除操作时，数据不可恢复地丢失
Recoverable
  • string

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

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

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

Error

密钥保管库服务器错误。

Name Type Description
code
  • string

错误代码。
innererror

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

错误消息。

KeyVaultError

密钥保管库错误异常。

Name Type Description
error

密钥保管库服务器错误。

SecretAttributes

机密管理属性。

Name Type Description
created
  • integer

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

确定是否启用该对象。
exp
  • integer

UTC 格式的到期日期。
nbf
  • integer

不在 UTC 的日期之前。
recoverableDays
  • integer

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

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

上次以 UTC 为单位的更新时间。

SecretBundle

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

Name Type Description
attributes

机密管理属性。
contentType
  • string

机密的内容类型。
id
  • string

机密 ID。
kid
  • string

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

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

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

机密值。

SecretSetParameters

机密集参数。

Name Type Description
attributes

机密管理属性。
contentType
  • string

密码等机密值的类型。
tags
  • object

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

机密的值。