你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Create Certificate - Create Certificate

参考

Service:: Key Vault

API Version:: 7.3

创建新证书。
如果这是第一个版本，则会创建证书资源。此操作需要证书/创建权限。

POST {vaultBaseUrl}/certificates/{certificate-name}/create?api-version=7.3

URI 参数

Name In Required Type Description

Name	In	Required	Type	Description
certificate-name	path	True	string	证书的名称。为了运行服务，可以全局复制你提供的值。提供的值不应包括个人身份信息或敏感信息。 Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	例如， https://myvault.vault.azure.net保管库名称。
api-version	query	True	string	客户端 API 版本。

certificate-name

path

True

string

证书的名称。为了运行服务，可以全局复制你提供的值。提供的值不应包括个人身份信息或敏感信息。

Regex pattern: ^[0-9a-zA-Z-]+$

vaultBaseUrl

path

True

string

例如， https://myvault.vault.azure.net保管库名称。

api-version

query

True

string

客户端 API 版本。

请求正文

Name	Type	Description
attributes	CertificateAttributes	证书的属性 (可选) 。
policy	CertificatePolicy	证书的管理策略。
tags	object	键/值对形式的应用程序特定元数据。

响应

Name	Type	Description
202 Accepted	CertificateOperation	已创建证书捆绑包。
Other Status Codes	KeyVaultError	密钥保管库错误响应，描述操作失败的原因。

示例

CreateCertificate

Sample Request

HTTP

POST https://myvault.vault.azure.net//certificates/selfSignedCert01/create?api-version=7.3

