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


Recover Deleted Certificate - Recover Deleted Certificate

Восстанавливает удаленный сертификат до его текущей версии в каталоге /certificates.
Операция RecoverDeletedCertificate выполняет обратную операцию Delete. Эта операция применима в хранилищах с поддержкой обратимого удаления и должна быть выдана в течение интервала хранения (доступного в атрибутах удаленного сертификата). Для этой операции требуется разрешение на получение сертификатов/восстановления.

POST {vaultBaseUrl}/deletedcertificates/{certificate-name}/recover?api-version=2025-07-01

Параметры URI

Имя В Обязательно Тип Описание
certificate-name
path True

string

Название удаленного сертификата

vaultBaseUrl
path True

string (uri)

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

CertificateBundle

Запрос выполнен успешно.

Other Status Codes

KeyVaultError

Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
https://vault.azure.net/.default

Примеры

RecoverDeletedCertificate

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

POST https://myvault.vault.azure.net//deletedcertificates/CertCreateDeleteRecoverPurgeTest/recover?api-version=2025-07-01

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

{
  "id": "https://myvault.vault.azure.net/certificates/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d",
  "kid": "https://myvault.vault.azure.net/keys/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d",
  "sid": "https://myvault.vault.azure.net/secrets/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d",
  "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
  "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=",
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799,
    "created": 1493938486,
    "updated": 1493938486,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "policy": {
    "id": "https://myvault.vault.azure.net/certificates/CertCreateDeleteRecoverPurgeTest/policy",
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=KeyVaultTest",
      "ekus": [],
      "key_usage": [],
      "validity_months": 297
    },
    "lifetime_actions": [
      {
        "trigger": {
          "lifetime_percentage": 80
        },
        "action": {
          "action_type": "EmailContacts"
        }
      }
    ],
    "issuer": {
      "name": "Unknown"
    },
    "attributes": {
      "enabled": true,
      "created": 1493938486,
      "updated": 1493938486
    }
  }
}

Определения

Имя Описание
Action

Действие, которое будет выполнено.

CertificateAttributes

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

CertificateBundle

Пакет сертификатов состоит из сертификата (X509) и его атрибутов.

CertificatePolicy

Политика управления сертификатом.

CertificatePolicyAction

Тип действия.

DeletionRecoveryLevel

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

Error
IssuerParameters

Параметры для издателя компонента X509 сертификата.

JsonWebKeyCurveName

Имя эллиптической кривой. Допустимые значения см. в разделе JsonWebKeyCurveName.

JsonWebKeyType

Тип пары ключей, которая будет использоваться для сертификата.

KeyProperties

Свойства пары ключей, обеспечивающей сертификат.

KeyUsageType

Поддерживаемое использование ключа сертификата.

KeyVaultError

Исключение ошибки хранилища ключей.

LifetimeAction

Действие и его триггер, которые будут выполняться Key Vault в течение всего срока действия сертификата.

SecretProperties

Свойства ключа, обеспечивающего сертификат.

SubjectAlternativeNames

Альтернативные имена объекта X509.

Trigger

Условие, которое должно быть выполнено для выполнения действия.

X509CertificateProperties

Свойства компонента X509 сертификата.

Action

Действие, которое будет выполнено.

Имя Тип Описание
action_type

CertificatePolicyAction

Тип действия.

CertificateAttributes

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

Имя Тип Описание
created

integer (unixtime)

Время создания в UTC.

enabled

boolean

Определяет, включен ли объект.

exp

integer (unixtime)

Дата истечения срока действия в UTC.

nbf

integer (unixtime)

Не раньше даты в UTC.

recoverableDays

integer (int32)

Дни хранения данных softDelete. Значение должно быть >=7 и <=90 при включенном softDelete, в противном случае 0.

recoveryLevel

DeletionRecoveryLevel

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

updated

integer (unixtime)

Последнее обновление времени в UTC.

CertificateBundle

Пакет сертификатов состоит из сертификата (X509) и его атрибутов.

Имя Тип Описание
attributes

CertificateAttributes

Атрибуты сертификата.

cer

string (byte)

Содержимое CER сертификата x509.

contentType

string

Тип контента секрета. eg. 'application/x-pem-file' или 'application/x-pkcs12'.

id

string

Идентификатор сертификата.

