PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/?api-version=2023-01-01

Description for Create or update a certificate purchase order.

Servers

https://management.azure.com/

Path parameters

Name	Type	Required	Description
`certificateOrderName`	String	Yes	Name of the certificate order.
`subscriptionId`	String	Yes	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
`resourceGroupName`	String	Yes	Name of the resource group to which the resource belongs.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	Resource Id.
`name`	String	No	Resource Name.
`properties`	Object	No	AppServiceCertificateOrderPatchResource resource specific properties
`properties.distinguishedName`	String	No	Certificate distinguished name.
`properties.root`	Object	No	SSL certificate details.
`properties.root.thumbprint`	String	No	Certificate Thumbprint.
`properties.root.notAfter`	String	No	Date Certificate is valid to.
`properties.root.signatureAlgorithm`	String	No	Certificate Signature algorithm.
`properties.root.version`	Integer	No	Certificate Version.
`properties.root.issuer`	String	No	Certificate Issuer.
`properties.root.subject`	String	No	Certificate Subject.
`properties.root.notBefore`	String	No	Date Certificate is valid from.
`properties.root.serialNumber`	String	No	Certificate Serial Number.
`properties.root.rawData`	String	No	Raw certificate data.
`properties.contact`	Object	No
`properties.contact.email`	String	No
`properties.contact.nameLast`	String	No
`properties.contact.phone`	String	No
`properties.contact.nameFirst`	String	No
`properties.lastCertificateIssuanceTime`	String	No	Certificate last issuance time.
`properties.isPrivateKeyExternal`	Boolean	No	`true` if private key is external; otherwise, `false`.
`properties.signedCertificate`	Object	No	SSL certificate details.
`properties.signedCertificate.thumbprint`	String	No	Certificate Thumbprint.
`properties.signedCertificate.notAfter`	String	No	Date Certificate is valid to.
`properties.signedCertificate.signatureAlgorithm`	String	No	Certificate Signature algorithm.
`properties.signedCertificate.version`	Integer	No	Certificate Version.
`properties.signedCertificate.issuer`	String	No	Certificate Issuer.
`properties.signedCertificate.subject`	String	No	Certificate Subject.
`properties.signedCertificate.notBefore`	String	No	Date Certificate is valid from.
`properties.signedCertificate.serialNumber`	String	No	Certificate Serial Number.
`properties.signedCertificate.rawData`	String	No	Raw certificate data.
`properties.productType`	String	Yes	Certificate product type. Possible values: `"StandardDomainValidatedSsl"` `"StandardDomainValidatedWildCardSsl"`
`properties.status`	String	No	Current order status. Possible values: `"Revoked"` `"Pendingrevocation"` `"Expired"` `"Issued"` `"Pendingissuance"` `"NotSubmitted"` `"Canceled"` `"Denied"` `"PendingRekey"` `"Unused"`
`properties.serialNumber`	String	No	Current serial number of the certificate.
`properties.intermediate`	Object	No	SSL certificate details.
`properties.intermediate.thumbprint`	String	No	Certificate Thumbprint.
`properties.intermediate.notAfter`	String	No	Date Certificate is valid to.
`properties.intermediate.signatureAlgorithm`	String	No	Certificate Signature algorithm.
`properties.intermediate.version`	Integer	No	Certificate Version.
`properties.intermediate.issuer`	String	No	Certificate Issuer.
`properties.intermediate.subject`	String	No	Certificate Subject.
`properties.intermediate.notBefore`	String	No	Date Certificate is valid from.
`properties.intermediate.serialNumber`	String	No	Certificate Serial Number.
`properties.intermediate.rawData`	String	No	Raw certificate data.
`properties.keySize`	Integer	No	Certificate key size. Default value: 2048
`properties.validityInYears`	Integer	No	Duration in years (must be 1). Default value: 1
`properties.autoRenew`	Boolean	No	`true` if the certificate should be automatically renewed when it expires; otherwise, `false`. Default value: true
`properties.domainVerificationToken`	String	No	Domain verification token.
`properties.provisioningState`	String	No	Status of certificate order. Possible values: `"Succeeded"` `"Deleting"` `"Canceled"` `"InProgress"` `"Failed"`
`properties.csr`	String	No	Last CSR that was created for this order.
`properties.certificates`	Object	No	State of the Key Vault secret.
`properties.certificates.name`	Object	No	Key Vault container for a certificate that is purchased through Azure.
`properties.certificates.name.keyVaultId`	String	No	Key Vault resource Id.
`properties.certificates.name.provisioningState`	String	No	Status of the Key Vault secret. Possible values: `"UnknownError"` `"KeyVaultDoesNotExist"` `"Succeeded"` `"CertificateOrderFailed"` `"Initialized"` `"KeyVaultSecretDoesNotExist"` `"Unknown"` `"OperationNotPermittedOnKeyVault"` `"WaitingOnCertificateOrder"` `"AzureServiceUnauthorizedToAccessKeyVault"` `"ExternalPrivateKey"`
`properties.certificates.name.keyVaultSecretName`	String	No	Key Vault secret name.
`properties.appServiceCertificateNotRenewableReasons[]`	Array	No	Reasons why App Service Certificate is not renewable at the current moment.
`properties.expirationTime`	String	No	Certificate expiration time.
`properties.nextAutoRenewalTimeStamp`	String	No	Time stamp when the certificate would be auto renewed next
`type`	String	No	Resource type.
`kind`	String	No	Kind of resource.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.