Microsoft.Web sites/hostNameBindings
Bicep resource definition
The sites/hostNameBindings resource type can be deployed to:
- 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@2022-03-01' = {
name: 'string'
kind: 'string'
parent: resourceSymbolicName
properties: {
azureResourceName: 'string'
azureResourceType: 'string'
customHostNameDnsRecordType: 'string'
domainId: 'string'
hostNameType: 'string'
siteName: 'string'
sslState: 'string'
thumbprint: 'string'
}
}
Property values
sites/hostNameBindings
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| 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: sites |
| properties | HostNameBinding resource specific properties | HostNameBindingProperties |
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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Web App with Private Endpoint |
This template allows you to create a Web App and expose it through 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 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 to:
- 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": "2022-03-01",
"name": "string",
"kind": "string",
"properties": {
"azureResourceName": "string",
"azureResourceType": "string",
"customHostNameDnsRecordType": "string",
"domainId": "string",
"hostNameType": "string",
"siteName": "string",
"sslState": "string",
"thumbprint": "string"
}
}
Property values
sites/hostNameBindings
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Web/sites/hostNameBindings' |
| 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. |
string (required) |
| kind | Kind of resource. | string |
| properties | HostNameBinding resource specific properties | HostNameBindingProperties |
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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Web App with Private Endpoint |
This template allows you to create a Web App and expose it through 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 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 to:
- 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@2022-03-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
azureResourceName = "string"
azureResourceType = "string"
customHostNameDnsRecordType = "string"
domainId = "string"
hostNameType = "string"
siteName = "string"
sslState = "string"
thumbprint = "string"
}
kind = "string"
})
}
Property values
sites/hostNameBindings
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Web/sites/hostNameBindings@2022-03-01" |
| 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 |
| kind | Kind of resource. | string |
| properties | HostNameBinding resource specific properties | HostNameBindingProperties |
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 |