Microsoft.CertificateRegistration certificateOrders

• Latest
• 2024-11-01
• 2024-04-01
• 2023-12-01
• 2023-01-01
• 2022-09-01
• 2022-03-01
• 2021-03-01
• 2021-02-01
• 2021-01-15
• 2021-01-01
• 2020-12-01
• 2020-10-01
• 2020-09-01
• 2020-06-01
• 2019-08-01
• 2018-02-01
• 2015-08-01

Bicep resource definition

The certificateOrders resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Usage Examples

Bicep Samples

A basic example of deploying App Service Certificate Order.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource certificateOrder 'Microsoft.CertificateRegistration/certificateOrders@2021-02-01' = {
  name: resourceName
  location: 'global'
  properties: {
    autoRenew: true
    distinguishedName: 'CN=example.com'
    keySize: 2048
    productType: 'StandardDomainValidatedSsl'
    validityInYears: 1
  }
}

Resource format

To create a Microsoft.CertificateRegistration/certificateOrders resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.CertificateRegistration/certificateOrders@2024-11-01' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    autoRenew: bool
    certificates: {
      {customized property}: {
        keyVaultId: 'string'
        keyVaultSecretName: 'string'
      }
    }
    csr: 'string'
    distinguishedName: 'string'
    keySize: int
    productType: 'string'
    validityInYears: int
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.CertificateRegistration/certificateOrders

Name	Description	Value
kind	Kind of resource	string
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	AppServiceCertificateOrder resource specific properties	AppServiceCertificateOrderProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

AppServiceCertificate

Name	Description	Value
keyVaultId	Key Vault resource Id.	string
keyVaultSecretName	Key Vault secret name.	string

AppServiceCertificateOrderProperties

Name	Description	Value
autoRenew	<code>true</code> if the certificate should be automatically renewed when it expires; otherwise, <code>false</code>.	bool
certificates	State of the Key Vault secret.	AppServiceCertificateOrderPropertiesCertificates
csr	Last CSR that was created for this order.	string
distinguishedName	Certificate distinguished name.	string
keySize	Certificate key size.	int
productType	Certificate product type.	'StandardDomainValidatedSsl' 'StandardDomainValidatedWildCardSsl' (required)
validityInYears	Duration in years (must be 1).	int

AppServiceCertificateOrderPropertiesCertificates

Name	Description	Value

TrackedResourceTags

Name	Description	Value

ARM template resource definition

The certificateOrders resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Create and assign a standard App Service Certificate	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	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

Resource format

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

{
  "type": "Microsoft.CertificateRegistration/certificateOrders",
  "apiVersion": "2024-11-01",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "autoRenew": "bool",
    "certificates": {
      "{customized property}": {
        "keyVaultId": "string",
        "keyVaultSecretName": "string"
      }
    },
    "csr": "string",
    "distinguishedName": "string",
    "keySize": "int",
    "productType": "string",
    "validityInYears": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.CertificateRegistration/certificateOrders

Name	Description	Value
apiVersion	The api version	'2024-11-01'
kind	Kind of resource	string
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	AppServiceCertificateOrder resource specific properties	AppServiceCertificateOrderProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.CertificateRegistration/certificateOrders'

AppServiceCertificate

Name	Description	Value
keyVaultId	Key Vault resource Id.	string
keyVaultSecretName	Key Vault secret name.	string

AppServiceCertificateOrderProperties

Name	Description	Value
autoRenew	<code>true</code> if the certificate should be automatically renewed when it expires; otherwise, <code>false</code>.	bool
certificates	State of the Key Vault secret.	AppServiceCertificateOrderPropertiesCertificates
csr	Last CSR that was created for this order.	string
distinguishedName	Certificate distinguished name.	string
keySize	Certificate key size.	int
productType	Certificate product type.	'StandardDomainValidatedSsl' 'StandardDomainValidatedWildCardSsl' (required)
validityInYears	Duration in years (must be 1).	int

AppServiceCertificateOrderPropertiesCertificates

Name	Description	Value

TrackedResourceTags

Name	Description	Value

Terraform (AzAPI provider) resource definition

The certificateOrders resource type can be deployed with operations that target:

• Resource groups For a list of changed properties in each API version, see change log.

Usage Examples

Terraform Samples

A basic example of deploying App Service Certificate Order.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "certificateOrder" {
  type      = "Microsoft.CertificateRegistration/certificateOrders@2021-02-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = "global"
  body = {
    properties = {
      autoRenew         = true
      distinguishedName = "CN=example.com"
      keySize           = 2048
      productType       = "StandardDomainValidatedSsl"
      validityInYears   = 1
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module	Description
Certificate Orders	AVM Resource Module for Certificate Orders

Resource format

To create a Microsoft.CertificateRegistration/certificateOrders resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CertificateRegistration/certificateOrders@2024-11-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      autoRenew = bool
      certificates = {
        {customized property} = {
          keyVaultId = "string"
          keyVaultSecretName = "string"
        }
      }
      csr = "string"
      distinguishedName = "string"
      keySize = int
      productType = "string"
      validityInYears = int
    }
  }
}

Property Values

Microsoft.CertificateRegistration/certificateOrders

Name	Description	Value
kind	Kind of resource	string
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	AppServiceCertificateOrder resource specific properties	AppServiceCertificateOrderProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.CertificateRegistration/certificateOrders@2024-11-01"

AppServiceCertificate

Name	Description	Value
keyVaultId	Key Vault resource Id.	string
keyVaultSecretName	Key Vault secret name.	string

AppServiceCertificateOrderProperties

Name	Description	Value
autoRenew	<code>true</code> if the certificate should be automatically renewed when it expires; otherwise, <code>false</code>.	bool
certificates	State of the Key Vault secret.	AppServiceCertificateOrderPropertiesCertificates
csr	Last CSR that was created for this order.	string
distinguishedName	Certificate distinguished name.	string
keySize	Certificate key size.	int
productType	Certificate product type.	'StandardDomainValidatedSsl' 'StandardDomainValidatedWildCardSsl' (required)
validityInYears	Duration in years (must be 1).	int

AppServiceCertificateOrderPropertiesCertificates

Name	Description	Value

TrackedResourceTags

Name	Description	Value