Microsoft.CertificateRegistration certificateOrders 2022-03-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.
Resource format
To create a Microsoft.CertificateRegistration/certificateOrders resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.CertificateRegistration/certificateOrders@2022-03-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
properties: {
autoRenew: bool
certificates: {}
csr: 'string'
distinguishedName: 'string'
keySize: int
productType: 'string'
validityInYears: int
}
}
Property values
certificateOrders
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 3-30 Valid characters: Alphanumerics. |
| location | Resource Location. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| kind | Kind of resource. | string |
| properties | AppServiceCertificateOrder resource specific properties | AppServiceCertificateOrderProperties |
AppServiceCertificateOrderProperties
| Name | Description | Value |
|---|---|---|
| autoRenew | true if the certificate should be automatically renewed when it expires; otherwise, false. |
bool |
| certificates | State of the Key Vault secret. | object |
| 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 |
Quickstart templates
The following 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 |
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.
Resource format
To create a Microsoft.CertificateRegistration/certificateOrders resource, add the following JSON to your template.
{
"type": "Microsoft.CertificateRegistration/certificateOrders",
"apiVersion": "2022-03-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"properties": {
"autoRenew": "bool",
"certificates": {},
"csr": "string",
"distinguishedName": "string",
"keySize": "int",
"productType": "string",
"validityInYears": "int"
}
}
Property values
certificateOrders
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.CertificateRegistration/certificateOrders' |
| apiVersion | The resource api version | '2022-03-01' |
| name | The resource name | string (required) Character limit: 3-30 Valid characters: Alphanumerics. |
| location | Resource Location. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| kind | Kind of resource. | string |
| properties | AppServiceCertificateOrder resource specific properties | AppServiceCertificateOrderProperties |
AppServiceCertificateOrderProperties
| Name | Description | Value |
|---|---|---|
| autoRenew | true if the certificate should be automatically renewed when it expires; otherwise, false. |
bool |
| certificates | State of the Key Vault secret. | object |
| 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 |
Quickstart templates
The following 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 |
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.
Resource format
To create a Microsoft.CertificateRegistration/certificateOrders resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.CertificateRegistration/certificateOrders@2022-03-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
autoRenew = bool
certificates = {}
csr = "string"
distinguishedName = "string"
keySize = int
productType = "string"
validityInYears = int
}
kind = "string"
})
}
Property values
certificateOrders
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.CertificateRegistration/certificateOrders@2022-03-01" |
| name | The resource name | string (required) Character limit: 3-30 Valid characters: Alphanumerics. |
| location | Resource Location. | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| kind | Kind of resource. | string |
| properties | AppServiceCertificateOrder resource specific properties | AppServiceCertificateOrderProperties |
AppServiceCertificateOrderProperties
| Name | Description | Value |
|---|---|---|
| autoRenew | true if the certificate should be automatically renewed when it expires; otherwise, false. |
bool |
| certificates | State of the Key Vault secret. | object |
| 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 |