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

Microsoft.Web hostingEnvironments 2020-10-01

项目
09/03/2023

Bicep 资源定义

hostingEnvironments 资源类型可以通过针对以下操作进行部署：

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

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

资源格式

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

resource symbolicname 'Microsoft.Web/hostingEnvironments@2020-10-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  properties: {
    apiManagementAccountId: 'string'
    clusterSettings: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    dnsSuffix: 'string'
    dynamicCacheEnabled: bool
    frontEndScaleFactor: int
    hasLinuxWorkers: bool
    internalLoadBalancingMode: 'string'
    ipsslAddressCount: int
    location: 'string'
    multiRoleCount: int
    multiSize: 'string'
    name: 'string'
    networkAccessControlList: [
      {
        action: 'string'
        description: 'string'
        order: int
        remoteSubnet: 'string'
      }
    ]
    sslCertKeyVaultId: 'string'
    sslCertKeyVaultSecretName: 'string'
    suspended: bool
    userWhitelistedIpRanges: [
      'string'
    ]
    virtualNetwork: {
      id: 'string'
      subnet: 'string'
    }
    vnetName: 'string'
    vnetResourceGroupName: 'string'
    vnetSubnetName: 'string'
    workerPools: [
      {
        computeMode: 'string'
        workerCount: int
        workerSize: 'string'
        workerSizeId: int
      }
    ]
  }
}

属性值

hostingEnvironments

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

AppServiceEnvironment

名称	说明	值
apiManagementAccountId	API 管理与应用服务环境关联的帐户。	string
clusterSettings	用于更改应用服务环境行为的自定义设置。	NameValuePair[]
dnsSuffix	应用服务环境的 DNS 后缀。	字符串
dynamicCacheEnabled	指示应用服务环境是否挂起的 True/false。环境可以暂停，例如，当管理终结点不再可用时 (很可能是因为 NSG 阻止了传入流量) 。	bool
frontEndScaleFactor	前端的比例因子。	int
hasLinuxWorkers	显示 ASE 是否具有 linux 辅助角色的标志	bool
internalLoadBalancingMode	指定要在虚拟网络内部为应用服务环境提供服务的终结点。	“None” “发布” “Web” “Web，发布”
ipsslAddressCount	为应用服务环境保留的 IP SSL 地址数。	int
location	应用服务环境的位置，例如“美国西部”。	字符串 (必需)
multiRoleCount	前端实例数。	int
multiSize	前端 VM 大小，例如“中等”、“大型”。	string
name	应用服务环境的名称。	字符串 (必需)
networkAccessControlList	用于控制应用服务环境流量的访问控制列表。	NetworkAccessControlEntry[]
sslCertKeyVaultId	ILB 应用服务环境默认 SSL 证书的密钥保管库 ID	字符串
sslCertKeyVaultSecretName	密钥保管库 ILB 应用服务环境默认 SSL 证书的机密名称	字符串
已挂起	`true`如果暂停应用服务环境，则为 ;否则为 `false`。环境可以暂停，例如，当管理终结点不再可用时 (很可能是因为 NSG 阻止了传入流量) 。	bool
userWhitelistedIpRanges	用户添加了 ASE db 上允许的 IP 范围列表	string[]
virtualNetwork	虚拟网络的说明。	VirtualNetworkProfile (必需)
vnetName	应用服务环境虚拟网络的名称。	string
vnetResourceGroupName	虚拟网络的资源组。	字符串
vnetSubnetName	虚拟网络的子网。	字符串
workerPools	描述具有辅助角色大小 ID、VM 大小和每个池中的辅助角色数的工作池。	WorkerPool[] (必需的)

NameValuePair

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

NetworkAccessControlEntry

名称	说明	值
操作	操作对象。	“拒绝” “Permit”
description	网络访问控制项的说明。	字符串
顺序	优先级顺序。	int
remoteSubnet	远程子网。	string

VirtualNetworkProfile

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

WorkerPool

名称	说明	值
computeMode	共享或专用应用托管。	“专用” “Dynamic” “Shared”
workerCount	辅助角色池中的实例数。	int
workerSize	辅助角色池实例的 VM 大小。	string
workerSizeId	用于引用此辅助角色池的辅助角色大小 ID。	int

快速入门模板

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

模板	说明
使用 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 和应用

ARM 模板资源定义

hostingEnvironments 资源类型可以使用面向以下对象的操作进行部署：

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

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

资源格式

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

