Microsoft.Web hostingEnvironments/configurations 'customdnssuffix' 2022-03-01

  • Article

Bicep resource definition

The hostingEnvironments/configurations resource type can be deployed with operations that target:

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

Options for name property

The hostingEnvironments/configurations resource accepts different properties based on the value of the name property. This article shows the properties that are available when you set name: 'customdnssuffix'.

For other options, see:

Resource format

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

resource symbolicname 'Microsoft.Web/hostingEnvironments/configurations@2022-03-01' = {
  name: 'customdnssuffix'
  kind: 'string'
  parent: resourceSymbolicName
  properties: {
    certificateUrl: 'string'
    dnsSuffix: 'string'
    keyVaultReferenceIdentity: 'string'
  }
}

Property values

hostingEnvironments/configurations-customdnssuffix

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 'customdnssuffix'
kind Kind of resource. string
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: hostingEnvironments
properties CustomDnsSuffixConfiguration resource specific properties CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

Name Description Value
certificateUrl The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. string
dnsSuffix The default custom domain suffix to use for all sites deployed on the ASE. string
keyVaultReferenceIdentity The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. string

ARM template resource definition

The hostingEnvironments/configurations resource type can be deployed with operations that target:

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

Options for name property

The hostingEnvironments/configurations resource accepts different properties based on the value of the name property. This article shows the properties that are available when you set name: 'customdnssuffix'.

For other options, see:

Resource format

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

{
  "type": "Microsoft.Web/hostingEnvironments/configurations",
  "apiVersion": "2022-03-01",
  "name": "customdnssuffix",
  "kind": "string",
  "properties": {
    "certificateUrl": "string",
    "dnsSuffix": "string",
    "keyVaultReferenceIdentity": "string"
  }
}

Property values

hostingEnvironments/configurations-customdnssuffix

Name Description Value
type The resource type 'Microsoft.Web/hostingEnvironments/configurations'
apiVersion The resource api version '2022-03-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 'customdnssuffix'
kind Kind of resource. string
properties CustomDnsSuffixConfiguration resource specific properties CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

Name Description Value
certificateUrl The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. string
dnsSuffix The default custom domain suffix to use for all sites deployed on the ASE. string
keyVaultReferenceIdentity The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. string

Terraform (AzAPI provider) resource definition

The hostingEnvironments/configurations resource type can be deployed with operations that target:

  • Resource groups

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

Options for name property

The hostingEnvironments/configurations resource accepts different properties based on the value of the name property. This article shows the properties that are available when you set name: 'customdnssuffix'.

For other options, see:

Resource format

To create a Microsoft.Web/hostingEnvironments/configurations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/hostingEnvironments/configurations@2022-03-01"
  name = "customdnssuffix"
  parent_id = "string"
  body = jsonencode({
    properties = {
      certificateUrl = "string"
      dnsSuffix = "string"
      keyVaultReferenceIdentity = "string"
    }
    kind = "string"
  })
}

Property values

hostingEnvironments/configurations-customdnssuffix

Name Description Value
type The resource type "Microsoft.Web/hostingEnvironments/configurations@2022-03-01"
name The resource name "customdnssuffix"
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: hostingEnvironments
kind Kind of resource. string
properties CustomDnsSuffixConfiguration resource specific properties CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

Name Description Value
certificateUrl The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. string
dnsSuffix The default custom domain suffix to use for all sites deployed on the ASE. string
keyVaultReferenceIdentity The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. string