你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
App Service Certificate Orders - Validate Purchase Information
验证证书订单信息的说明。
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation?api-version=2023-12-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
subscription
|
path | True |
string |
Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000) 。 |
api-version
|
query | True |
string |
API 版本 |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
location | True |
string |
资源位置。 |
properties.productType | True |
证书产品类型。 |
|
kind |
string |
资源类型。 |
|
properties.autoRenew |
boolean |
|
|
properties.certificates |
<string,
App |
密钥保管库机密的状态。 |
|
properties.csr |
string |
为此订单创建的最后一个 CSR。 |
|
properties.distinguishedName |
string |
证书可分辨名称。 |
|
properties.keySize |
integer |
证书密钥大小。 |
|
properties.validityInYears |
integer |
以年为单位的持续时间 (必须为 1) 。 |
|
tags |
object |
资源标记。 |
响应
名称 | 类型 | 说明 |
---|---|---|
204 No Content |
无内容 |
|
Other Status Codes |
App 服务错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Validate App Service Certificate purchase information by subscription
Sample Request
POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation?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
定义
名称 | 说明 |
---|---|
App |
密钥保管库通过 Azure 购买的证书的容器。 |
App |
SSL 证书采购订单。 |
Certificate |
SSL 证书详细信息。 |
Certificate |
|
Certificate |
当前订单状态。 |
Certificate |
证书产品类型。 |
Default |
App 服务错误响应。 |
Details | |
Error |
错误模型。 |
Key |
密钥保管库机密的状态。 |
Provisioning |
证书订单的状态。 |
Resource |
目前App 服务证书不可续订的原因。 |
AppServiceCertificate
密钥保管库通过 Azure 购买的证书的容器。
名称 | 类型 | 说明 |
---|---|---|
keyVaultId |
string |
密钥保管库资源 ID。 |
keyVaultSecretName |
string |
密钥保管库机密名称。 |
provisioningState |
密钥保管库机密的状态。 |
AppServiceCertificateOrder
SSL 证书采购订单。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
id |
string |
资源 ID。 |
|
kind |
string |
资源类型。 |
|
location |
string |
资源位置。 |
|
name |
string |
资源名称。 |
|
properties.appServiceCertificateNotRenewableReasons |
目前App 服务证书不可续订的原因。 |
||
properties.autoRenew |
boolean |
True |
|
properties.certificates |
<string,
App |
密钥保管库机密的状态。 |
|
properties.contact |
联系信息 |
||
properties.csr |
string |
为此订单创建的最后一个 CSR。 |
|
properties.distinguishedName |
string |
证书可分辨名称。 |
|
properties.domainVerificationToken |
string |
域验证令牌。 |
|
properties.expirationTime |
string |
证书过期时间。 |
|
properties.intermediate |
中间证书。 |
||
properties.isPrivateKeyExternal |
boolean |
|
|
properties.keySize |
integer |
2048 |
证书密钥大小。 |
properties.lastCertificateIssuanceTime |
string |
证书上次颁发时间。 |
|
properties.nextAutoRenewalTimeStamp |
string |
证书下次自动续订的时间戳 |
|
properties.productType |
证书产品类型。 |
||
properties.provisioningState |
证书订单的状态。 |
||
properties.root |
根证书。 |
||
properties.serialNumber |
string |
证书的当前序列号。 |
|
properties.signedCertificate |
签名的证书。 |
||
properties.status |
当前订单状态。 |
||
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
名称 | 类型 | 说明 |
---|---|---|
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 |
错误模型。 |
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 |