Microsoft.Web/hostingEnvironments 2019-08-01 - Bicep, ARM template & Terraform AzAPI reference

Bicep 资源定义

可以使用目标操作部署 hostingEnvironments 资源类型：

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

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

资源格式

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

resource symbolicname 'Microsoft.Web/hostingEnvironments@2019-08-01' = {
  kind: 'string'
  location: 'string'
  name: '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
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AppServiceEnvironment

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

Microsoft.Web/hostingEnvironments

名字	描述	价值
类	资源类型。	字符串
位置	资源位置。	string （必需）
名字	资源名称	string （必需）
性能	核心资源属性	AppServiceEnvironment
标签	资源标记	标记名称和值的字典。请参阅模板中的标记

NameValuePair

名字	描述	价值
名字	配对名称。	字符串
价值	对值。	字符串

NetworkAccessControlEntry

名字	描述	价值
行动	操作对象。	“拒绝” “Permit”
描述	网络访问控制条目的说明。	字符串
次序	优先级顺序。	int
remoteSubnet	远程子网。	字符串

ResourceTags

名字	描述	价值

VirtualNetworkProfile

名字	描述	价值
id	虚拟网络的资源 ID。	字符串
子	虚拟网络中的子网。	字符串

WorkerPool

名字	描述	价值
computeMode	共享或专用应用托管。	“专用” “Dynamic” “共享”
workerCount	辅助角色池中的实例数。	int
workerSize	辅助角色池实例的 VM 大小。	字符串
workerSizeId	用于引用此辅助角色池的辅助角色大小 ID。	int

快速入门示例

以下快速入门示例部署此资源类型。

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": "2019-08-01",
  "name": "string",
  "kind": "string",
  "location": "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"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AppServiceEnvironment

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

Microsoft.Web/hostingEnvironments

名字	描述	价值
apiVersion	API 版本	'2019-08-01'
类	资源类型。	字符串
位置	资源位置。	string （必需）
名字	资源名称	string （必需）
性能	核心资源属性	AppServiceEnvironment
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.Web/hostingEnvironments”

NameValuePair

名字	描述	价值
名字	配对名称。	字符串
价值	对值。	字符串

NetworkAccessControlEntry

名字	描述	价值
行动	操作对象。	“拒绝” “Permit”
描述	网络访问控制条目的说明。	字符串
次序	优先级顺序。	int
remoteSubnet	远程子网。	字符串

ResourceTags

名字	描述	价值

VirtualNetworkProfile

名字	描述	价值
id	虚拟网络的资源 ID。	字符串
子	虚拟网络中的子网。	字符串

WorkerPool

名字	描述	价值
computeMode	共享或专用应用托管。	“专用” “Dynamic” “共享”
workerCount	辅助角色池中的实例数。	int
workerSize	辅助角色池实例的 VM 大小。	字符串
workerSizeId	用于引用此辅助角色池的辅助角色大小 ID。	int

快速入门模板

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

模板	描述
使用 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 防火墙 ILB 应用服务环境	资源管理器模板和参数演示如何使用 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@2019-08-01"
  name = "string"
  kind = "string"
  location = "string"
  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
        }
      ]
    }
  })
  tags = {
    {customized property} = "string"
  }
}

属性值

AppServiceEnvironment

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

Microsoft.Web/hostingEnvironments

名字	描述	价值
类	资源类型。	字符串
位置	资源位置。	string （必需）
名字	资源名称	string （必需）
性能	核心资源属性	AppServiceEnvironment
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Web/hostingEnvironments@2019-08-01”

NameValuePair

名字	描述	价值
名字	配对名称。	字符串
价值	对值。	字符串

NetworkAccessControlEntry

名字	描述	价值
行动	操作对象。	“拒绝” “Permit”
描述	网络访问控制条目的说明。	字符串
次序	优先级顺序。	int
remoteSubnet	远程子网。	字符串

ResourceTags

名字	描述	价值

VirtualNetworkProfile

名字	描述	价值
id	虚拟网络的资源 ID。	字符串
子	虚拟网络中的子网。	字符串

WorkerPool

名字	描述	价值
computeMode	共享或专用应用托管。	“专用” “Dynamic” “共享”
workerCount	辅助角色池中的实例数。	int
workerSize	辅助角色池实例的 VM 大小。	字符串
workerSizeId	用于引用此辅助角色池的辅助角色大小 ID。	int

通过

Microsoft.Web hostingEnvironments 2019-08-01

Bicep 资源定义

资源格式

属性值

AppServiceEnvironment

Microsoft.Web/hostingEnvironments

NameValuePair

NetworkAccessControlEntry

ResourceTags

VirtualNetworkProfile

WorkerPool

快速入门示例

ARM 模板资源定义

资源格式

属性值

AppServiceEnvironment

Microsoft.Web/hostingEnvironments

NameValuePair

NetworkAccessControlEntry

ResourceTags

VirtualNetworkProfile

WorkerPool

快速入门模板

Terraform （AzAPI 提供程序）资源定义

资源格式

属性值

AppServiceEnvironment

Microsoft.Web/hostingEnvironments

NameValuePair

NetworkAccessControlEntry

ResourceTags

VirtualNetworkProfile

WorkerPool

反馈

其他资源