{
  "type": "Microsoft.Web/hostingEnvironments",
  "apiVersion": "2020-10-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "properties": {
    "apiManagementAccountId": "string",
    "clusterSettings": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "dnsSuffix": "string",
    "dynamicCacheEnabled": "bool",
    "frontEndScaleFactor": "int",
    "hasLinuxWorkers": "bool",
    "internalLoadBalancingMode": "string",
    "ipsslAddressCount": "int",
    "location": "string",
    "multiRoleCount": "int",
    "multiSize": "string",
    "name": "string",
    "networkAccessControlList": [
      {
        "action": "string",
        "description": "string",
        "order": "int",
        "remoteSubnet": "string"
      }
    ],
    "sslCertKeyVaultId": "string",
    "sslCertKeyVaultSecretName": "string",
    "suspended": "bool",
    "userWhitelistedIpRanges": [ "string" ],
    "virtualNetwork": {
      "id": "string",
      "subnet": "string"
    },
    "vnetName": "string",
    "vnetResourceGroupName": "string",
    "vnetSubnetName": "string",
    "workerPools": [
      {
        "computeMode": "string",
        "workerCount": "int",
        "workerSize": "string",
        "workerSizeId": "int"
      }
    ]
  }
}

属性值

hostingEnvironments

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

AppServiceEnvironment

名称	说明	值
apiManagementAccountId	API 管理与应用服务环境关联的帐户。	字符串
clusterSettings	用于更改应用服务环境行为的自定义设置。	NameValuePair[]
dnsSuffix	应用服务环境的 DNS 后缀。	字符串
dynamicCacheEnabled	True/false，指示应用服务环境是否已挂起。当管理终结点不再可用时，环境可以挂起 (很可能是因为 NSG 阻止了传入流量) 。	bool
frontEndScaleFactor	前端的比例因子。	int
hasLinuxWorkers	显示 ASE 是否具有 Linux 辅助角色的标志	bool
internalLoadBalancingMode	指定要在虚拟网络内部为应用服务环境提供服务的终结点。	“None” 'Publishing' 'Web' “Web，发布”
ipsslAddressCount	为应用服务环境保留的 IP SSL 地址数。	int
location	应用服务环境的位置，例如“美国西部”。	字符串 (必需)
multiRoleCount	前端实例数。	int
multiSize	前端 VM 大小，例如“中”、“大”。	string
name	应用服务环境的名称。	字符串 (必需)
networkAccessControlList	用于控制应用服务环境流量的访问控制列表。	NetworkAccessControlEntry[]
sslCertKeyVaultId	ILB 应用服务环境默认 SSL 证书的密钥保管库 ID	string
sslCertKeyVaultSecretName	密钥保管库默认 SSL 证书应用服务环境 ILB 的机密名称	string
已挂起	`true`如果暂停应用服务环境，则为 ;否则为 `false`。环境可以挂起，例如，当管理终结点不再可用时 (很可能是因为 NSG 阻止了传入流量) 。	bool
userWhitelistedIpRanges	用户添加了 ASE db 上允许的 IP 范围列表	string[]
virtualNetwork	虚拟网络的说明。	VirtualNetworkProfile (必需)
vnetName	应用服务环境虚拟网络的名称。	string
vnetResourceGroupName	虚拟网络的资源组。	字符串
vnetSubnetName	虚拟网络的子网。	字符串
workerPools	描述具有辅助角色大小 ID、VM 大小和每个池中的辅助角色数的工作池。	WorkerPool[] (必需的)

NameValuePair

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

NetworkAccessControlEntry

名称	说明	值
操作	操作对象。	“拒绝” “Permit”
description	网络访问控制项的说明。	字符串
顺序	优先级顺序。	int
remoteSubnet	远程子网。	字符串

VirtualNetworkProfile

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

WorkerPool

名称	说明	值
computeMode	共享或专用应用托管。	“专用” “Dynamic” “Shared”
workerCount	辅助角色池中的实例数。	int
workerSize	辅助角色池实例的 VM 大小。	string
workerSizeId	用于引用此辅助角色池的辅助角色大小 ID。	int

快速入门模板

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

