Create Certificate - Create Certificate
Создание нового сертификата.
Если это первая версия, создается ресурс сертификата. Эта операция требует наличия разрешения на создание сертификатов.
POST {vaultBaseUrl}/certificates/{certificate-name}/create?api-version=7.4
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
certificate-name
|
path | True |
string |
Имя сертификата. Указанное значение может быть глобально скопировано для запуска службы. Указываемое значение не должно включать личную или конфиденциальную информацию. Regex pattern: |
vault
|
path | True |
string |
Имя хранилища, например https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Версия API клиента. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
attributes |
Атрибуты сертификата (необязательно). |
|
policy |
Политика управления для сертификата. |
|
tags |
object |
Метаданные конкретного приложения в виде пар «ключ — значение». |
Ответы
Имя | Тип | Описание |
---|---|---|
202 Accepted |
Созданный пакет сертификатов. |
|
Other Status Codes |
Key Vault ответ об ошибке, описывающий причину сбоя операции. |
Примеры
CreateCertificate
Sample Request
POST https://myvault.vault.azure.net//certificates/selfSignedCert01/create?api-version=7.4
{
"policy": {
"key_props": {
"exportable": true,
"kty": "RSA",
"key_size": 2048,
"reuse_key": false
},
"secret_props": {
"contentType": "application/x-pkcs12"
},
"x509_props": {
"subject": "CN=*.microsoft.com",
"sans": {
"dns_names": [
"onedrive.microsoft.com",
"xbox.microsoft.com"
]
}
},
"issuer": {
"name": "Self"
}
}
}
Sample Response
{
"id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/pending",
"issuer": {
"name": "Self"
},
"csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=",
"cancellation_requested": false,
"status": "inProgress",
"status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.",
"request_id": "6faacd568ab049a2803861e8dd3ae21f"
}
Определения
Имя | Описание |
---|---|
Action |
Действие, которое будет выполнено. |
Certificate |
Атрибуты управления сертификатами. |
Certificate |
Параметры создания сертификата. |
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. |
CertificateCreateParameters
Параметры создания сертификата.
Имя | Тип | Описание |
---|---|---|
attributes |
Атрибуты сертификата (необязательно). |
|
policy |
Политика управления для сертификата. |
|
tags |
object |
Метаданные конкретного приложения в виде пар «ключ — значение». |
CertificateOperation
Операция с сертификатом возвращается в случае асинхронных запросов.
Имя | Тип | Описание |
---|---|---|
cancellation_requested |
boolean |
Указывает, была ли запрошена отмена операции с сертификатом. |
csr |
string |
Запрос на подпись сертификата (CSR), используемый в операции с сертификатом. |
error |
Во время операции с сертификатом произошла ошибка, если она была обнаружена. |
|
id |
string |
Идентификатор сертификата. |
issuer |
Параметры для издателя компонента X509 сертификата. |
|
request_id |
string |
Идентификатор операции с сертификатом. |
status |
string |
Состояние операции с сертификатом. |
status_details |
string |
Сведения о состоянии операции с сертификатом. |
target |
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 |
Срок действия сертификата в месяцах. |