App Service Certificate Orders - Validate Purchase Information

Service:

App Service

API Version:

2023-12-01

Description for Validate information for a certificate order.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Request Body

Name	Required	Type	Description
location	True	string	Resource Location.
properties.productType	True	CertificateProductType	Certificate product type.
kind		string	Kind of resource.
properties.autoRenew		boolean	true if the certificate should be automatically renewed when it expires; otherwise, false.
properties.certificates		<string,  AppServiceCertificate>	State of the Key Vault secret.
properties.csr		string	Last CSR that was created for this order.
properties.distinguishedName		string	Certificate distinguished name.
properties.keySize		integer	Certificate key size.
properties.validityInYears		integer	Duration in years (must be 1).
tags		object	Resource tags.

Responses

Name	Type	Description
204 No Content		No Content
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Validate App Service Certificate purchase information by subscription

Sample Request

HTTP

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

Status code:

204

Definitions

Name	Description
AppServiceCertificate	Key Vault container for a certificate that is purchased through Azure.
AppServiceCertificateOrder	SSL certificate purchase order.
CertificateDetails	SSL certificate details.
CertificateOrderContact
CertificateOrderStatus	Current order status.
CertificateProductType	Certificate product type.
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
KeyVaultSecretStatus	Status of the Key Vault secret.
ProvisioningState	Status of certificate order.
ResourceNotRenewableReason	Reasons why App Service Certificate is not renewable at the current moment.

AppServiceCertificate

Key Vault container for a certificate that is purchased through Azure.

Name	Type	Description
keyVaultId	string	Key Vault resource Id.
keyVaultSecretName	string	Key Vault secret name.
provisioningState	KeyVaultSecretStatus	Status of the Key Vault secret.

AppServiceCertificateOrder

SSL certificate purchase order.

Name	Type	Default Value	Description
id	string		Resource Id.
kind	string		Kind of resource.
location	string		Resource Location.
name	string		Resource Name.
properties.appServiceCertificateNotRenewableReasons	ResourceNotRenewableReason[]		Reasons why App Service Certificate is not renewable at the current moment.
properties.autoRenew	boolean	True	true if the certificate should be automatically renewed when it expires; otherwise, false.
properties.certificates	<string,  AppServiceCertificate>		State of the Key Vault secret.
properties.contact	CertificateOrderContact		Contact info
properties.csr	string		Last CSR that was created for this order.
properties.distinguishedName	string		Certificate distinguished name.
properties.domainVerificationToken	string		Domain verification token.
properties.expirationTime	string		Certificate expiration time.
properties.intermediate	CertificateDetails		Intermediate certificate.
properties.isPrivateKeyExternal	boolean		true if private key is external; otherwise, false.
properties.keySize	integer	2048	Certificate key size.
properties.lastCertificateIssuanceTime	string		Certificate last issuance time.
properties.nextAutoRenewalTimeStamp	string		Time stamp when the certificate would be auto renewed next
properties.productType	CertificateProductType		Certificate product type.
properties.provisioningState	ProvisioningState		Status of certificate order.
properties.root	CertificateDetails		Root certificate.
properties.serialNumber	string		Current serial number of the certificate.
properties.signedCertificate	CertificateDetails		Signed certificate.
properties.status	CertificateOrderStatus		Current order status.
properties.validityInYears	integer	1	Duration in years (must be 1).
tags	object		Resource tags.
type	string		Resource type.

CertificateDetails

SSL certificate details.

Name	Type	Description
issuer	string	Certificate Issuer.
notAfter	string	Date Certificate is valid to.
notBefore	string	Date Certificate is valid from.
rawData	string	Raw certificate data.
serialNumber	string	Certificate Serial Number.
signatureAlgorithm	string	Certificate Signature algorithm.
subject	string	Certificate Subject.
thumbprint	string	Certificate Thumbprint.
version	integer	Certificate Version.

CertificateOrderContact

Name	Type	Description
email	string
nameFirst	string
nameLast	string
phone	string

CertificateOrderStatus

Current order status.

Name	Type	Description
Canceled	string
Denied	string
Expired	string
Issued	string
NotSubmitted	string
PendingRekey	string
Pendingissuance	string
Pendingrevocation	string
Revoked	string
Unused	string

CertificateProductType

Certificate product type.

Name	Type	Description
StandardDomainValidatedSsl	string
StandardDomainValidatedWildCardSsl	string

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

KeyVaultSecretStatus

Status of the Key Vault secret.

Name	Type	Description
AzureServiceUnauthorizedToAccessKeyVault	string
CertificateOrderFailed	string
ExternalPrivateKey	string
Initialized	string
KeyVaultDoesNotExist	string
KeyVaultSecretDoesNotExist	string
OperationNotPermittedOnKeyVault	string
Succeeded	string
Unknown	string
UnknownError	string
WaitingOnCertificateOrder	string

ProvisioningState

Status of certificate order.

Name	Type	Description
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

ResourceNotRenewableReason

Reasons why App Service Certificate is not renewable at the current moment.

Name	Type	Description
ExpirationNotInRenewalTimeRange	string
RegistrationStatusNotSupportedForRenewal	string
SubscriptionNotActive	string