模板	说明
使用 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@2020-10-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      apiManagementAccountId = "string"
      clusterSettings = [
        {
          name = "string"
          value = "string"
        }
      ]
      dnsSuffix = "string"
      dynamicCacheEnabled = bool
      frontEndScaleFactor = int
      hasLinuxWorkers = bool
      internalLoadBalancingMode = "string"
      ipsslAddressCount = int
      location = "string"
      multiRoleCount = int
      multiSize = "string"
      name = "string"
      networkAccessControlList = [
        {
          action = "string"
          description = "string"
          order = int
          remoteSubnet = "string"
        }
      ]
      sslCertKeyVaultId = "string"
      sslCertKeyVaultSecretName = "string"
      suspended = bool
      userWhitelistedIpRanges = [
        "string"
      ]
      virtualNetwork = {
        id = "string"
        subnet = "string"
      }
      vnetName = "string"
      vnetResourceGroupName = "string"
      vnetSubnetName = "string"
      workerPools = [
        {
          computeMode = "string"
          workerCount = int
          workerSize = "string"
          workerSizeId = int
        }
      ]
    }
    kind = "string"
  })
}

属性值

hostingEnvironments

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

AppServiceEnvironment

名称	说明	值
apiManagementAccountId	API 管理与应用服务环境关联的帐户。	字符串
clusterSettings	用于更改应用服务环境行为的自定义设置。	NameValuePair[]
dnsSuffix	应用服务环境的 DNS 后缀。	字符串
dynamicCacheEnabled	True/false，指示应用服务环境是否已挂起。当管理终结点不再可用时，环境可以挂起 (很可能是因为 NSG 阻止了传入流量) 。	bool
frontEndScaleFactor	前端的比例因子。	int
hasLinuxWorkers	显示 ASE 是否具有 Linux 辅助角色的标志	bool
internalLoadBalancingMode	指定要在虚拟网络内部为应用服务环境提供服务的终结点。	"None" “Publishing” “Web” “Web，发布”
ipsslAddressCount	为应用服务环境保留的 IP SSL 地址数。	int
location	应用服务环境的位置，例如“美国西部”。	字符串 (必需)
multiRoleCount	前端实例数。	int
multiSize	前端 VM 大小，例如“中”、“大”。	string
name	应用服务环境的名称。	字符串 (必需)
networkAccessControlList	用于控制应用服务环境流量的访问控制列表。	NetworkAccessControlEntry[]
sslCertKeyVaultId	ILB 应用服务环境默认 SSL 证书的密钥保管库 ID	string
sslCertKeyVaultSecretName	密钥保管库默认 SSL 证书应用服务环境 ILB 的机密名称	字符串
已挂起	`true`如果暂停应用服务环境，则为 ;否则为 `false`。环境可以挂起，例如，当管理终结点不再可用时 (很可能是因为 NSG 阻止了传入流量) 。	bool
userWhitelistedIpRanges	用户添加的 ASE db 上允许的 IP 范围列表	string[]
virtualNetwork	虚拟网络的说明。	VirtualNetworkProfile (必需)
vnetName	应用服务环境虚拟网络的名称。	string
vnetResourceGroupName	虚拟网络的资源组。	字符串
vnetSubnetName	虚拟网络的子网。	字符串
workerPools	每个池中具有辅助角色大小 ID、VM 大小和辅助角色数的工作器池的说明。	WorkerPool[] (必需)

NameValuePair

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

NetworkAccessControlEntry

名称	说明	值
操作	操作对象。	“拒绝” “Permit”
description	网络访问控制条目的说明。	string
顺序	优先级顺序。	int
remoteSubnet	远程子网。	string

VirtualNetworkProfile

名称	说明	Value
id	虚拟网络的资源 ID。	string
子网	虚拟网络中的子网。	string

WorkerPool

名称	说明	值
computeMode	共享或专用应用托管。	“专用” “动态” “Shared”
workerCount	辅助角色池中的实例数。	int
workerSize	辅助角色池实例的 VM 大小。	string
workerSizeId	用于引用此辅助角色池的辅助角色大小 ID。	int

Microsoft.Web hostingEnvironments 2020-10-01

Bicep 资源定义

资源格式

属性值

hostingEnvironments

AppServiceEnvironment

NameValuePair

NetworkAccessControlEntry

VirtualNetworkProfile

WorkerPool

快速入门模板

ARM 模板资源定义

资源格式

属性值

hostingEnvironments

AppServiceEnvironment

NameValuePair

NetworkAccessControlEntry

VirtualNetworkProfile

WorkerPool

快速入门模板

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

资源格式

属性值

hostingEnvironments

AppServiceEnvironment

NameValuePair

NetworkAccessControlEntry

VirtualNetworkProfile

WorkerPool

反馈

反馈

其他资源