Microsoft.CertificateRegistration certificateOrders template reference

Template format

To create a Microsoft.CertificateRegistration/certificateOrders resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.CertificateRegistration/certificateOrders",
  "apiVersion": "2019-08-01",
  "kind": "string",
  "location": "string",
  "tags": {},
  "properties": {
    "certificates": {},
    "distinguishedName": "string",
    "validityInYears": "integer",
    "keySize": "integer",
    "productType": "string",
    "autoRenew": "boolean",
    "csr": "string"
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.CertificateRegistration/certificateOrders object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Name of the certificate order.
type enum Yes For JSON - Microsoft.CertificateRegistration/certificateOrders
apiVersion enum Yes For JSON - 2019-08-01
kind string No Kind of resource.
location string Yes Resource Location.
tags object No Resource tags.
properties object Yes AppServiceCertificateOrder resource specific properties - AppServiceCertificateOrderProperties object
resources array No certificates

AppServiceCertificateOrderProperties object

Name Type Required Value
certificates object No State of the Key Vault secret.
distinguishedName string No Certificate distinguished name.
validityInYears integer No Duration in years (must be between 1 and 3).
keySize integer No Certificate key size.
productType enum Yes Certificate product type. - StandardDomainValidatedSsl or StandardDomainValidatedWildCardSsl
autoRenew boolean No true if the certificate should be automatically renewed when it expires; otherwise, false.
csr string No Last CSR that was created for this order.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create and assign a standard App Service Certificate

Deploy to Azure
Creates a standard App Service Certificate, verifies it using an App service App and creates SSL bindings once the certificate is ready
Create and assign a wildcard App Service Certificate

Deploy to Azure
Creates a wildcard App Service Certificate, verifies it using an App service Domain and creates SSL bindings on an App Service App once the certificate is ready