{
  "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

Status code:: 202

{
  "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	将执行的操作。
ActionType	操作的类型。
CertificateAttributes	证书管理属性。
CertificateCreateParameters	证书创建参数。
CertificateOperation	对于异步请求，将返回证书操作。
CertificatePolicy	证书的管理策略。
DeletionRecoveryLevel	反映当前保管库中证书当前生效的删除恢复级别。如果它包含“可清除”，则可以由特权用户永久删除证书;否则，只有系统才能在保留间隔结束时清除证书。
Error	密钥保管库服务器错误。
IssuerParameters	证书的 X509 组件的颁发者的参数。
JsonWebKeyCurveName	椭圆曲线名称。有关有效值，请参阅 JsonWebKeyCurveName。
JsonWebKeyType	要用于证书的密钥对的类型。
KeyProperties	支持证书的密钥对的属性。
KeyVaultError	密钥保管库错误异常。
LifetimeAction	操作及其触发器，将在证书的生存期内由密钥保管库执行。
SecretProperties	支持证书的密钥的属性。
SubjectAlternativeNames	X509 对象的使用者备用名称。
Trigger	要对要执行的操作满足的条件。
X509CertificateProperties	证书的 X509 组件的属性。

Action

将执行的操作。

Name	Type	Description
action_type	ActionType	操作的类型。

ActionType

操作的类型。

Name	Type	Description
AutoRenew	string
EmailContacts	string

CertificateAttributes

证书管理属性。

Name	Type	Description
created	integer	以 UTC 为单位的创建时间。
enabled	boolean	确定是否启用对象。
exp	integer	UTC 格式的到期日期。
nbf	integer	不在 UTC 的日期之前。
recoverableDays	integer	softDelete 数据保留天数。启用 softDelete 时，值应为 >=7 和 <=90，否则为 0。
recoveryLevel	DeletionRecoveryLevel	反映当前保管库中证书当前生效的删除恢复级别。如果它包含“可清除”，则可以由特权用户永久删除证书;否则，只有系统才能在保留间隔结束时清除证书。
updated	integer	上次以 UTC 为单位的更新时间。

CertificateCreateParameters

证书创建参数。

Name	Type	Description
attributes	CertificateAttributes	证书的属性 (可选) 。
policy	CertificatePolicy	证书的管理策略。
tags	object	键/值对形式的应用程序特定元数据。

CertificateOperation

对于异步请求，将返回证书操作。

Name	Type	Description
cancellation_requested	boolean	指示是否在证书操作上请求取消。
csr	string	证书签名请求 (证书操作中使用的 CSR) 。
error	Error	在证书操作期间遇到错误（如果有）。
id	string	证书 ID。
issuer	IssuerParameters	证书的 X509 组件的颁发者的参数。
request_id	string	证书操作的标识符。
status	string	证书操作的状态。
status_details	string	证书操作的状态详细信息。
target	string	包含证书操作结果的位置。

CertificatePolicy

证书的管理策略。

Name	Type	Description
attributes	CertificateAttributes	证书属性。
id	string	证书 ID。
issuer	IssuerParameters	证书的 X509 组件的颁发者的参数。
key_props	KeyProperties	支持证书的密钥的属性。
lifetime_actions	LifetimeAction[]	将在证书生存期内由密钥保管库执行的操作。
secret_props	SecretProperties	支持证书的机密的属性。
x509_props	X509CertificateProperties	证书的 X509 组件的属性。

DeletionRecoveryLevel

反映当前保管库中证书当前生效的删除恢复级别。如果它包含“可清除”，则可以由特权用户永久删除证书;否则，只有系统才能在保留间隔结束时清除证书。

Name	Type	Description
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

密钥保管库服务器错误。

Name	Type	Description
code	string	错误代码。
innererror	Error	密钥保管库服务器错误。
message	string	错误消息。

IssuerParameters

证书的 X509 组件的颁发者的参数。

Name	Type	Description
cert_transparency	boolean	指示是否应将此策略下生成的证书发布到证书透明度日志。
cty	string	提供程序支持的证书类型 (可选) ;例如“OV-SSL”、“EV-SSL”
name	string	引用的颁发者对象或保留名称的名称;例如，“Self”或“Unknown”。

JsonWebKeyCurveName

椭圆曲线名称。有关有效值，请参阅 JsonWebKeyCurveName。

Name	Type	Description
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

要用于证书的密钥对的类型。

Name	Type	Description
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

支持证书的密钥对的属性。

Name	Type	Description
crv	JsonWebKeyCurveName	椭圆曲线名称。有关有效值，请参阅 JsonWebKeyCurveName。
exportable	boolean	指示是否可以导出私钥。创建可导出密钥的第 1 版时，必须提供发布策略。
key_size	integer	密钥的大小（以位为单位）。例如：2048、3072 或 4096（对于 RSA）。
kty	JsonWebKeyType	要用于证书的密钥对的类型。
reuse_key	boolean	指示证书续订时是否使用相同的密钥对。

KeyVaultError

密钥保管库错误异常。

Name	Type	Description
error	Error	密钥保管库服务器错误。

LifetimeAction

操作及其触发器，将在证书的生存期内由密钥保管库执行。

Name	Type	Description
action	Action	将执行的操作。
trigger	Trigger	将执行操作的条件。

SecretProperties

支持证书的密钥的属性。

Name	Type	Description
contentType	string	媒体类型 (MIME 类型) 。

SubjectAlternativeNames

X509 对象的使用者备用名称。

Name	Type	Description
dns_names	string[]	域名。
emails	string[]	电子邮件地址。
upns	string[]	用户主体名称。

Trigger

要对要执行的操作满足的条件。

Name	Type	Description
days_before_expiry	integer	过期前几天尝试续订。值应介于 1 和 validity_in_months乘以 27 之间。如果validity_in_months为 36，则值应介于 1 和 972 之间， (36 * 27) 。
lifetime_percentage	integer	要触发的生存期百分比。值应介于 1 和 99 之间。

X509CertificateProperties

证书的 X509 组件的属性。

Name	Type	Description
ekus	string[]	增强型密钥用法。
key_usage	string[]	密钥用法列表。
sans	SubjectAlternativeNames	使用者可选名称。
subject	string	主题名称。应该是有效的 X509 可分辨名称。
validity_months	integer	证书有效期（以月为单位）。

Create Certificate - Create Certificate

URI 参数

请求正文

响应

示例

CreateCertificate

Sample Request

Sample Response

定义

Action

ActionType

CertificateAttributes

CertificateCreateParameters

CertificateOperation

CertificatePolicy

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties

其他资源