Get Deleted Certificates - Get Deleted Certificates

Ссылка

Service:: Key Vault

API Version:: 7.4

Списки удаленные сертификаты в указанном хранилище, доступном для восстановления.
Операция GetDeletedCertificates извлекает сертификаты в текущем хранилище, которые находятся в удаленном состоянии и готовы к восстановлению или очистке. Эта операция включает сведения об удалении. Для этой операции требуется разрешение certificates, get/list. Эту операцию можно включить только в хранилищах с поддержкой обратимого удаления.

GET {vaultBaseUrl}/deletedcertificates?api-version=7.4

With optional parameters:

GET {vaultBaseUrl}/deletedcertificates?maxresults={maxresults}&includePending={includePending}&api-version=7.4

Параметры URI

Имя	В	Обязательно	Тип	Описание
vaultBaseUrl	path	True	string	Имя хранилища, например https://myvault.vault.azure.net.
api-version	query	True	string	Версия API клиента.
includePending	query		boolean	Указывает, следует ли включать сертификаты, подготовленные не полностью.
maxresults	query		integer int32	Максимальное количество результатов, возвращаемых на странице. Если этот параметр не указан, служба вернет до 25 результатов.

Ответы

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

Примеры

GetDeletedCertificates

Sample Request

HTTP

GET https://myvault.vault.azure.net//deletedcertificates?maxresults=1&api-version=7.4

Sample Response

Status code:: 200

{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedcertificates/listdeletedcerttest0",
      "deletedDate": 1493937659,
      "scheduledPurgeDate": 1501713659,
      "id": "https://myvault.vault.azure.net/certificates/listdeletedcerttest0",
      "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
      "attributes": {
        "enabled": true,
        "nbf": 1430344421,
        "exp": 2208988799,
        "created": 1493937658,
        "updated": 1493937658,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedcertificates?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMTIhTURBd01ETTVJV05sY25ScFptbGpZWFJsTDB4SlUxUkVSVXhGVkVWRVEwVlNWRlJGVTFRd0wxQlBURWxEV1NFd01EQXdNamdoT1RrNU9TMHhNaTB6TVZReU16bzFPVG8xT1M0NU9UazVPVGs1V2lFLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

Определения

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

CertificateAttributes

Атрибуты управления сертификатами.

Имя	Тип	Описание
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.

DeletedCertificateItem

Удаленный элемент сертификата, содержащий метаданные об удаленном сертификате.

Имя	Тип	Описание
attributes	CertificateAttributes	Атрибуты управления сертификатами.
deletedDate	integer	Время удаления сертификата в формате UTC
id	string	Идентификатор сертификата.
recoveryId	string	URL-адрес объекта восстановления, используемый для идентификации и восстановления удаленного сертификата.
scheduledPurgeDate	integer	Время запланированной очистки сертификата в формате UTC
tags	object	Метаданные конкретного приложения в виде пар «ключ — значение».
x5t	string	Отпечаток сертификата.

DeletedCertificateListResult

Список сертификатов, которые были удалены в этом хранилище.

Имя	Тип	Описание
nextLink	string	URL-адрес для получения следующего набора удаленных сертификатов.
value	DeletedCertificateItem[]	Ответное сообщение со списком удаленных сертификатов в хранилище и ссылкой на следующую страницу удаленных сертификатов

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	Ошибка сервера хранилища ключей.