Microsoft.Web hostingEnvironments/configurations 2023-12-01
Bicep resource definition
The hostingEnvironments/configurations 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/hostingEnvironments/configurations resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/hostingEnvironments/configurations@2023-12-01' = {
name: 'string'
// For remaining properties, see microsoft.web/hostingenvironments/configurations objects
}
microsoft.web/hostingenvironments/configurations objects
Set the name property to specify the type of object.
For customdnssuffix, use:
{
kind: 'string'
name: 'customdnssuffix'
properties: {
certificateUrl: 'string'
dnsSuffix: 'string'
keyVaultReferenceIdentity: 'string'
}
}
For networking, use:
{
kind: 'string'
name: 'networking'
properties: {
allowNewPrivateEndpointConnections: bool
ftpEnabled: bool
inboundIpAddressOverride: 'string'
remoteDebugEnabled: bool
}
}
Property values
AseV3NetworkingConfigurationProperties
| Name | Description | Value |
|---|---|---|
| allowNewPrivateEndpointConnections | Property to enable and disable new private endpoint connection creation on ASE | bool |
| ftpEnabled | Property to enable and disable FTP on ASEV3 | bool |
| inboundIpAddressOverride | Customer provided Inbound IP Address. Only able to be set on Ase create. | string |
| remoteDebugEnabled | Property to enable and disable Remote Debug on ASEV3 | bool |
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 |
microsoft.web/hostingenvironments/configurations
| Name | Description | Value |
|---|---|---|
| name | Set to 'customdnssuffix' for type Microsoft.Web/hostingEnvironments/configurations. Set to 'networking' for type Microsoft.Web/hostingEnvironments/configurations. | 'customdnssuffix' 'networking' (required) |
Microsoft.Web/hostingEnvironments/configurations
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| name | The resource name | 'customdnssuffix' (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: hostingEnvironments |
| properties | CustomDnsSuffixConfiguration resource specific properties | CustomDnsSuffixConfigurationProperties |
Microsoft.Web/hostingEnvironments/configurations
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| name | The resource name | 'networking' (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: hostingEnvironments |
| properties | AseV3NetworkingConfiguration resource specific properties | AseV3NetworkingConfigurationProperties |
ARM template resource definition
The hostingEnvironments/configurations 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/hostingEnvironments/configurations resource, add the following JSON to your template.
{
"name": "string"
// For remaining properties, see microsoft.web/hostingenvironments/configurations objects
}
microsoft.web/hostingenvironments/configurations objects
Set the name property to specify the type of object.
For customdnssuffix, use:
{
"kind": "string",
"name": "customdnssuffix",
"properties": {
"certificateUrl": "string",
"dnsSuffix": "string",
"keyVaultReferenceIdentity": "string"
}
}
For networking, use:
{
"kind": "string",
"name": "networking",
"properties": {
"allowNewPrivateEndpointConnections": "bool",
"ftpEnabled": "bool",
"inboundIpAddressOverride": "string",
"remoteDebugEnabled": "bool"
}
}
Property values
AseV3NetworkingConfigurationProperties
| Name | Description | Value |
|---|---|---|
| allowNewPrivateEndpointConnections | Property to enable and disable new private endpoint connection creation on ASE | bool |
| ftpEnabled | Property to enable and disable FTP on ASEV3 | bool |
| inboundIpAddressOverride | Customer provided Inbound IP Address. Only able to be set on Ase create. | string |
| remoteDebugEnabled | Property to enable and disable Remote Debug on ASEV3 | bool |
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 |
microsoft.web/hostingenvironments/configurations
| Name | Description | Value |
|---|---|---|
| name | Set to 'customdnssuffix' for type Microsoft.Web/hostingEnvironments/configurations. Set to 'networking' for type Microsoft.Web/hostingEnvironments/configurations. | 'customdnssuffix' 'networking' (required) |
Microsoft.Web/hostingEnvironments/configurations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-12-01' |
| kind | Kind of resource. | string |
| name | The resource name | 'customdnssuffix' (required) |
| properties | CustomDnsSuffixConfiguration resource specific properties | CustomDnsSuffixConfigurationProperties |
| type | The resource type | 'Microsoft.Web/hostingEnvironments/configurations' |
Microsoft.Web/hostingEnvironments/configurations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-12-01' |
| kind | Kind of resource. | string |
| name | The resource name | 'networking' (required) |
| properties | AseV3NetworkingConfiguration resource specific properties | AseV3NetworkingConfigurationProperties |
| type | The resource type | 'Microsoft.Web/hostingEnvironments/configurations' |
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.
Resource format
To create a Microsoft.Web/hostingEnvironments/configurations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
name = "string"
// For remaining properties, see microsoft.web/hostingenvironments/configurations objects
}
microsoft.web/hostingenvironments/configurations objects
Set the name property to specify the type of object.
For customdnssuffix, use:
{
kind = "string"
name = "customdnssuffix"
properties = {
certificateUrl = "string"
dnsSuffix = "string"
keyVaultReferenceIdentity = "string"
}
}
For networking, use:
{
kind = "string"
name = "networking"
properties = {
allowNewPrivateEndpointConnections = bool
ftpEnabled = bool
inboundIpAddressOverride = "string"
remoteDebugEnabled = bool
}
}
Property values
AseV3NetworkingConfigurationProperties
| Name | Description | Value |
|---|---|---|
| allowNewPrivateEndpointConnections | Property to enable and disable new private endpoint connection creation on ASE | bool |
| ftpEnabled | Property to enable and disable FTP on ASEV3 | bool |
| inboundIpAddressOverride | Customer provided Inbound IP Address. Only able to be set on Ase create. | string |
| remoteDebugEnabled | Property to enable and disable Remote Debug on ASEV3 | bool |
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 |
microsoft.web/hostingenvironments/configurations
| Name | Description | Value |
|---|---|---|
| name | Set to 'customdnssuffix' for type Microsoft.Web/hostingEnvironments/configurations. Set to 'networking' for type Microsoft.Web/hostingEnvironments/configurations. | 'customdnssuffix' 'networking' (required) |
Microsoft.Web/hostingEnvironments/configurations
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| name | The resource name | 'customdnssuffix' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: hostingEnvironments |
| properties | CustomDnsSuffixConfiguration resource specific properties | CustomDnsSuffixConfigurationProperties |
| type | The resource type | "Microsoft.Web/hostingEnvironments/configurations@2023-12-01" |
Microsoft.Web/hostingEnvironments/configurations
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| name | The resource name | 'networking' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: hostingEnvironments |
| properties | AseV3NetworkingConfiguration resource specific properties | AseV3NetworkingConfigurationProperties |
| type | The resource type | "Microsoft.Web/hostingEnvironments/configurations@2023-12-01" |