Microsoft.Web sites/hostNameBindings 2023-12-01

• Latest
• 2024-04-01
• 2023-12-01
• 2023-01-01
• 2022-09-01
• 2022-03-01
• 2021-03-01
• 2021-02-01
• 2021-01-15
• 2021-01-01
• 2020-12-01
• 2020-10-01
• 2020-09-01
• 2020-06-01
• 2019-08-01
• 2018-11-01
• 2018-02-01
• 2016-08-01
• 2015-08-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Web/sites/hostNameBindings@2023-12-01' = {
  kind: 'string'
  name: 'string'
  properties: {
    azureResourceName: 'string'
    azureResourceType: 'string'
    customHostNameDnsRecordType: 'string'
    domainId: 'string'
    hostNameType: 'string'
    siteName: 'string'
    sslState: 'string'
    thumbprint: 'string'
  }
}

Property values

HostNameBindingProperties

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

Microsoft.Web/sites/hostNameBindings

Name	Description	Value
kind	Kind of resource.	string
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	HostNameBinding resource specific properties	HostNameBindingProperties

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Moesif API Analytics and Monetization	The template will log API calls from Azure API Management to Moesif API analytics and monetization platform
Secure N-tier Web App	This template allows you to create a secure end to end solution with two web apps with staging slots, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint
Web App with VNet Injection and Private Endpoint	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

ARM template resource definition

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

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

Property values

HostNameBindingProperties

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

Microsoft.Web/sites/hostNameBindings

Name	Description	Value
apiVersion	The api version	'2023-12-01'
kind	Kind of resource.	string
name	The resource name	string (required)
properties	HostNameBinding resource specific properties	HostNameBindingProperties
type	The resource type	'Microsoft.Web/sites/hostNameBindings'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Moesif API Analytics and Monetization	The template will log API calls from Azure API Management to Moesif API analytics and monetization platform
Secure N-tier Web App	This template allows you to create a secure end to end solution with two web apps with staging slots, 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	Create a web app and with a custom domain and optionally add SSL certificate for https encryption.
Web App with Private Endpoint	This template allows you to create a Web App and expose it through Private Endpoint
Web App with VNet Injection and Private Endpoint	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

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/hostNameBindings@2023-12-01"
  name = "string"
  kind = "string"
  body = jsonencode({
    properties = {
      azureResourceName = "string"
      azureResourceType = "string"
      customHostNameDnsRecordType = "string"
      domainId = "string"
      hostNameType = "string"
      siteName = "string"
      sslState = "string"
      thumbprint = "string"
    }
  })
}

Property values

HostNameBindingProperties

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

Microsoft.Web/sites/hostNameBindings

Name	Description	Value
kind	Kind of resource.	string
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	HostNameBinding resource specific properties	HostNameBindingProperties
type	The resource type	"Microsoft.Web/sites/hostNameBindings@2023-12-01"