Update Secret - Update Secret

Ссылка

Служба:: Key Vault

Версия API:: 7.4

Обновления атрибуты, связанные с указанным секретом в данном хранилище ключей.
Операция UPDATE изменяет указанные атрибуты существующего хранимого секрета. Атрибуты, которые не указаны в запросе, остаются без изменений. Значение самого секрета не может быть изменено. Для выполнения этой операции требуется разрешение на секреты или набор.

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	Key Vault ответ об ошибке, описывающий причину сбоя операции.

Примеры

UpdateSecret

Образец запроса

HTTP

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

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

Пример ответа

Код состояния:: 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	Секрет, состоящий из значения, идентификатора и его атрибутов.
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 data retention days. Значение должно быть >равно =7 и <=90, если softDelete включено, в противном случае — 0.
recoveryLevel	DeletionRecoveryLevel	Отражает уровень восстановления удаления, действующий в настоящее время для секретов в текущем хранилище. Если он содержит Purgeable, секрет может быть окончательно удален привилегированным пользователем; В противном случае только система может очистить секрет в конце интервала хранения.
updated	integer	Время последнего обновления в формате UTC.

SecretBundle

Секрет, состоящий из значения, идентификатора и его атрибутов.

Имя	Тип	Описание
attributes	SecretAttributes	Атрибуты управления секретами.
contentType	string	Тип содержимого секрета.
id	string	Идентификатор секрета.
kid	string	Если это секрет, который поддерживает сертификат KV, то в этом поле указывается соответствующий ключ, который поддерживает сертификат KV.
managed	boolean	Значение true, если время существования секрета управляется хранилищем ключей. Если это секрет, который поддерживает сертификат, то параметр managed будет иметь значение true.
tags	object	Метаданные конкретного приложения в виде пар «ключ — значение».
value	string	Значение секрета.

SecretUpdateParameters

Параметры обновления секрета.

Имя	Тип	Описание
attributes	SecretAttributes	Атрибуты управления секретами.
contentType	string	Тип значения секрета, например пароль.
tags	object	Метаданные конкретного приложения в виде пар «ключ — значение».

Поделиться через