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

Update Secret - Update Secret

  • 参考
Service:
Key Vault
API Version:
7.4

汇报与给定密钥保管库中的指定机密关联的属性。
UPDATE 操作将会更改现有存储机密的指定属性。 未在请求中指定的属性将保留不变。 不能更改机密本身的值。 该操作需要 secrets/set 权限。

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

URI 参数

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

string

机密的名称。
secret-version
 path True

string

机密的版本。
vaultBaseUrl
 path True

string

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

string

客户端 API 版本。

请求正文

名称 类型 说明
attributes

SecretAttributes

机密管理属性。
contentType

string

机密值的类型，例如密码。
tags

object

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

响应

名称 类型 说明
200 OK

SecretBundle

更新的机密。
Other Status Codes

KeyVaultError

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

示例

UpdateSecret

Sample Request

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

{
  "tags": {
    "mytag": "myvalue"
  },
  "contentType": "myContentType",
  "attributes": {
    "enabled": true
  }
}

Sample Response

Status code:
200 
{
  "id": "https://myvault.vault.azure.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441",
  "contentType": "myContentType",
  "attributes": {
    "enabled": true,
    "created": 1493938459,
    "updated": 1493938459,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "mytag": "myvalue"
  }
}

定义

名称 说明
DeletionRecoveryLevel

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

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

密钥保管库错误异常。
SecretAttributes

机密管理属性。
SecretBundle

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

机密更新参数。

DeletionRecoveryLevel

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

名称 类型 说明
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

密钥保管库服务器错误。

名称 类型 说明
code

string

错误代码。
innererror

Error

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

string

错误消息。

KeyVaultError

密钥保管库错误异常。

名称 类型 说明
error

Error

密钥保管库服务器错误。

SecretAttributes

机密管理属性。

名称 类型 说明
created

integer

创建时间（UTC）。
enabled

boolean

确定是否启用对象。
exp

integer

到期日期（UTC）。
nbf

integer

不早于 UTC 日期。
recoverableDays

integer

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

DeletionRecoveryLevel

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

integer

上次更新时间（UTC）。

SecretBundle

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

名称 类型 说明
attributes

SecretAttributes

机密管理属性。
contentType

string

机密的内容类型。
id

string

机密 ID。
kid

string

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

boolean

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

object

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

string

机密值。

SecretUpdateParameters

机密更新参数。

名称 类型 说明
attributes

SecretAttributes

机密管理属性。
contentType

string

机密值的类型，例如密码。
tags

object

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