Merge Certificate - Merge Certificate
Объединяет сертификат или цепочку сертификатов с парой ключей, существующей на сервере.
Операция MergeCertificate выполняет слияние сертификата или цепочки сертификатов с парой ключей, доступной в настоящее время в службе. Эта операция требует наличия разрешения на создание сертификатов.
POST {vaultBaseUrl}/certificates/{certificate-name}/pending/merge?api-version=7.4
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
certificate-name
|
path | True |
string |
Имя сертификата. |
vault
|
path | True |
string |
Имя хранилища, например https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Версия API клиента. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x5c | True |
string[] |
Сертификат или цепочка сертификатов для слияния. |
attributes |
Атрибуты сертификата (необязательно). |
||
tags |
object |
Метаданные конкретного приложения в виде пар «ключ — значение». |
Ответы
Имя | Тип | Описание |
---|---|---|
201 Created |
Объединенный пакет сертификатов в хранилище. |
|
Other Status Codes |
Key Vault ответ об ошибке, описывающий причину сбоя операции. |
Примеры
MergeCertificate
Sample Request
POST https://myvault.vault.azure.net//certificates/testcert/pending/merge?api-version=7.4
{
"x5c": [
"MIICxTCCAb....trimmed for brevitiy...EPAQj8="
]
}
Sample Response
{
"id": "https://myvault.vault.azure.net/certificates/mycert1/f366e1a9dd774288ad84a45a5f620352",
"kid": "https:// mykeyvault.vault.azure.net/keys/mycert1/f366e1a9dd774288ad84a45a5f620352",
"sid": " mykeyvault.vault.azure.net/secrets/mycert1/f366e1a9dd774288ad84a45a5f620352",
"cer": "……de34534……",
"x5t": "n14q2wbvyXr71Pcb58NivuiwJKk",
"attributes": {
"enabled": true,
"exp": 1530394215,
"nbf": 1435699215,
"created": 1435699919,
"updated": 1435699919
},
"policy": {
"id": "https:// mykeyvault.vault.azure.net/certificates/mycert1/policy",
"key_props": {
"exportable": false,
"kty": "RSA",
"key_size": 2048,
"reuse_key": false
},
"secret_props": {
"contentType": "application/x-pkcs12"
},
"x509_props": {
"subject": "CN=Mycert1",
"ekus": [
"1.3.6.1.5.5.7.3.1",
"1.3.6.1.5.5.7.3.2"
],
"validity_months": 12
},
"lifetime_actions": [
{
"trigger": {
"lifetime_percentage": 80
},
"action": {
"action_type": "EmailContacts"
}
}
],
"issuer": {
"name": "Unknown"
},
"attributes": {
"enabled": true,
"created": 1435699811,
"updated": 1435699811
}
}
}
Определения
Имя | Описание |
---|---|
Action |
Действие, которое будет выполнено. |
Certificate |
Атрибуты управления сертификатами. |
Certificate |
Пакет сертификатов состоит из сертификата (X509) и его атрибутов. |
Certificate |
Параметры слияния сертификатов |
Certificate |
Политика управления для сертификата. |
Certificate |
Тип действия. |
Deletion |
Отражает уровень восстановления удаления, действующий в настоящее время для сертификатов в текущем хранилище. Если он содержит Purgeable, сертификат может быть безвозвратно удален привилегированным пользователем; В противном случае только система может очистить сертификат в конце интервала хранения. |
Error |
Ошибка сервера хранилища ключей. |
Issuer |
Параметры для издателя компонента X509 сертификата. |
Json |
Имя эллиптической кривой. Допустимые значения см. в разделе JsonWebKeyCurveName. |
Json |
Тип пары ключей, используемой для сертификата. |
Key |
Свойства пары ключей, резервной копии сертификата. |
Key |
Определяет способ использования ключа сертификата. |
Key |
Исключение ошибки хранилища ключей. |
Lifetime |
Действие и его триггер, которые будут выполняться Key Vault в течение времени существования сертификата. |
Secret |
Свойства ключа, который поддерживает сертификат. |
Subject |
Альтернативные имена субъектов объекта X509. |
Trigger |
Условие, выполняемое для выполнения действия. |
X509Certificate |
Свойства компонента X509 сертификата. |
Action
Действие, которое будет выполнено.
Имя | Тип | Описание |
---|---|---|
action_type |
Тип действия. |
CertificateAttributes
Атрибуты управления сертификатами.
Имя | Тип | Описание |
---|---|---|
created |
integer |
Время создания в формате UTC. |
enabled |
boolean |
Определяет, включен ли объект . |
exp |
integer |
Дата окончания срока действия в формате UTC. |
nbf |
integer |
Не раньше даты в формате UTC. |
recoverableDays |
integer |
softDelete data retention days. Значение должно быть >равно =7 и =90, если softDelete включено, в <противном случае — 0. |
recoveryLevel |
Отражает уровень восстановления удаления, действующий в настоящее время для сертификатов в текущем хранилище. Если он содержит Purgeable, сертификат может быть безвозвратно удален привилегированным пользователем; В противном случае только система может очистить сертификат в конце интервала хранения. |
|
updated |
integer |
Время последнего обновления в формате UTC. |
CertificateBundle
Пакет сертификатов состоит из сертификата (X509) и его атрибутов.
Имя | Тип | Описание |
---|---|---|
attributes |
Атрибуты сертификата. |
|
cer |
string |
Содержимое CER сертификата x509. |
contentType |
string |
Тип содержимого секрета. Например: "application/x-pem-file" или "application/x-pkcs12", |
id |
string |
Идентификатор сертификата. |
kid |
string |
Идентификатор ключа. |
policy |
Политика управления. |
|
sid |
string |
Идентификатор секрета. |
tags |
object |
Метаданные конкретного приложения в виде пар "ключ-значение" |
x5t |
string |
Отпечаток сертификата. |
CertificateMergeParameters
Параметры слияния сертификатов
Имя | Тип | Описание |
---|---|---|
attributes |
Атрибуты сертификата (необязательно). |
|
tags |
object |
Метаданные конкретного приложения в виде пар «ключ — значение». |
x5c |
string[] |
Сертификат или цепочка сертификатов для слияния. |
CertificatePolicy
Политика управления для сертификата.
Имя | Тип | Описание |
---|---|---|
attributes |
Атрибуты сертификата. |
|
id |
string |
Идентификатор сертификата. |
issuer |
Параметры для издателя компонента X509 сертификата. |
|
key_props |
Свойства ключа, который поддерживает сертификат. |
|
lifetime_actions |
Действия, которые будут выполняться Key Vault в течение жизненного цикла сертификата. |
|
secret_props |
Свойства секрета, который поддерживает сертификат. |
|
x509_props |
Свойства компонента X509 сертификата. |
CertificatePolicyAction
Тип действия.
Имя | Тип | Описание |
---|---|---|
AutoRenew |
string |
|
EmailContacts |
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 |
Ошибка сервера хранилища ключей. |
|
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. |
|
exportable |
boolean |
Указывает, можно ли экспортировать закрытый ключ. При создании первой версии экспортируемого ключа необходимо указать политику выпуска. |
key_size |
integer |
Размер ключа в битах. Например: 2048, 3072 или 4096 для RSA. |
kty |
Тип пары ключей, используемой для сертификата. |
|
reuse_key |
boolean |
Указывает, будет ли использоваться та же пара ключей при продлении сертификата. |
KeyUsageType
Определяет способ использования ключа сертификата.
Имя | Тип | Описание |
---|---|---|
cRLSign |
string |
|
dataEncipherment |
string |
|
decipherOnly |
string |
|
digitalSignature |
string |
|
encipherOnly |
string |
|
keyAgreement |
string |
|
keyCertSign |
string |
|
keyEncipherment |
string |
|
nonRepudiation |
string |
KeyVaultError
Исключение ошибки хранилища ключей.
Имя | Тип | Описание |
---|---|---|
error |
Ошибка сервера хранилища ключей. |
LifetimeAction
Действие и его триггер, которые будут выполняться Key Vault в течение времени существования сертификата.
Имя | Тип | Описание |
---|---|---|
action |
Действие, которое будет выполнено. |
|
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 |
Определяет способ использования ключа сертификата. |
|
sans |
Альтернативные имена субъектов. |
|
subject |
string |
Имя субъекта. Должно быть допустимым различающееся имя X509. |
validity_months |
integer |
Срок действия сертификата в месяцах. |