你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Web hostingEnvironments

项目
02/15/2023

Bicep 资源定义

hostingEnvironments 资源类型可以部署到：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Web/hostingEnvironments 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Web/hostingEnvironments@2022-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: '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
  }
}

属性值

hostingEnvironments

名称	说明	值
name	资源名称	字符串 (必需)
location	资源位置。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
kind	资源类型。	string
properties	核心资源属性	AppServiceEnvironment

AppServiceEnvironment

名称	说明	值
clusterSettings	用于更改应用服务环境行为的自定义设置。	NameValuePair[]
customDnsSuffixConfiguration	ASEv3 的自定义域后缀配置的完整视图。	CustomDnsSuffixConfiguration
dedicatedHostCount	专用主机计数	int
dnsSuffix	应用服务环境的 DNS 后缀。	string
frontEndScaleFactor	前端的比例因子。	int
internalLoadBalancingMode	指定要在虚拟网络内部为应用服务环境提供服务的终结点。	“None” 'Publishing' 'Web' “Web，发布”
ipsslAddressCount	为应用服务环境保留的 IP SSL 地址数。	int
multiSize	前端 VM 大小，例如“中”、“大”。	string
networkingConfiguration	ASE 网络配置的完整视图。	AseV3NetworkingConfiguration
upgradePreference	升级首选项	“Early” 'Late' “Manual” “None”
userWhitelistedIpRanges	用户添加的 ASE db 上允许的 IP 范围列表	string[]
virtualNetwork	虚拟网络的说明。	VirtualNetworkProfile (必需)
zoneRedundant	此应用服务环境是否为区域冗余。	bool

NameValuePair

名称	说明	值
name	对名称。	string
value	对值。	字符串

CustomDnsSuffixConfiguration

名称	说明	值
kind	资源类型。	string
properties	CustomDnsSuffixConfiguration 资源特定的属性	CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

名称	说明	值
certificateUrl	引用 Azure 密钥保管库证书机密的 URL，该机密应用作具有自定义域后缀的站点的默认 SSL/TLS 证书。	字符串
dnsSuffix	要用于在 ASE 上部署的所有站点的默认自定义域后缀。	字符串
keyVaultReferenceIdentity	用户分配的标识，用于解析密钥保管库证书引用。如果未指定，将使用系统分配的 ASE 标识（如果可用）。	字符串

AseV3NetworkingConfiguration

名称	说明	值
kind	资源类型。	string
properties	AseV3NetworkingConfiguration 资源特定的属性	AseV3NetworkingConfigurationProperties

AseV3NetworkingConfigurationProperties

名称	说明	值
allowNewPrivateEndpointConnections	用于在 ASE 上启用和禁用新专用终结点连接创建的属性	bool
ftpEnabled	用于在 ASEV3 上启用和禁用 FTP 的属性	bool
inboundIpAddressOverride	客户提供的入站 IP 地址。只能在 Ase create 上设置。	string
remoteDebugEnabled	用于在 ASEV3 上启用和禁用远程调试的属性	bool

VirtualNetworkProfile

名称	说明	Value
id	虚拟网络的资源 ID。	字符串 (必需)
子网	虚拟网络中的子网。	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用 Azure 防火墙的 ILB 应用服务环境	资源管理器模板和参数，演示如何通过Azure 防火墙集成部署App 服务环境
使用 Azure SQL 后端应用服务环境	此模板创建一个应用服务环境，其中包含Azure SQL后端、专用终结点以及通常在专用/隔离环境中使用的关联资源。
使用托管计划和 Azure WebApp 应用服务环境	在现有虚拟网络中创建具有 ILB 地址的应用服务环境 v2，该地址将专用可用。应用服务环境将包含托管计划和 Azure Web 应用
使用添加的 Web 应用创建Azure 应用服务环境	在虚拟网络子网中创建Azure 应用服务环境。此模板还会在应用服务环境中添加 Azure Web 应用。模板最初由 PixelPin 的 Callum Brankin 创作
创建应用服务环境	在虚拟网络中创建应用服务环境
ILB ASE 或 ILB ASE v2 的 SSL 证书	Configures the default SSL certificate for an ILB ASE or an ILB ASE v2（为 ILB ASE 或 ILB ASE v2 配置默认的 SSL 证书）
使用 ILB 地址创建应用服务环境	在虚拟网络中创建具有专用内部负载均衡器地址的应用服务环境
创建应用服务环境 v2	在虚拟网络中创建应用服务环境 v2
Create App Service Environment v2 with an ILB Address（使用 ILB 地址创建应用服务环境 v2）	在虚拟网络中创建具有专用内部负载均衡器地址的应用服务环境 v2
在 ASEv3 中创建 AppServicePlan 和应用	在 ASEv3 中创建 AppServicePlan 和应用

