Microsoft.Web sites/certificates

Bicep resource definition

The sites/certificates resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Web/sites/certificates resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/sites/certificates@2025-03-01' = {
  parent: resourceSymbolicName
  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/sites/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)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: sites
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 sites/certificates resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Web/sites/certificates resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/sites/certificates",
  "apiVersion": "2025-03-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/sites/certificates

Name Description Value
apiVersion The api version '2025-03-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/sites/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

Terraform (AzAPI provider) resource definition

The sites/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/sites/certificates resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/certificates@2025-03-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/sites/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)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites
properties Certificate resource specific properties CertificateProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Web/sites/certificates@2025-03-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
  • Last updated on