kid

string

Идентификатор ключа.

policy

CertificatePolicy

Политика управления.

preserveCertOrder

boolean

Указывает, сохраняется ли исходный порядок в цепочке сертификатов. Значение по умолчанию — false, которое устанавливает индекс 0 для конечного сертификата.

sid

string

Секретный идентификатор.

tags

object

Метаданные, специфичные для приложения, в виде пар ключ-значение.

x5t

string (base64url)

Отпечаток сертификата.

CertificatePolicy

Политика управления сертификатом.

Имя Тип Описание
attributes

CertificateAttributes

Атрибуты сертификата.

id

string

Идентификатор сертификата.

issuer

IssuerParameters

Параметры для издателя компонента X509 сертификата.

key_props

KeyProperties

Свойства ключа, обеспечивающего сертификат.

lifetime_actions

LifetimeAction[]

Действия, которые Key Vault будет выполнять в течение всего срока действия сертификата.

secret_props

SecretProperties

Свойства секретного обеспечения сертификата.

x509_props

X509CertificateProperties

Свойства компонента X509 сертификата.

CertificatePolicyAction

Тип действия.

Значение Описание
EmailContacts

Политика сертификатов, которая будет отправлять контакты сертификатов по электронной почте.

AutoRenew

Политика сертификатов, которая будет автоматически продлевать сертификат.

DeletionRecoveryLevel

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

Значение Описание
Purgeable

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

Recoverable+Purgeable

Обозначает состояние хранилища, при котором удаление можно восстановить, а также позволяет немедленное и окончательное удаление (т. е. очистку). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней), если не будет запрошена операция очистки или подписка не будет отменена. Система навсегда удалит его через 90 дней, если он не будет восстановлен

Recoverable

Обозначает состояние хранилища, при котором удаление можно восстановить без возможности немедленного и окончательного удаления (т. е. очистки). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней) и пока подписка все еще доступна. Система навсегда удалит его через 90 дней, если он не будет восстановлен

Recoverable+ProtectedSubscription

Обозначает состояние хранилища и подписки, при котором удаление можно восстановить в течение интервала хранения (90 дней), немедленное и окончательное удаление (т. е. очистка) не допускается, а сама подписка не может быть отменена навсегда. Система навсегда удалит его через 90 дней, если он не будет восстановлен

CustomizedRecoverable+Purgeable