ARM 模板资源定义

hostingEnvironments 资源类型可以部署到：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Web/hostingEnvironments 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Web/hostingEnvironments",
  "apiVersion": "2022-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "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"
  }
}

属性值

hostingEnvironments

名称	说明	Value
type	资源类型	“Microsoft.Web/hostingEnvironments”
apiVersion	资源 API 版本	'2022-03-01'
name	资源名称	字符串 (必需)
location	资源位置。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
kind	资源类型。	string
properties	核心资源属性	AppServiceEnvironment

AppServiceEnvironment

名称	说明	值
clusterSettings	用于更改应用服务环境行为的自定义设置。	NameValuePair[]
customDnsSuffixConfiguration	ASEv3 的自定义域后缀配置的完整视图。	CustomDnsSuffixConfiguration
dedicatedHostCount	专用主机计数	int
dnsSuffix	应用服务环境的 DNS 后缀。	string
frontEndScaleFactor	前端的比例因子。	int
internalLoadBalancingMode	指定要在虚拟网络内部为应用服务环境提供服务的终结点。	“None” “发布” “Web” “Web，发布”
ipsslAddressCount	为应用服务环境保留的 IP SSL 地址数。	int
multiSize	前端 VM 大小，例如“中等”、“大型”。	string
networkingConfiguration	ASE 网络配置的完整视图。	AseV3NetworkingConfiguration
upgradePreference	升级首选项	“Early” “Late” “手动” “None”
userWhitelistedIpRanges	用户添加了 ASE db 上允许的 IP 范围列表	string[]
virtualNetwork	虚拟网络的说明。	VirtualNetworkProfile (必需)
zoneRedundant	此应用服务环境是否为区域冗余。	bool

NameValuePair

名称	说明	值
name	对名称。	string
value	配对值。	string

CustomDnsSuffixConfiguration

名称	说明	值
kind	资源类型。	string
properties	CustomDnsSuffixConfiguration 资源特定的属性	CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

名称	说明	值
certificateUrl	引用 Azure 密钥保管库证书机密的 URL，该机密应用作具有自定义域后缀的站点的默认 SSL/TLS 证书。	字符串
dnsSuffix	用于在 ASE 上部署的所有站点的默认自定义域后缀。	字符串
keyVaultReferenceIdentity	用户分配的标识，用于解析密钥保管库证书引用。如果未指定，将使用系统分配的 ASE 标识（如果可用）。	字符串

AseV3NetworkingConfiguration

名称	说明	值
kind	资源类型。	string
properties	AseV3NetworkingConfiguration 资源特定属性	AseV3NetworkingConfigurationProperties

AseV3NetworkingConfigurationProperties

名称	说明	值
allowNewPrivateEndpointConnections	用于在 ASE 上启用和禁用新专用终结点连接创建的属性	bool
ftpEnabled	用于在 ASEV3 上启用和禁用 FTP 的属性	bool
inboundIpAddressOverride	客户提供的入站 IP 地址。只能在 Ase create 上设置。	string
remoteDebugEnabled	用于在 ASEV3 上启用和禁用远程调试的属性	bool

VirtualNetworkProfile

名称	说明	Value
id	虚拟网络的资源 ID。	字符串 (必需)
子网	虚拟网络中的子网。	string

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用 Azure 防火墙的 ILB 应用服务环境	资源管理器模板和参数，演示如何使用Azure 防火墙集成部署App 服务环境
使用Azure SQL后端应用服务环境	此模板创建一个应用服务环境，其中包含Azure SQL后端、专用终结点以及通常在专用/隔离环境中使用的关联资源。
使用 Hosting Plan 和 Azure WebApp 应用服务环境	在现有虚拟网络中创建具有 ILB 地址的应用服务环境 v2，该地址将专用可用。应用服务环境将包含托管计划和 Azure Web 应用
使用添加了 Web 应用创建Azure 应用服务环境	在虚拟网络子网中创建Azure 应用服务环境。此模板还会在应用服务环境中添加 Azure Web 应用。模板最初由 PixelPin 的 Callum Brankin 创作
创建应用服务环境	在虚拟网络中创建应用服务环境
ILB ASE 或 ILB ASE v2 的 SSL 证书	Configures the default SSL certificate for an ILB ASE or an ILB ASE v2（为 ILB ASE 或 ILB ASE v2 配置默认的 SSL 证书）
使用 ILB 地址创建应用服务环境	在虚拟网络中创建具有专用内部负载均衡器地址的应用服务环境
创建应用服务环境 v2	在虚拟网络中创建应用服务环境 v2
Create App Service Environment v2 with an ILB Address（使用 ILB 地址创建应用服务环境 v2）	在虚拟网络中创建具有专用内部负载均衡器地址的应用服务环境 v2
在 ASEv3 中创建 AppServicePlan 和应用	在 ASEv3 中创建 AppServicePlan 和应用

