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

App Service Certificate Orders - Create Or Update

参考

Service:: App Service

API Version:: 2023-12-01

Create或更新证书采购订单的说明。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}?api-version=2023-12-01

URI 参数

名称	在	必需	类型	说明
certificateOrderName	path	True	string	证书订单的名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。 Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Azure 订阅 ID。这是一个 GUID 格式的字符串， (例如 00000000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本

请求正文

名称	必需	类型	说明
location	True	string	资源位置。
properties.productType	True	CertificateProductType	证书产品类型。
kind		string	资源类型。
properties.autoRenew		boolean	`true` 如果证书在过期时应自动续订，则为 ;否则为 `false`。
properties.certificates		<string, AppServiceCertificate>	密钥保管库机密的状态。
properties.csr		string	为此订单创建的最后一个 CSR。
properties.distinguishedName		string	证书可分辨名称。
properties.keySize		integer	证书密钥大小。
properties.validityInYears		integer	以年为单位的持续时间 (必须为 1) 。
tags		object	资源标记。

响应

名称	类型	说明
200 OK	AppServiceCertificateOrder	App 服务证书订单已创建。
201 Created	AppServiceCertificateOrder	App 服务证书订单创建操作正在进行
Other Status Codes	DefaultErrorResponse	App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Create Certificate order

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName?api-version=2023-12-01

{
  "location": "Global",
  "properties": {
    "certificates": {
      "SampleCertName1": {
        "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
        "keyVaultSecretName": "SampleSecretName1"
      },
      "SampleCertName2": {
        "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
        "keyVaultSecretName": "SampleSecretName2"
      }
    },
    "distinguishedName": "CN=SampleCustomDomain.com",
    "validityInYears": 2,
    "keySize": 2048,
    "productType": "StandardDomainValidatedSsl",
    "autoRenew": true
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName",
  "name": "SampleCertificateOrderName",
  "type": "Microsoft.CertificateRegistration/certificateOrders",
  "location": "Global",
  "properties": {
    "certificates": {
      "SampleCertName1": {
        "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
        "keyVaultSecretName": "SampleSecretName1",
        "provisioningState": "Succeeded"
      },
      "SampleCertName2": {
        "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
        "keyVaultSecretName": "SampleSecretName2",
        "provisioningState": "KeyVaultSecretDoesNotExist"
      }
    },
    "distinguishedName": "CN=SampleCustomDomain.com",
    "domainVerificationToken": "awe4163Br6d32r",
    "validityInYears": 2,
    "keySize": 2048,
    "productType": "StandardDomainValidatedSsl",
    "autoRenew": true,
    "provisioningState": "Succeeded",
    "status": "Issued",
    "signedCertificate": {
      "version": 1232490,
      "serialNumber": "sds12424k",
      "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE",
      "subject": "CN=CertSubjectName",
      "issuer": "CACert",
      "signatureAlgorithm": "SHA",
      "notAfter": "2022-11-12T23:40:25+00:00",
      "notBefore": "2021-11-12T23:40:25+00:00"
    },
    "csr": "xdf!x|",
    "intermediate": {
      "version": 5589220,
      "serialNumber": "k45kad0024",
      "thumbprint": "RF3D7411A44163B6D32B3343559B03E175886EBFE",
      "subject": "CN=IntermediateCertSubjectName",
      "issuer": "CACert",
      "signatureAlgorithm": "SHA",
      "notAfter": "2023-11-12T23:40:25+00:00",
      "notBefore": "2021-05-12T23:40:25+00:00"
    },
    "root": {
      "version": 3430921,
      "serialNumber": "jkskd890ajdd00124",
      "thumbprint": "ZD3D7411A44163B6D32B3343559B03E175886EBFE",
      "subject": "CN=RootCertSubjectName",
      "issuer": "CACert",
      "signatureAlgorithm": "SHA",
      "notAfter": "2023-11-12T23:40:25+00:00",
      "notBefore": "2021-05-12T23:40:25+00:00"
    },
    "serialNumber": "12324325325",
    "lastCertificateIssuanceTime": "2021-11-12T23:40:25+00:00",
    "expirationTime": "2022-11-12T23:40:25+00:00",
    "isPrivateKeyExternal": false,
    "appServiceCertificateNotRenewableReasons": [
      "ExpirationNotInRenewalTimeRange"
    ],
    "nextAutoRenewalTimeStamp": "2022-11-12T23:40:25+00:00",
    "contact": {
      "email": "contact@email.com",
      "nameFirst": "SampleFirstName",
      "nameLast": "SampleLastName",
      "phone": "1-224-550-332"
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName",
  "name": "SampleCertificateOrderName",
  "type": "Microsoft.CertificateRegistration/certificateOrders",
  "location": "Global",
  "properties": {
    "certificates": {
      "SampleCertName1": {
        "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
        "keyVaultSecretName": "SampleSecretName1",
        "provisioningState": "Succeeded"
      },
      "SampleCertName2": {
        "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
        "keyVaultSecretName": "SampleSecretName2",
        "provisioningState": "KeyVaultSecretDoesNotExist"
      }
    },
    "distinguishedName": "CN=SampleCustomDomain.com",
    "domainVerificationToken": "awe4163Br6d32r",
    "validityInYears": 2,
    "keySize": 2048,
    "productType": "StandardDomainValidatedSsl",
    "autoRenew": true,
    "provisioningState": "InProgress",
    "status": "Issued",
    "signedCertificate": {
      "version": 1232490,
      "serialNumber": "sds12424k",
      "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE",
      "subject": "CN=CertSubjectName",
      "issuer": "CACert",
      "signatureAlgorithm": "SHA",
      "notAfter": "2022-11-12T23:40:25+00:00",
      "notBefore": "2021-11-12T23:40:25+00:00"
    },
    "csr": "xdf!x|",
    "intermediate": {
      "version": 5589220,
      "serialNumber": "k45kad0024",
      "thumbprint": "RF3D7411A44163B6D32B3343559B03E175886EBFE",
      "subject": "CN=IntermediateCertSubjectName",
      "issuer": "CACert",
      "signatureAlgorithm": "SHA",
      "notAfter": "2023-11-12T23:40:25+00:00",
      "notBefore": "2021-05-12T23:40:25+00:00"
    },
    "root": {
      "version": 3430921,
      "serialNumber": "jkskd890ajdd00124",
      "thumbprint": "ZD3D7411A44163B6D32B3343559B03E175886EBFE",
      "subject": "CN=RootCertSubjectName",
      "issuer": "CACert",
      "signatureAlgorithm": "SHA",
      "notAfter": "2023-11-12T23:40:25+00:00",
      "notBefore": "2021-05-12T23:40:25+00:00"
    },
    "serialNumber": "12324325325",
    "lastCertificateIssuanceTime": "2021-11-12T23:40:25+00:00",
    "expirationTime": "2022-11-12T23:40:25+00:00",
    "isPrivateKeyExternal": false,
    "appServiceCertificateNotRenewableReasons": [
      "ExpirationNotInRenewalTimeRange"
    ],
    "nextAutoRenewalTimeStamp": "2022-11-12T23:40:25+00:00",
    "contact": {
      "email": "contact@email.com",
      "nameFirst": "SampleFirstName",
      "nameLast": "SampleLastName",
      "phone": "1-224-550-332"
    }
  }
}

定义

名称	说明
AppServiceCertificate	密钥保管库通过 Azure 购买的证书的容器。
AppServiceCertificateOrder	SSL 证书采购订单。
CertificateDetails	SSL 证书详细信息。
CertificateOrderContact
CertificateOrderStatus	当前订单状态。
CertificateProductType	证书产品类型。
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
KeyVaultSecretStatus	密钥保管库机密的状态。
ProvisioningState	证书订单的状态。
ResourceNotRenewableReason	目前App 服务证书不可续订的原因。

AppServiceCertificate

密钥保管库通过 Azure 购买的证书的容器。

名称	类型	说明
keyVaultId	string	密钥保管库资源 ID。
keyVaultSecretName	string	密钥保管库机密名称。
provisioningState	KeyVaultSecretStatus	密钥保管库机密的状态。

AppServiceCertificateOrder

SSL 证书采购订单。

名称	类型	默认值	说明
id	string		资源 ID。
kind	string		资源类型。
location	string		资源位置。
name	string		资源名称。
properties.appServiceCertificateNotRenewableReasons	ResourceNotRenewableReason[]		目前App 服务证书不可续订的原因。
properties.autoRenew	boolean	True	`true` 如果证书在过期时应自动续订，则为 ;否则为 `false`。
properties.certificates	<string, AppServiceCertificate>		密钥保管库机密的状态。
properties.contact	CertificateOrderContact		联系信息
properties.csr	string		为此订单创建的最后一个 CSR。
properties.distinguishedName	string		证书可分辨名称。
properties.domainVerificationToken	string		域验证令牌。
properties.expirationTime	string		证书过期时间。
properties.intermediate	CertificateDetails		中间证书。
properties.isPrivateKeyExternal	boolean		`true` 如果私钥是外部的，则为 ;否则为 `false`。
properties.keySize	integer	2048	证书密钥大小。
properties.lastCertificateIssuanceTime	string		证书上次颁发时间。
properties.nextAutoRenewalTimeStamp	string		下一步自动续订证书的时间戳
properties.productType	CertificateProductType		证书产品类型。
properties.provisioningState	ProvisioningState		证书订单的状态。
properties.root	CertificateDetails		根证书。
properties.serialNumber	string		证书的当前序列号。
properties.signedCertificate	CertificateDetails		已签名的证书。
properties.status	CertificateOrderStatus		当前订单状态。
properties.validityInYears	integer	1	以年为单位的持续时间 (必须为 1) 。
tags	object		资源标记。
type	string		资源类型。

CertificateDetails

SSL 证书详细信息。

名称	类型	说明
issuer	string	证书颁发者。
notAfter	string	证书有效日期。
notBefore	string	日期证书的有效期为。
rawData	string	原始证书数据。
serialNumber	string	证书序列号。
signatureAlgorithm	string	证书签名算法。
subject	string	证书使用者。
thumbprint	string	证书指纹。
version	integer	证书版本。

CertificateOrderContact

名称	类型	说明
email	string
nameFirst	string
nameLast	string
phone	string

CertificateOrderStatus

当前订单状态。

名称	类型	说明
Canceled	string
Denied	string
Expired	string
Issued	string
NotSubmitted	string
PendingRekey	string
Pendingissuance	string
Pendingrevocation	string
Revoked	string
Unused	string

CertificateProductType

证书产品类型。

名称	类型	说明
StandardDomainValidatedSsl	string
StandardDomainValidatedWildCardSsl	string

DefaultErrorResponse

App 服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

错误模型。

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

KeyVaultSecretStatus

密钥保管库机密的状态。

名称	类型	说明
AzureServiceUnauthorizedToAccessKeyVault	string
CertificateOrderFailed	string
ExternalPrivateKey	string
Initialized	string
KeyVaultDoesNotExist	string
KeyVaultSecretDoesNotExist	string
OperationNotPermittedOnKeyVault	string
Succeeded	string
Unknown	string
UnknownError	string
WaitingOnCertificateOrder	string

ProvisioningState

证书订单的状态。

名称	类型	说明
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

ResourceNotRenewableReason

目前App 服务证书不可续订的原因。

名称	类型	说明
ExpirationNotInRenewalTimeRange	string
RegistrationStatusNotSupportedForRenewal	string
SubscriptionNotActive	string

Share via