Обозначает состояние хранилища, при котором удаление можно восстановить, а также позволяет немедленное и окончательное удаление (т. е. очистка, когда 7 <= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения, если не будет запрошена операция очистки или подписка не будет отменена.

CustomizedRecoverable

Обозначает состояние хранилища, при котором удаление можно восстановить без возможности немедленного и окончательного удаления (т. е. очистка, когда 7 <= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения и пока подписка все еще доступна.

CustomizedRecoverable+ProtectedSubscription

Обозначает состояние хранилища и подписки, при котором удаление можно восстановить, немедленное и окончательное удаление (т. е. очистка) не допускается, и при котором сама подписка не может быть отменена навсегда, когда 7 <= SoftDeleteRetentionInDays < 90. Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения, а также отражает тот факт, что сама подписка не может быть отменена.

Error

Имя Тип Описание
code

string

Код ошибки.

innererror

Error

Ошибка сервера хранилища ключей.

message

string

Сообщение об ошибке.

IssuerParameters

Параметры для издателя компонента X509 сертификата.

Имя Тип Описание
cert_transparency

boolean

Указывает, следует ли публиковать сертификаты, созданные в соответствии с этой политикой, в журналах прозрачности сертификатов.

cty

string

Тип сертификата, поддерживаемый поставщиком (необязательно); Например, 'OV-SSL', 'EV-SSL'

name

string

Имя объекта издателя, на который ссылается ссылка, или зарезервированные имена; например, «Я» или «Неизвестно».

JsonWebKeyCurveName

Имя эллиптической кривой. Допустимые значения см. в разделе JsonWebKeyCurveName.

Значение Описание
P-256

Эллиптическая кривая NIST P-256, также известная как кривая SECG SECP256R1.

P-384

Эллиптическая кривая NIST P-384, также известная как кривая SECG SECP384R1.

P-521

Эллиптическая кривая NIST P-521, также известная как кривая SECG SECP521R1.

P-256K

Эллиптическая кривая SECG SECP256K1.

JsonWebKeyType

Тип пары ключей, которая будет использоваться для сертификата.

Значение Описание
EC

Эллиптическая кривая.

EC-HSM

Эллиптическая кривая с закрытым ключом, который нельзя экспортировать из HSM.

RSA

ЮАР (https://tools.ietf.org/html/rfc3447).

RSA-HSM

RSA с закрытым ключом, который нельзя экспортировать из HSM.

oct

Последовательность октетов (используется для представления симметричных тональностей).

oct-HSM

Октетная последовательность с закрытым ключом, который нельзя экспортировать из HSM.

KeyProperties

Свойства пары ключей, обеспечивающей сертификат.

Имя Тип Описание
crv

JsonWebKeyCurveName

Имя эллиптической кривой. Допустимые значения см. в разделе JsonWebKeyCurveName.

exportable

boolean

Указывает, можно ли экспортировать закрытый ключ. Политика выпуска должна быть предоставлена при создании первой версии экспортируемого ключа.

key_size

integer (int32)

Размер ключа в битах. Например: 2048, 3072 или 4096 для RSA.

kty

JsonWebKeyType

Тип пары ключей, которая будет использоваться для сертификата.

reuse_key

boolean

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

KeyUsageType

Поддерживаемое использование ключа сертификата.

Значение Описание
digitalSignature

Указывает, что ключ сертификата можно использовать в качестве цифровой подписи.

nonRepudiation

Указывает, что ключ сертификата можно использовать для проверки подлинности.

keyEncipherment

Указывает, что ключ сертификата можно использовать для шифрования ключа.

dataEncipherment

Указывает, что ключ сертификата можно использовать для шифрования данных.

keyAgreement

Указывает, что ключ сертификата может использоваться для определения соглашения ключа, например ключ, созданный с использованием алгоритма соглашения ключей Diffie-Hellman.

keyCertSign

Указывает, что ключ сертификата можно использовать для подписи сертификатов.

cRLSign

Указывает, что ключ сертификата можно использовать для подписи списка отзыва сертификата.

encipherOnly

Указывает, что ключ сертификата можно использовать только для шифрования.

decipherOnly

Указывает, что ключ сертификата можно использовать только для расшифровки.

KeyVaultError

Исключение ошибки хранилища ключей.

Имя Тип Описание
error

Error

Ошибка сервера хранилища ключей.

LifetimeAction

Действие и его триггер, которые будут выполняться Key Vault в течение всего срока действия сертификата.

Имя Тип Описание
action

Action

Действие, которое будет выполнено.

trigger

Trigger

Условие, при котором будет выполнено действие.

SecretProperties

Свойства ключа, обеспечивающего сертификат.

Имя Тип Описание
contentType

string

Тип носителя (тип MIME).

SubjectAlternativeNames

Альтернативные имена объекта X509.

Имя Тип Описание
dns_names

string[]

Доменные имена.

emails

string[]

Адреса электронной почты.

ipAddresses

string[]

IP-адреса; поддерживает IPv4 и IPv6.

upns

string[]

Имена участников-пользователей.

uris

string[]

Унифицированные идентификаторы ресурсов.

Trigger

Условие, которое должно быть выполнено для выполнения действия.

Имя Тип Описание
days_before_expiry

integer (int32)

За несколько дней до истечения срока действия, чтобы попытаться продлить срок действия. Значение должно быть от 1 до validity_in_months умножить на 27. Если validity_in_months равно 36, то значение должно быть в диапазоне от 1 до 972 (36 * 27).

lifetime_percentage

integer (int32)

minimum: 1
maximum: 99

Процент времени жизни, при котором необходимо выполнить срабатывание. Значение должно быть в диапазоне от 1 до 99.

X509CertificateProperties

Свойства компонента X509 сертификата.

Имя Тип Описание
ekus

string[]

Улучшенное использование ключа.

key_usage

KeyUsageType[]

Определяет, как может использоваться ключ сертификата.

sans

SubjectAlternativeNames

Предмет альтернативных названий.

subject

string

Имя субъекта. Должно быть действительным отличительным именем X509.

validity_months

integer (int32)

minimum: 0

Срок действия сертификата в месяцах.