Delete Certificate - Delete Certificate

Ссылка

Служба:: Key Vault

Версия API:: 7.4

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

DELETE {vaultBaseUrl}/certificates/{certificate-name}?api-version=7.4

Параметры URI

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

Ответы

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

Примеры

DeleteCertificate

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

HTTP

DELETE https://myvault.vault.azure.net//certificates/importCert01?api-version=7.4

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

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

{
  "recoveryId": "https://myvault.vault.azure.net/deletedcertificates/importCert01",
  "deletedDate": 1493938558,
  "scheduledPurgeDate": 1501714558,
  "id": "https://myvault.vault.azure.net/certificates/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "kid": "https://myvault.vault.azure.net/keys/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "sid": "https://myvault.vault.azure.net/secrets/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "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": 1493938557,
    "updated": 1493938557,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "policy": {
    "id": "https://myvault.vault.azure.net/certificates/importCert01/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": 1493938557,
      "updated": 1493938557
    }
  }
}

Определения

Имя	Описание
Action	Действие, которое будет выполнено.
CertificateAttributes	Атрибуты управления сертификатами.
CertificatePolicy	Политика управления для сертификата.
CertificatePolicyAction	Тип действия.
DeletedCertificateBundle	Удаленный сертификат, состоящий из его предыдущего идентификатора, атрибутов и тегов, а также сведений о том, когда он будет удален.
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	Время создания в формате 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.

CertificatePolicy

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

Имя	Тип	Описание
attributes	CertificateAttributes	Атрибуты сертификата.
id	string	Идентификатор сертификата.
issuer	IssuerParameters	Параметры для издателя компонента X509 сертификата.
key_props	KeyProperties	Свойства ключа, который поддерживает сертификат.
lifetime_actions	LifetimeAction[]	Действия, которые будут выполняться Key Vault в течение времени существования сертификата.
secret_props	SecretProperties	Свойства секрета, резервного сертификата.
x509_props	X509CertificateProperties	Свойства компонента X509 сертификата.

CertificatePolicyAction

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

Имя	Тип	Описание
AutoRenew	string
EmailContacts	string

DeletedCertificateBundle

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

Имя	Тип	Описание
attributes	CertificateAttributes	Атрибуты сертификата.
cer	string	Содержимое CER сертификата x509.
contentType	string	Тип содержимого секрета. Например: "application/x-pem-file" или "application/x-pkcs12",
deletedDate	integer	Время удаления сертификата в формате UTC
id	string	Идентификатор сертификата.
kid	string	Идентификатор ключа.
policy	CertificatePolicy	Политика управления.
recoveryId	string	URL-адрес объекта восстановления, используемый для идентификации и восстановления удаленного сертификата.
scheduledPurgeDate	integer	Время запланированной очистки сертификата в формате UTC
sid	string	Идентификатор секрета.
tags	object	Метаданные конкретного приложения в виде пар "ключ-значение"
x5t	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 дней) и пока подписка по-прежнему доступна. Система окончательно удаляет его через 90 дней, если она не восстановлена
Recoverable+ProtectedSubscription	string	Обозначает состояние хранилища и подписки, в котором удаление можно восстановить в течение интервала хранения (90 дней), немедленное и постоянное удаление (т. е. очистка) запрещено, а сама подписка не может быть окончательно отменена. Система окончательно удаляет его через 90 дней, если она не восстановлена
Recoverable+Purgeable	string	Обозначает состояние хранилища, в котором удаление можно восстановить, а также позволяет немедленное и постоянное удаление (т. е. очистка). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней), если не будет запрошена операция очистки или подписка не отменена. Система окончательно удаляет его через 90 дней, если она не восстановлена

Error

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

Имя	Тип	Описание
code	string	Код ошибки.
innererror	Error	Ошибка сервера хранилища ключей.
message	string	Сообщение об ошибке.

IssuerParameters

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

Имя	Тип	Описание
cert_transparency	boolean	Указывает, следует ли публиковать сертификаты, созданные в рамках этой политики, в журналах прозрачности сертификатов.
cty	string	Тип сертификата, поддерживаемый поставщиком (необязательно); например OV-SSL, EV-SSL
name	string	Имя упоминаемого объекта издателя или зарезервированные имена; Например, "Self" или "Unknown".

JsonWebKeyCurveName

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

Имя	Тип	Описание
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

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

Имя	Тип	Описание
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

Свойства пары ключей, резервной для сертификата.

Имя	Тип	Описание
crv	JsonWebKeyCurveName	Имя эллиптической кривой. Допустимые значения см. в разделе JsonWebKeyCurveName.
exportable	boolean	Указывает, можно ли экспортировать закрытый ключ. При создании первой версии экспортируемого ключа необходимо указать политику выпуска.
key_size	integer	Размер ключа в битах. Например: 2048, 3072 или 4096 для RSA.
kty	JsonWebKeyType	Тип пары ключей, используемой для сертификата.
reuse_key	boolean	Указывает, будет ли использоваться та же пара ключей при продлении сертификата.

KeyUsageType

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

Имя	Тип	Описание
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

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

Имя	Тип	Описание
error	Error	Ошибка сервера хранилища ключей.

LifetimeAction

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

Имя	Тип	Описание
action	Action	Действие, которое будет выполнено.
trigger	Trigger	Условие, которое будет выполнять действие.

SecretProperties

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

Имя	Тип	Описание
contentType	string	Тип носителя (тип MIME).

SubjectAlternativeNames

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

Имя	Тип	Описание
dns_names	string[]	Доменные имена.
emails	string[]	Адреса электронной почты.
upns	string[]	Имена субъектов-пользователей.

Trigger

Условие, необходимое для выполнения действия.

Имя	Тип	Описание
days_before_expiry	integer	За несколько дней до истечения срока действия для попытки продления. Значение должно быть от 1 до validity_in_months умножено на 27. Если validity_in_months равно 36, значение должно находиться в диапазоне от 1 до 972 (36 * 27).
lifetime_percentage	integer	Процент времени существования триггера. Значение должно находиться в диапазоне от 1 до 99.

X509CertificateProperties

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

Имя	Тип	Описание
ekus	string[]	Расширенное использование ключа.
key_usage	KeyUsageType[]	Определяет способ использования ключа сертификата.
sans	SubjectAlternativeNames	Альтернативные имена субъектов.
subject	string	Имя субъекта. Должно быть допустимым различающееся имя X509.
validity_months	integer	Срок действия сертификата в месяцах.

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