Get Deleted Secret - Get Deleted Secret

Ссылка

Служба:: Key Vault

Версия API:: 7.4

Возвращает указанный удаленный секрет.
Операция Получения удаленного секрета возвращает указанный удаленный секрет вместе с его атрибутами. Для этой операции требуется разрешение secrets/get.

GET {vaultBaseUrl}/deletedsecrets/{secret-name}?api-version=7.4

Параметры URI

Имя	В	Обязательно	Тип	Описание
secret-name	path	True	string	Имя секрета.
vaultBaseUrl	path	True	string	Имя хранилища, например https://myvault.vault.azure.net.
api-version	query	True	string	Версия API клиента.

Ответы

Имя	Тип	Описание
200 OK	DeletedSecretBundle	Секретный пакет секрета и его атрибутов.
Other Status Codes	KeyVaultError	Key Vault ответ об ошибке, описывающий причину сбоя операции.

Примеры

GetDeletedSecret

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

HTTP

GET https://myvault.vault.azure.net//deletedsecrets/GetDeletedSecretTest?api-version=7.4

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

Код состояния:: 200

{
  "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/GetDeletedSecretTest",
  "deletedDate": 1493938433,
  "scheduledPurgeDate": 1501714433,
  "id": "https://myvault.vault.azure.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865",
  "attributes": {
    "enabled": true,
    "created": 1493938433,
    "updated": 1493938433,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Определения

Имя	Описание
DeletedSecretBundle	Удаленный секрет, состоящий из предыдущего идентификатора, атрибутов и тегов, а также сведений о том, когда он будет очищен.
DeletionRecoveryLevel	Отражает уровень восстановления удаления, действующий в настоящее время для секретов в текущем хранилище. Если он содержит Purgeable, секрет может быть безвозвратно удален привилегированным пользователем; в противном случае только система может очистить секрет в конце интервала хранения.
Error	Ошибка сервера хранилища ключей.
KeyVaultError	Исключение ошибки хранилища ключей.
SecretAttributes	Атрибуты управления секретами.

DeletedSecretBundle

Удаленный секрет, состоящий из предыдущего идентификатора, атрибутов и тегов, а также сведений о том, когда он будет очищен.

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

DeletionRecoveryLevel

Отражает уровень восстановления удаления, действующий в настоящее время для секретов в текущем хранилище. Если он содержит Purgeable, секрет может быть безвозвратно удален привилегированным пользователем; в противном случае только система может очистить секрет в конце интервала хранения.

Имя	Тип	Описание
CustomizedRecoverable	string	Обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и окончательного удаления (т. е. очистка, когда 7< = SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения и в то время, когда подписка по-прежнему доступна.
CustomizedRecoverable+ProtectedSubscription	string	Обозначает состояние хранилища и подписки, в котором удаление можно восстановить, немедленное и окончательное удаление (т. е. очистка) запрещено, а сама подписка не может быть окончательно отменена, если 7< = SoftDeleteRetentionInDays < 90. Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения, а также отражает тот факт, что сама подписка не может быть отменена.
CustomizedRecoverable+Purgeable	string	Обозначает состояние хранилища, в котором удаление можно восстановить, а также позволяет немедленное и окончательное удаление (т. е. очистка, когда 7< = SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения, если не запрошена операция очистки или подписка не отменена.
Purgeable	string	Обозначает состояние хранилища, в котором удаление является необратимой операцией без возможности восстановления. Этот уровень соответствует отсутствием защиты от операции удаления; данные безвозвратно теряются при принятии операции удаления на уровне сущности или выше (хранилище, группа ресурсов, подписка и т. д.);
Recoverable	string	Обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и окончательного удаления (т. е. очистки). Этот уровень гарантирует возможность восстановления удаленной сущности в течение периода хранения (90 дней) и пока подписка остается доступной. System wil окончательно удалить его через 90 дней, если не восстановить
Recoverable+ProtectedSubscription	string	Обозначает состояние хранилища и подписки, в котором удаление можно восстановить в течение периода хранения (90 дней), немедленное и окончательное удаление (т. е. очистка) запрещено, а сама подписка не может быть отменена окончательно. System wil окончательно удалить его через 90 дней, если не восстановить
Recoverable+Purgeable	string	Обозначает состояние хранилища, в котором удаление можно восстановить, а также позволяет немедленное и окончательное удаление (т. е. очистка). Этот уровень гарантирует возможность восстановления удаленной сущности в течение периода хранения (90 дней), если не запрошена операция очистки или подписка не отменена. System wil окончательно удалить его через 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.

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