你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Web hostingEnvironments
Bicep 资源定义
可以使用目标操作部署 hostingEnvironments 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Web/hostingEnvironments 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Web/hostingEnvironments@2024-04-01' = {
kind: 'string'
location: 'string'
name: 'string'
properties: {
clusterSettings: [
{
name: 'string'
value: 'string'
}
]
customDnsSuffixConfiguration: {
kind: 'string'
properties: {
certificateUrl: 'string'
dnsSuffix: 'string'
keyVaultReferenceIdentity: 'string'
}
}
dedicatedHostCount: int
dnsSuffix: 'string'
frontEndScaleFactor: int
internalLoadBalancingMode: 'string'
ipsslAddressCount: int
multiSize: 'string'
networkingConfiguration: {
kind: 'string'
properties: {
allowNewPrivateEndpointConnections: bool
ftpEnabled: bool
inboundIpAddressOverride: 'string'
remoteDebugEnabled: bool
}
}
upgradePreference: 'string'
userWhitelistedIpRanges: [
'string'
]
virtualNetwork: {
id: 'string'
subnet: 'string'
}
zoneRedundant: bool
}
tags: {
{customized property}: 'string'
}
}
属性值
AppServiceEnvironment
| 名字 | 描述 | 价值 |
|---|---|---|
| clusterSettings | 用于更改应用服务环境的行为的自定义设置。 | NameValuePair[] |
| customDnsSuffixConfiguration | ASEv3 的自定义域后缀配置的完整视图。 | CustomDnsSuffixConfiguration |
| dedicatedHostCount | 专用主机计数 | int |
| dnsSuffix | 应用服务环境的 DNS 后缀。 | 字符串 |
| frontEndScaleFactor | 前端的缩放因子。 | int |
| internalLoadBalancingMode | 指定要在应用服务环境的虚拟网络中内部提供服务的终结点。 | “None” “Publishing” “Web” “Web， 发布” |
| ipsslAddressCount | 为应用服务环境保留的 IP SSL 地址数。 | int |
| multiSize | 前端 VM 大小，例如“中型”、“大型”。 | 字符串 |
| networkingConfiguration | ASE 的网络配置的完整视图。 | AseV3NetworkingConfiguration |
| upgradePreference | 升级首选项 | “Early” “Late” “Manual” “None” |
| userWhitelistedIpRanges | 用户向 ASE db 上的允许列表添加了 IP 范围 | string[] |
| virtualNetwork | 虚拟网络的说明。 | VirtualNetworkProfile（必需） |
| zoneRedundant | 此应用服务环境是否为区域冗余。 | bool |
AseV3NetworkingConfiguration
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 资源类型。 | 字符串 |
| 性能 | AseV3NetworkingConfiguration 资源特定属性 | AseV3NetworkingConfigurationProperties |
AseV3NetworkingConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| allowNewPrivateEndpointConnections | 用于在 ASE 上启用和禁用新的专用终结点连接创建的属性 | bool |
| ftpEnabled | 在 ASEV3 上启用或禁用 FTP 的属性 | bool |
| inboundIpAddressOverride | 客户提供入站 IP 地址。 只能在 Ase create 上设置。 | 字符串 |
| remoteDebugEnabled | 在 ASEV3 上启用或禁用远程调试的属性 | bool |
CustomDnsSuffixConfiguration
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 资源类型。 | 字符串 |
| 性能 | CustomDnsSuffixConfiguration 资源特定属性 | CustomDnsSuffixConfigurationProperties |
CustomDnsSuffixConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| certificateUrl | 引用 Azure Key Vault 证书机密的 URL，该机密应用作具有自定义域后缀的网站的默认 SSL/TLS 证书。 | 字符串 |
| dnsSuffix | 用于 ASE 上部署的所有站点的默认自定义域后缀。 | 字符串 |
| keyVaultReferenceIdentity | 用于解析密钥保管库证书引用的用户分配标识。 如果未指定，将使用系统分配的 ASE 标识（如果可用）。 | 字符串 |
Microsoft.Web/hostingEnvironments
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 资源类型。 如果资源是应用，可以参考 https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference 了解类型支持的详细信息值。 | 字符串 |
| 位置 | 资源位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 核心资源属性 | AppServiceEnvironment |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
NameValuePair
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 配对名称。 | 字符串 |
| 价值 | 对值。 | 字符串 |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
VirtualNetworkProfile
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 虚拟网络的资源 ID。 | string （必需） |
| 子 | 虚拟网络中的子网。 | 字符串 |
快速入门示例
以下快速入门示例部署此资源类型。
| Bicep 文件 | 描述 |
|---|---|
| 使用托管计划和 Azure WebApp |
在现有虚拟网络中创建具有 ILB 地址的应用服务环境 v2，该虚拟网络将可用。 应用服务环境将包含托管计划和 Azure Web 应用 |
| 创建应用服务环境 v2 | 在虚拟网络中创建应用服务环境 v2 |
| ASEv3 中创建 AppServicePlan 和应用 | 在 ASEv3 中创建 AppServicePlan 和 App |
ARM 模板资源定义
可以使用目标操作部署 hostingEnvironments 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Web/hostingEnvironments 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Web/hostingEnvironments",
"apiVersion": "2024-04-01",
"name": "string",
"kind": "string",
"location": "string",
"properties": {
"clusterSettings": [
{
"name": "string",
"value": "string"
}
],
"customDnsSuffixConfiguration": {
"kind": "string",
"properties": {
"certificateUrl": "string",
"dnsSuffix": "string",
"keyVaultReferenceIdentity": "string"
}
},
"dedicatedHostCount": "int",
"dnsSuffix": "string",
"frontEndScaleFactor": "int",
"internalLoadBalancingMode": "string",
"ipsslAddressCount": "int",
"multiSize": "string",
"networkingConfiguration": {
"kind": "string",
"properties": {
"allowNewPrivateEndpointConnections": "bool",
"ftpEnabled": "bool",
"inboundIpAddressOverride": "string",
"remoteDebugEnabled": "bool"
}
},
"upgradePreference": "string",
"userWhitelistedIpRanges": [ "string" ],
"virtualNetwork": {
"id": "string",
"subnet": "string"
},
"zoneRedundant": "bool"
},
"tags": {
"{customized property}": "string"
}
}
属性值
AppServiceEnvironment
| 名字 | 描述 | 价值 |
|---|---|---|
| clusterSettings | 用于更改应用服务环境的行为的自定义设置。 | NameValuePair[] |
| customDnsSuffixConfiguration | ASEv3 的自定义域后缀配置的完整视图。 | CustomDnsSuffixConfiguration |
| dedicatedHostCount | 专用主机计数 | int |
| dnsSuffix | 应用服务环境的 DNS 后缀。 | 字符串 |
| frontEndScaleFactor | 前端的缩放因子。 | int |
| internalLoadBalancingMode | 指定要在应用服务环境的虚拟网络中内部提供服务的终结点。 | “None” “Publishing” “Web” “Web， 发布” |
| ipsslAddressCount | 为应用服务环境保留的 IP SSL 地址数。 | int |
| multiSize | 前端 VM 大小，例如“中型”、“大型”。 | 字符串 |
| networkingConfiguration | ASE 的网络配置的完整视图。 | AseV3NetworkingConfiguration |
| upgradePreference | 升级首选项 | “Early” “Late” “Manual” “None” |
| userWhitelistedIpRanges | 用户向 ASE db 上的允许列表添加了 IP 范围 | string[] |
| virtualNetwork | 虚拟网络的说明。 | VirtualNetworkProfile（必需） |
| zoneRedundant | 此应用服务环境是否为区域冗余。 | bool |
AseV3NetworkingConfiguration
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 资源类型。 | 字符串 |
| 性能 | AseV3NetworkingConfiguration 资源特定属性 | AseV3NetworkingConfigurationProperties |
AseV3NetworkingConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| allowNewPrivateEndpointConnections | 用于在 ASE 上启用和禁用新的专用终结点连接创建的属性 | bool |
| ftpEnabled | 在 ASEV3 上启用或禁用 FTP 的属性 | bool |
| inboundIpAddressOverride | 客户提供入站 IP 地址。 只能在 Ase create 上设置。 | 字符串 |
| remoteDebugEnabled | 在 ASEV3 上启用或禁用远程调试的属性 | bool |
CustomDnsSuffixConfiguration
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 资源类型。 | 字符串 |
| 性能 | CustomDnsSuffixConfiguration 资源特定属性 | CustomDnsSuffixConfigurationProperties |
CustomDnsSuffixConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| certificateUrl | 引用 Azure Key Vault 证书机密的 URL，该机密应用作具有自定义域后缀的网站的默认 SSL/TLS 证书。 | 字符串 |
| dnsSuffix | 用于 ASE 上部署的所有站点的默认自定义域后缀。 | 字符串 |
| keyVaultReferenceIdentity | 用于解析密钥保管库证书引用的用户分配标识。 如果未指定，将使用系统分配的 ASE 标识（如果可用）。 | 字符串 |
Microsoft.Web/hostingEnvironments
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2024-04-01' |
| 类 | 资源类型。 如果资源是应用，可以参考 https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference 了解类型支持的详细信息值。 | 字符串 |
| 位置 | 资源位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 核心资源属性 | AppServiceEnvironment |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.Web/hostingEnvironments” |
NameValuePair
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 配对名称。 | 字符串 |
| 价值 | 对值。 | 字符串 |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
VirtualNetworkProfile
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 虚拟网络的资源 ID。 | string （必需） |
| 子 | 虚拟网络中的子网。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
使用 Azure SQL 后端 
|
此模板创建具有 Azure SQL 后端的应用服务环境以及专用终结点以及通常用于专用/隔离环境中的关联资源。 |
| 使用托管计划和 Azure WebApp
|
在现有虚拟网络中创建具有 ILB 地址的应用服务环境 v2，该虚拟网络将可用。 应用服务环境将包含托管计划和 Azure Web 应用 |
|
创建应用服务环境
|
在虚拟网络中创建应用服务环境 |
|
创建应用服务环境 v2
|
在虚拟网络中创建应用服务环境 v2 |
|
ASEv3 中创建 AppServicePlan 和应用
|
在 ASEv3 中创建 AppServicePlan 和 App |
|
使用 ILB 地址创建应用服务环境 v2
|
使用专用内部负载均衡器地址在虚拟网络中创建应用服务环境 v2 |
|
使用 ILB 地址创建应用服务环境
|
在虚拟网络中创建具有专用内部负载均衡器地址的应用服务环境 |
|
使用添加的 Web 应用创建 Azure 应用服务环境
|
在虚拟网络子网中创建 Azure 应用服务环境。 此模板还会在应用服务环境中添加 Azure Web 应用。 模板最初由 PixelPin 的 Callum Brankin 创作 |
| 使用 Azure 防火墙
|
资源管理器模板和参数演示如何使用 Azure 防火墙集成部署应用服务环境 |
|
ILB ASE 或 ILB ASE v2 的 SSL 证书
|
为 ILB ASE 或 ILB ASE v2 配置默认 SSL 证书 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 hostingEnvironments 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Web/hostingEnvironments 资源，请将以下 Terraform 添加到模板中。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/hostingEnvironments@2024-04-01"
name = "string"
kind = "string"
location = "string"
body = jsonencode({
properties = {
clusterSettings = [
{
name = "string"
value = "string"
}
]
customDnsSuffixConfiguration = {
kind = "string"
properties = {
certificateUrl = "string"
dnsSuffix = "string"
keyVaultReferenceIdentity = "string"
}
}
dedicatedHostCount = int
dnsSuffix = "string"
frontEndScaleFactor = int
internalLoadBalancingMode = "string"
ipsslAddressCount = int
multiSize = "string"
networkingConfiguration = {
kind = "string"
properties = {
allowNewPrivateEndpointConnections = bool
ftpEnabled = bool
inboundIpAddressOverride = "string"
remoteDebugEnabled = bool
}
}
upgradePreference = "string"
userWhitelistedIpRanges = [
"string"
]
virtualNetwork = {
id = "string"
subnet = "string"
}
zoneRedundant = bool
}
})
tags = {
{customized property} = "string"
}
}
属性值
AppServiceEnvironment
| 名字 | 描述 | 价值 |
|---|---|---|
| clusterSettings | 用于更改应用服务环境的行为的自定义设置。 | NameValuePair[] |
| customDnsSuffixConfiguration | ASEv3 的自定义域后缀配置的完整视图。 | CustomDnsSuffixConfiguration |
| dedicatedHostCount | 专用主机计数 | int |
| dnsSuffix | 应用服务环境的 DNS 后缀。 | 字符串 |
| frontEndScaleFactor | 前端的缩放因子。 | int |
| internalLoadBalancingMode | 指定要在应用服务环境的虚拟网络中内部提供服务的终结点。 | “None” “Publishing” “Web” “Web， 发布” |
| ipsslAddressCount | 为应用服务环境保留的 IP SSL 地址数。 | int |
| multiSize | 前端 VM 大小，例如“中型”、“大型”。 | 字符串 |
| networkingConfiguration | ASE 的网络配置的完整视图。 | AseV3NetworkingConfiguration |
| upgradePreference | 升级首选项 | “Early” “Late” “Manual” “None” |
| userWhitelistedIpRanges | 用户向 ASE db 上的允许列表添加了 IP 范围 | string[] |
| virtualNetwork | 虚拟网络的说明。 | VirtualNetworkProfile（必需） |
| zoneRedundant | 此应用服务环境是否为区域冗余。 | bool |
AseV3NetworkingConfiguration
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 资源类型。 | 字符串 |
| 性能 | AseV3NetworkingConfiguration 资源特定属性 | AseV3NetworkingConfigurationProperties |
AseV3NetworkingConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| allowNewPrivateEndpointConnections | 用于在 ASE 上启用和禁用新的专用终结点连接创建的属性 | bool |
| ftpEnabled | 在 ASEV3 上启用或禁用 FTP 的属性 | bool |
| inboundIpAddressOverride | 客户提供入站 IP 地址。 只能在 Ase create 上设置。 | 字符串 |
| remoteDebugEnabled | 在 ASEV3 上启用或禁用远程调试的属性 | bool |
CustomDnsSuffixConfiguration
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 资源类型。 | 字符串 |
| 性能 | CustomDnsSuffixConfiguration 资源特定属性 | CustomDnsSuffixConfigurationProperties |
CustomDnsSuffixConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| certificateUrl | 引用 Azure Key Vault 证书机密的 URL，该机密应用作具有自定义域后缀的网站的默认 SSL/TLS 证书。 | 字符串 |
| dnsSuffix | 用于 ASE 上部署的所有站点的默认自定义域后缀。 | 字符串 |
| keyVaultReferenceIdentity | 用于解析密钥保管库证书引用的用户分配标识。 如果未指定，将使用系统分配的 ASE 标识（如果可用）。 | 字符串 |
Microsoft.Web/hostingEnvironments
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 资源类型。 如果资源是应用，可以参考 https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference 了解类型支持的详细信息值。 | 字符串 |
| 位置 | 资源位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 核心资源属性 | AppServiceEnvironment |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.Web/hostingEnvironments@2024-04-01” |
NameValuePair
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 配对名称。 | 字符串 |
| 价值 | 对值。 | 字符串 |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
VirtualNetworkProfile
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 虚拟网络的资源 ID。 | string （必需） |
| 子 | 虚拟网络中的子网。 | 字符串 |