Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The certificates 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.Web/certificates resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/certificates@2024-11-01' = {
kind: 'string'
location: 'string'
name: 'string'
properties: {
canonicalName: 'string'
domainValidationMethod: 'string'
hostNames: [
'string'
]
keyVaultId: 'string'
keyVaultSecretName: 'string'
password: 'string'
pfxBlob: any(...)
serverFarmId: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Web/certificates
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. | string |
| location | Resource Location. | string (required) |
| name | The resource name | string (required) |
| properties | Certificate resource specific properties | CertificateProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
CertificateProperties
| Name | Description | Value |
|---|---|---|
| canonicalName | CNAME of the certificate to be issued via free certificate | string |
| domainValidationMethod | Method of domain validation for free cert | string |
| hostNames | Host names the certificate applies to. | string[] |
| keyVaultId | Azure Key Vault Csm resource Id. | string |
| keyVaultSecretName | Azure Key Vault secret name. | string |
| password | Certificate password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| pfxBlob | Pfx blob. | any |
| serverFarmId | Resource ID of the associated App Service plan. | string |
ResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The certificates 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.Web/certificates resource, add the following JSON to your template.
{
"type": "Microsoft.Web/certificates",
"apiVersion": "2024-11-01",
"name": "string",
"kind": "string",
"location": "string",
"properties": {
"canonicalName": "string",
"domainValidationMethod": "string",
"hostNames": [ "string" ],
"keyVaultId": "string",
"keyVaultSecretName": "string",
"password": "string",
"pfxBlob": {},
"serverFarmId": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Web/certificates
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-11-01' |
| kind | Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. | string |
| location | Resource Location. | string (required) |
| name | The resource name | string (required) |
| properties | Certificate resource specific properties | CertificateProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Web/certificates' |
CertificateProperties
| Name | Description | Value |
|---|---|---|
| canonicalName | CNAME of the certificate to be issued via free certificate | string |
| domainValidationMethod | Method of domain validation for free cert | string |
| hostNames | Host names the certificate applies to. | string[] |
| keyVaultId | Azure Key Vault Csm resource Id. | string |
| keyVaultSecretName | Azure Key Vault secret name. | string |
| password | Certificate password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| pfxBlob | Pfx blob. | any |
| serverFarmId | Resource ID of the associated App Service plan. | string |
ResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a App Services Managed Certificate |
Create Managed Certificate (Free) APEX (root domain) for WebApp |
| 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 |
| SSL certificate for an ILB ASE or an ILB ASE v2 |
Configures the default SSL certificate for an ILB ASE or an ILB ASE v2 |
| Web App integration with Key Vault |
Deploy a Web App certificate from Key Vault secret and use it for creating SSL binding |
| Web App with a custom domain and optional SSL binding |
Create a web app and with a custom domain and optionally add SSL certificate for https encryption. |
Terraform (AzAPI provider) resource definition
The certificates 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.Web/certificates resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/certificates@2024-11-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
properties = {
canonicalName = "string"
domainValidationMethod = "string"
hostNames = [
"string"
]
keyVaultId = "string"
keyVaultSecretName = "string"
password = "string"
pfxBlob = ?
serverFarmId = "string"
}
}
}
Property Values
Microsoft.Web/certificates
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. | string |
| location | Resource Location. | string (required) |
| name | The resource name | string (required) |
| properties | Certificate resource specific properties | CertificateProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Web/certificates@2024-11-01" |
CertificateProperties
| Name | Description | Value |
|---|---|---|
| canonicalName | CNAME of the certificate to be issued via free certificate | string |
| domainValidationMethod | Method of domain validation for free cert | string |
| hostNames | Host names the certificate applies to. | string[] |
| keyVaultId | Azure Key Vault Csm resource Id. | string |
| keyVaultSecretName | Azure Key Vault secret name. | string |
| password | Certificate password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| pfxBlob | Pfx blob. | any |
| serverFarmId | Resource ID of the associated App Service plan. | string |
ResourceTags
| Name | Description | Value |
|---|