The Microsoft Azure App Service Certificate Orders API Client is a tool that allows users to easily manage and automate the process of ordering SSL certificates for their web applications hosted on the Azure platform. With this API client, users can securely request and manage SSL certificates directly from the Azure portal, eliminating the need for manual processes and streamlining the certificate ordering and deployment process.
swagger: '2.0'
info:
version: '2023-01-01'
title: Microsoft Azure AppServiceCertificateOrders API Client
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/certificateOrders:
get:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure List All Certificate Orders In A Subscription'
description: Description for List all certificate orders in a subscription.
operationId: microsoftAzureAppservicecertificateordersList
parameters:
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/AppServiceCertificateOrderCollection'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
List App Service Certificate orders by subscription:
$ref: ./examples/ListAppServiceCertificateOrdersBySubscription.json
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation:
post:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Validate Information For A Certificate Order'
description: Description for Validate information for a certificate order.
operationId: microsoftAzureAppservicecertificateordersValidatepurchaseinformation
parameters:
- name: appServiceCertificateOrder
in: body
description: Information for a certificate order.
required: true
schema:
$ref: '#/definitions/AppServiceCertificateOrder'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'204':
description: No Content
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Validate App Service Certificate purchase information by subscription:
$ref: >-
./examples/ValidateAppServiceCertificatePurchaseInformationBySubscription.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders
: get:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Get Certificate Orders In A Resource Group'
description: Description for Get certificate orders in a resource group.
operationId: microsoftAzureAppservicecertificateordersListbyresourcegroup
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/AppServiceCertificateOrderCollection'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
List App Service Certificate orders by resource group:
$ref: ./examples/ListAppServiceCertificateOrdersByResourceGroup.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}
: get:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Get A Certificate Order'
description: Description for Get a certificate order.
operationId: microsoftAzureAppservicecertificateordersGet
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order..
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/AppServiceCertificateOrder'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Get App Service Certificate Order:
$ref: ./examples/GetAppServiceCertificateOrder.json
put:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Create Or Update A Certificate Purchase Order'
description: Description for Create or update a certificate purchase order.
operationId: microsoftAzureAppservicecertificateordersCreateorupdate
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- name: certificateDistinguishedName
in: body
description: Distinguished name to use for the certificate order.
required: true
schema:
$ref: '#/definitions/AppServiceCertificateOrder'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: App Service Certificate Order is created.
schema:
$ref: '#/definitions/AppServiceCertificateOrder'
'201':
description: App Service Certificate Order creation operation is in progress
schema:
$ref: '#/definitions/AppServiceCertificateOrder'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Create Certificate order:
$ref: ./examples/CreateAppServiceCertificateOrder.json
x-ms-long-running-operation: true
delete:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Delete An Existing Certificate Order'
description: Description for Delete an existing certificate order.
operationId: microsoftAzureAppservicecertificateordersDelete
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: Successfully deleted certificate order.
'204':
description: Certificate order does not exist.
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Delete App Service Certificate Order:
$ref: ./examples/DeleteAppServiceCertificateOrder.json
patch:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Create Or Update A Certificate Purchase Order'
description: Description for Create or update a certificate purchase order.
operationId: microsoftAzureAppservicecertificateordersUpdate
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- name: certificateDistinguishedName
in: body
description: Distinguished name to use for the certificate order.
required: true
schema:
$ref: '#/definitions/AppServiceCertificateOrderPatchResource'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: App Service Certificate Order is created.
schema:
$ref: '#/definitions/AppServiceCertificateOrder'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Update Certificate order:
$ref: ./examples/UpdateAppServiceCertificateOrder.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates
: get:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure List All Certificates Associated With A Certificate Order'
description: >-
Description for List all certificates associated with a certificate
order.
operationId: microsoftAzureAppservicecertificateordersListcertificates
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/AppServiceCertificateCollection'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
List certificates by App Service Certificate:
$ref: ./examples/ListCertificatesByAppServiceCertificateOrder.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
: get:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Get The Certificate Associated With A Certificate Order'
description: Description for Get the certificate associated with a certificate order.
operationId: microsoftAzureAppservicecertificateordersGetcertificate
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- name: name
in: path
description: Name of the certificate.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/AppServiceCertificateResource'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Get App Service Certificate:
$ref: ./examples/GetAppServiceCertificate.json
put:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Creates Or Updates A Certificate And Associates With Key Vault Secret'
description: >-
Description for Creates or updates a certificate and associates with key
vault secret.
operationId: microsoftAzureAppservicecertificateordersCreateorupdatecertificate
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- name: name
in: path
description: Name of the certificate.
required: true
type: string
- name: keyVaultCertificate
in: body
description: Key vault certificate resource Id.
required: true
schema:
$ref: '#/definitions/AppServiceCertificateResource'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: App Service Certificate is created.
schema:
$ref: '#/definitions/AppServiceCertificateResource'
'201':
description: App Service Certificate creation operation is in progress
schema:
$ref: '#/definitions/AppServiceCertificateResource'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Create Certificate:
$ref: ./examples/CreateAppServiceCertificate.json
x-ms-long-running-operation: true
delete:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Delete The Certificate Associated With A Certificate Order'
description: >-
Description for Delete the certificate associated with a certificate
order.
operationId: microsoftAzureAppservicecertificateordersDeletecertificate
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- name: name
in: path
description: Name of the certificate.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: Successfully deleted certificate.
'204':
description: Certificate does not exist.
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Delete App Service Certificate:
$ref: ./examples/DeleteAppServiceCertificate.json
patch:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Creates Or Updates A Certificate And Associates With Key Vault Secret'
description: >-
Description for Creates or updates a certificate and associates with key
vault secret.
operationId: microsoftAzureAppservicecertificateordersUpdatecertificate
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- name: name
in: path
description: Name of the certificate.
required: true
type: string
- name: keyVaultCertificate
in: body
description: Key vault certificate resource Id.
required: true
schema:
$ref: '#/definitions/AppServiceCertificatePatchResource'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: App Service Certificate is created.
schema:
$ref: '#/definitions/AppServiceCertificateResource'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Update Certificate:
$ref: ./examples/UpdateAppServiceCertificate.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/reissue
: post:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Reissue An Existing Certificate Order'
description: Description for Reissue an existing certificate order.
operationId: microsoftAzureAppservicecertificateordersReissue
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- name: reissueCertificateOrderRequest
in: body
description: Parameters for the reissue.
required: true
schema:
$ref: '#/definitions/ReissueCertificateOrderRequest'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'204':
description: No Content
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Reissue App Service Certificate Order:
$ref: ./examples/ReissueAppServiceCertificateOrder.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/renew
: post:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Renew An Existing Certificate Order'
description: Description for Renew an existing certificate order.
operationId: microsoftAzureAppservicecertificateordersRenew
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- name: renewCertificateOrderRequest
in: body
description: Renew parameters
required: true
schema:
$ref: '#/definitions/RenewCertificateOrderRequest'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'204':
description: No Content
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Renew App Service Certificate Order:
$ref: ./examples/RenewAppServiceCertificateOrder.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/resendEmail
: post:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Resend Certificate Email'
description: Description for Resend certificate email.
operationId: microsoftAzureAppservicecertificateordersResendemail
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'204':
description: No Content
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Resend App Service Certificate Order email:
$ref: ./examples/ResendAppServiceCertificateOrderEmail.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/resendRequestEmails
: post:
tags:
- AppServiceCertificateOrders
summary: Microsoft Azure Resend Domain Verification Email To Customer For This Certificate Order
description: >-
Resend domain verification ownership email containing steps on how to
verify a domain for a given certificate order
operationId: microsoftAzureAppservicecertificateordersResendrequestemails
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- name: nameIdentifier
in: body
description: Email address
required: true
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/NameIdentifier
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'204':
description: No Content
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Resend Domain Ownership verification email:
$ref: ./examples/ResendDomainOwnershipVerificationEmail.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/retrieveSiteSeal
: post:
tags:
- AppServiceCertificateOrders
summary: >-
Microsoft Azure This Method Is Used To Obtain The Site Seal Information For An Issued Certificate
description: >-
This method is used to obtain the site seal information for an issued
certificate. A site seal is a graphic that the certificate purchaser can
embed on their web site to show their visitors information about their
SSL certificate. If a web site visitor clicks on the site seal image, a
pop-up page is displayed that contains detailed information about the
SSL certificate. The site seal token is used to link the site seal
graphic image to the appropriate certificate details pop-up page display
when a user clicks on the site seal. The site seal images are expected
to be static images and hosted by the reseller, to minimize delays for
customer page load times.
operationId: microsoftAzureAppservicecertificateordersRetrievesiteseal
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- name: siteSealRequest
in: body
description: Site seal request.
required: true
schema:
$ref: '#/definitions/SiteSealRequest'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SiteSeal'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Retrieve Site Seal:
$ref: ./examples/RetrieveSiteSeal.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/verifyDomainOwnership
: post:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Verify Domain Ownership For This Certificate Order'
description: Description for Verify domain ownership for this certificate order.
operationId: microsoftAzureAppservicecertificateordersVerifydomainownership
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: certificateOrderName
in: path
description: Name of the certificate order.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'204':
description: No Content
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Verify Domain Ownership:
$ref: ./examples/VerifyDomainOwnership.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveCertificateActions
: post:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Retrieve The List Of Certificate Actions'
description: Description for Retrieve the list of certificate actions.
operationId: microsoftAzureAppservicecertificateordersRetrievecertificateactions
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: name
in: path
description: Name of the certificate order.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/CertificateOrderAction'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Retrieve Certificate Order Actions:
$ref: ./examples/RetrieveCertificateOrderActions.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveEmailHistory
: post:
tags:
- AppServiceCertificateOrders
summary: 'Microsoft Azure Retrieve Email History'
description: Description for Retrieve email history.
operationId: microsoftAzureAppservicecertificateordersRetrievecertificateemailhistory
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: name
in: path
description: Name of the certificate order.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/CertificateEmail'
default:
description: App Service error response.
schema:
$ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
x-ms-examples:
Retrieve Certificate Email History:
$ref: ./examples/RetrieveCertificateEmailHistory.json
definitions:
AppServiceCertificate:
description: Key Vault container for a certificate that is purchased through Azure.
type: object
properties:
keyVaultId:
description: Key Vault resource Id.
type: string
keyVaultSecretName:
description: Key Vault secret name.
type: string
provisioningState:
description: Status of the Key Vault secret.
enum:
- Initialized
- WaitingOnCertificateOrder
- Succeeded
- CertificateOrderFailed
- OperationNotPermittedOnKeyVault
- AzureServiceUnauthorizedToAccessKeyVault
- KeyVaultDoesNotExist
- KeyVaultSecretDoesNotExist
- UnknownError
- ExternalPrivateKey
- Unknown
type: string
readOnly: true
x-ms-enum:
name: KeyVaultSecretStatus
modelAsString: false
AppServiceCertificateCollection:
description: Collection of certificate order certificates.
required:
- value
type: object
properties:
value:
description: Collection of resources.
type: array
items:
$ref: '#/definitions/AppServiceCertificateResource'
nextLink:
description: Link to next page of resources.
type: string
readOnly: true
AppServiceCertificateOrder:
description: SSL certificate purchase order.
type: object
allOf:
- $ref: >-
../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/Resource
properties:
properties:
description: AppServiceCertificateOrder resource specific properties
required:
- productType
type: object
properties:
certificates:
description: State of the Key Vault secret.
type: object
additionalProperties:
$ref: '#/definitions/AppServiceCertificate'
distinguishedName:
description: Certificate distinguished name.
type: string
x-ms-mutability:
- create
- read
domainVerificationToken:
description: Domain verification token.
type: string
readOnly: true
validityInYears:
format: int32
description: Duration in years (must be 1).
default: 1
type: integer
x-ms-mutability:
- create
- read
keySize:
format: int32
description: Certificate key size.
default: 2048
type: integer
x-ms-mutability:
- create
- read
productType:
description: Certificate product type.
enum:
- StandardDomainValidatedSsl
- StandardDomainValidatedWildCardSsl
type: string
x-ms-enum:
name: CertificateProductType
modelAsString: false
x-ms-mutability:
- create
- read
autoRenew:
description: >-
<code>true</code> if the certificate should be automatically
renewed when it expires; otherwise, <code>false</code>.
default: true
type: boolean
provisioningState:
description: Status of certificate order.
enum:
- Succeeded
- Failed
- Canceled
- InProgress
- Deleting
type: string
readOnly: true
x-ms-enum:
name: ProvisioningState
modelAsString: false
status:
description: Current order status.
enum:
- Pendingissuance
- Issued
- Revoked
- Canceled
- Denied
- Pendingrevocation
- PendingRekey
- Unused
- Expired
- NotSubmitted
type: string
readOnly: true
x-ms-enum:
name: CertificateOrderStatus
modelAsString: false
signedCertificate:
$ref: '#/definitions/CertificateDetails'
description: Signed certificate.
readOnly: true
csr:
description: Last CSR that was created for this order.
type: string
x-ms-mutability:
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/appservicecertificateorders-api-client-openapi-original.yml