Terraform (AzAPI 提供程序) 资源定义

hostingEnvironments 资源类型可以部署到：

资源组

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Web/hostingEnvironments 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/hostingEnvironments@2022-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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
    }
    kind = "string"
  })
}

属性值

hostingEnvironments

名称	说明	Value
type	资源类型	“Microsoft.Web/hostingEnvironments@2022-03-01”
name	资源名称	字符串 (必需)
location	资源位置。	字符串 (必需)
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。
kind	资源类型。	string
properties	核心资源属性	AppServiceEnvironment

AppServiceEnvironment

名称	说明	值
clusterSettings	用于更改应用服务环境行为的自定义设置。	NameValuePair[]
customDnsSuffixConfiguration	ASEv3 的自定义域后缀配置的完整视图。	CustomDnsSuffixConfiguration
dedicatedHostCount	专用主机计数	int
dnsSuffix	应用服务环境的 DNS 后缀。	string
frontEndScaleFactor	前端的比例因子。	int
internalLoadBalancingMode	指定要在虚拟网络内部为应用服务环境提供服务的终结点。	"None" “发布” “Web” “Web，发布”
ipsslAddressCount	为应用服务环境保留的 IP SSL 地址数。	int
multiSize	前端 VM 大小，例如“中等”、“大型”。	string
networkingConfiguration	ASE 网络配置的完整视图。	AseV3NetworkingConfiguration
upgradePreference	升级首选项	“Early” “Late” “手动” "None"
userWhitelistedIpRanges	用户添加了 ASE db 上允许的 IP 范围列表	string[]
virtualNetwork	虚拟网络的说明。	VirtualNetworkProfile (必需)
zoneRedundant	此应用服务环境是否为区域冗余。	bool

NameValuePair

名称	说明	值
name	对名称。	string
value	配对值。	string

CustomDnsSuffixConfiguration

名称	说明	值
kind	资源类型。	string
properties	CustomDnsSuffixConfiguration 资源特定的属性	CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

名称	说明	值
certificateUrl	引用 Azure 密钥保管库证书机密的 URL，该机密应用作具有自定义域后缀的站点的默认 SSL/TLS 证书。	字符串
dnsSuffix	用于在 ASE 上部署的所有站点的默认自定义域后缀。	string
keyVaultReferenceIdentity	用户分配的标识，用于解析密钥保管库证书引用。如果未指定，将使用系统分配的 ASE 标识（如果可用）。	字符串

AseV3NetworkingConfiguration

名称	说明	值
kind	资源类型。	string
properties	AseV3NetworkingConfiguration 资源特定的属性	AseV3NetworkingConfigurationProperties

AseV3NetworkingConfigurationProperties

名称	说明	值
allowNewPrivateEndpointConnections	用于在 ASE 上启用和禁用新专用终结点连接创建的属性	bool
ftpEnabled	用于在 ASEV3 上启用和禁用 FTP 的属性	bool
inboundIpAddressOverride	客户提供的入站 IP 地址。只能在 Ase create 上设置。	string
remoteDebugEnabled	用于在 ASEV3 上启用和禁用远程调试的属性	bool

VirtualNetworkProfile

名称	说明	Value
id	虚拟网络的资源 ID。	字符串 (必需)
子网	虚拟网络中的子网。	字符串

Microsoft.Web hostingEnvironments

Bicep 资源定义

资源格式

属性值

hostingEnvironments

AppServiceEnvironment

NameValuePair

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

VirtualNetworkProfile

快速入门模板

ARM 模板资源定义

资源格式

属性值

hostingEnvironments

AppServiceEnvironment

NameValuePair

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

VirtualNetworkProfile

快速入门模板

Terraform (AzAPI 提供程序) 资源定义

资源格式

属性值

hostingEnvironments

AppServiceEnvironment

NameValuePair

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

VirtualNetworkProfile

其他资源

其他资源