Microsoft.Web sites/hostNameBindings

Template format

To create a Microsoft.Web/sites/hostNameBindings resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Web/sites/hostNameBindings",
  "apiVersion": "2020-06-01",
  "kind": "string",
  "properties": {
    "siteName": "string",
    "domainId": "string",
    "azureResourceName": "string",
    "azureResourceType": "string",
    "customHostNameDnsRecordType": "string",
    "hostNameType": "string",
    "sslState": "string",
    "thumbprint": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Web/sites/hostNameBindings object

Name Type Required Value
name string Yes Hostname in the hostname binding.
type enum Yes hostNameBindings
-or-
Microsoft.Web/sites/hostNameBindings

See Set name and type for child resources.
apiVersion enum Yes 2020-06-01
kind string No Kind of resource.
properties object Yes HostNameBinding resource specific properties - HostNameBindingProperties object

HostNameBindingProperties object

Name Type Required Value
siteName string No App Service app name.
domainId string No Fully qualified ARM domain resource URI.
azureResourceName string No Azure resource name.
azureResourceType enum No Azure resource type. - Website or TrafficManager
customHostNameDnsRecordType enum No Custom DNS record type. - CName or A
hostNameType enum No Hostname type. - Verified or Managed
sslState enum No SSL type. - Disabled, SniEnabled, IpBasedEnabled
thumbprint string No SSL certificate thumbprint

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Web App with Private Endpoint

Deploy to Azure
This template allows you to create a Web App and expose it through Private Endpoint
Web App with VNet Injection and Private Endpoint.

Deploy to Azure
This template allows you to create a secure end to end solution with two web apps, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint
Web App with a custom domain and optional SSL binding

Deploy to Azure
Create a web app and with a custom domain and optionally add SSL certificate for https encryption.