Microsoft.Web/hostingEnvironments 2018-02-01 - Bicep, ARM template & Terraform AzAPI reference

Bicep 資源定義

hostingEnvironments 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Web/hostingEnvironments 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Web/hostingEnvironments@2018-02-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	與 App Service 環境相關聯的 API 管理帳戶。	字串
clusterSettings	變更 App Service 環境的行為的自訂設定。	NameValuePair[]
dnsSuffix	App Service 環境的 DNS 後綴。	字串
dynamicCacheEnabled	True/false 表示 App Service 環境是否暫停。環境可以暫停，例如當不再提供管理端點時（最有可能是因為 NSG 封鎖了傳入的流量）。	bool
frontEndScaleFactor	前端的縮放比例。	int
hasLinuxWorkers	顯示 ASE 是否有 Linux 背景工作角色的旗標	bool
internalLoadBalancingMode	指定要在 App Service 環境的虛擬網路內部提供服務的端點。	'None' 'Publishing' 'Web'
ipsslAddressCount	保留給 App Service 環境的 IP SSL 位址數目。	int
位置	App Service 環境的位置，例如「美國西部」。	字串（必要）
multiRoleCount	前端實例的數目。	int
multiSize	前端 VM 大小，例如「中」、「大型」。	字串
名字	App Service 環境的名稱。	字串（必要）
networkAccessControlList	訪問控制清單，用於控制 App Service 環境的流量。	NetworkAccessControlEntry[]
sslCertKeyVaultId	ILB App Service 環境預設 SSL 憑證的 Key Vault 識別碼	字串
sslCertKeyVaultSecretName	ILB App Service 環境預設 SSL 憑證的 Key Vault 秘密名稱	字串
暫停	如果 App Service 環境暫停，<程式代碼>true</code>;否則，<程式代碼>false</code>。環境可以暫停，例如當管理端點不再可用時（最有可能是因為 NSG 封鎖了傳入的流量）。	bool
userWhitelistedIpRanges	在 ASE db 上允許的使用者新增 IP 範圍清單	string[]
virtualNetwork	虛擬網路的描述。	VirtualNetworkProfile （必要）
vnetName	App Service 環境的虛擬網路名稱。	字串
vnetResourceGroupName	虛擬網路的資源群組。	字串
vnetSubnetName	虛擬網路的子網。	字串
workerPools	描述每個集區中具有背景工作角色大小標識碼、VM 大小和背景工作角色數目的背景工作集區。	WorkerPool[] （必要）

Microsoft.Web/hostingEnvironments

名字	描述	價值
類	資源種類。	字串
位置	資源位置。	字串（必要）
名字	資源名稱	字串（必要）
性能	核心資源屬性	AppServiceEnvironment
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤

NameValuePair

名字	描述	價值
名字	配對名稱。	字串
價值	配對值。	字串

NetworkAccessControlEntry

名字	描述	價值
行動	Action 物件。	'Deny' 'Permit'
描述	網路訪問控制專案的描述。	字串
次序	優先順序。	int
remoteSubnet	遠端子網。	字串

ResourceTags

名字	描述	價值

VirtualNetworkProfile

名字	描述	價值
id	虛擬網路的資源識別碼。	字串
子	虛擬網路內的子網。	字串

WorkerPool

名字	描述	價值
computeMode	共用或專用的應用程式裝載。	'Dedicated' 'Dynamic' 'Shared'
workerCount	背景工作集區中的實例數目。	int
workerSize	背景工作集區實例的 VM 大小。	字串
workerSizeId	參考此背景工作集區的背景工作大小標識碼。	int

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
使用主控方案和 Azure WebApp App Service 環境	在現有的虛擬網路中建立具有 ILB 位址的 App Service Environment v2，以便私下使用。 App Service 環境將包含主控方案和 Azure Web 應用程式
建立 App Service Environment v2	在您的虛擬網路中建立App Service Environment v2
在 ASEv3 中建立 AppServicePlan 和 App	在 ASEv3 中建立 AppServicePlan 和 App

ARM 樣本資源定義

hostingEnvironments 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Web/hostingEnvironments 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Web/hostingEnvironments",
  "apiVersion": "2018-02-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	與 App Service 環境相關聯的 API 管理帳戶。	字串
clusterSettings	變更 App Service 環境的行為的自訂設定。	NameValuePair[]
dnsSuffix	App Service 環境的 DNS 後綴。	字串
dynamicCacheEnabled	True/false 表示 App Service 環境是否暫停。環境可以暫停，例如當不再提供管理端點時（最有可能是因為 NSG 封鎖了傳入的流量）。	bool
frontEndScaleFactor	前端的縮放比例。	int
hasLinuxWorkers	顯示 ASE 是否有 Linux 背景工作角色的旗標	bool
internalLoadBalancingMode	指定要在 App Service 環境的虛擬網路內部提供服務的端點。	'None' 'Publishing' 'Web'
ipsslAddressCount	保留給 App Service 環境的 IP SSL 位址數目。	int
位置	App Service 環境的位置，例如「美國西部」。	字串（必要）
multiRoleCount	前端實例的數目。	int
multiSize	前端 VM 大小，例如「中」、「大型」。	字串
名字	App Service 環境的名稱。	字串（必要）
networkAccessControlList	訪問控制清單，用於控制 App Service 環境的流量。	NetworkAccessControlEntry[]
sslCertKeyVaultId	ILB App Service 環境預設 SSL 憑證的 Key Vault 識別碼	字串
sslCertKeyVaultSecretName	ILB App Service 環境預設 SSL 憑證的 Key Vault 秘密名稱	字串
暫停	如果 App Service 環境暫停，<程式代碼>true</code>;否則，<程式代碼>false</code>。環境可以暫停，例如當管理端點不再可用時（最有可能是因為 NSG 封鎖了傳入的流量）。	bool
userWhitelistedIpRanges	在 ASE db 上允許的使用者新增 IP 範圍清單	string[]
virtualNetwork	虛擬網路的描述。	VirtualNetworkProfile （必要）
vnetName	App Service 環境的虛擬網路名稱。	字串
vnetResourceGroupName	虛擬網路的資源群組。	字串
vnetSubnetName	虛擬網路的子網。	字串
workerPools	描述每個集區中具有背景工作角色大小標識碼、VM 大小和背景工作角色數目的背景工作集區。	WorkerPool[] （必要）

Microsoft.Web/hostingEnvironments

名字	描述	價值
apiVersion	API 版本	'2018-02-01'
類	資源種類。	字串
位置	資源位置。	字串（必要）
名字	資源名稱	字串（必要）
性能	核心資源屬性	AppServiceEnvironment
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
類型	資源類型	'Microsoft.Web/hostingEnvironments'

NameValuePair

名字	描述	價值
名字	配對名稱。	字串
價值	配對值。	字串

NetworkAccessControlEntry

名字	描述	價值
行動	Action 物件。	'Deny' 'Permit'
描述	網路訪問控制專案的描述。	字串
次序	優先順序。	int
remoteSubnet	遠端子網。	字串

ResourceTags

名字	描述	價值

VirtualNetworkProfile

名字	描述	價值
id	虛擬網路的資源識別碼。	字串
子	虛擬網路內的子網。	字串

WorkerPool

名字	描述	價值
computeMode	共用或專用的應用程式裝載。	'Dedicated' 'Dynamic' 'Shared'
workerCount	背景工作集區中的實例數目。	int
workerSize	背景工作集區實例的 VM 大小。	字串
workerSizeId	參考此背景工作集區的背景工作大小標識碼。	int

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
使用 Azure SQL 後端 App Service 環境	此範本會建立具有 Azure SQL 後端的 App Service 環境，以及私人端點，以及通常用於私人/隔離環境中的相關聯資源。
使用主控方案和 Azure WebApp App Service 環境	在現有的虛擬網路中建立具有 ILB 位址的 App Service Environment v2，以便私下使用。 App Service 環境將包含主控方案和 Azure Web 應用程式
建立 App Service 環境	在您的虛擬網路中建立App Service環境
建立 App Service Environment v2	在您的虛擬網路中建立App Service Environment v2
在 ASEv3 中建立 AppServicePlan 和 App	在 ASEv3 中建立 AppServicePlan 和 App
使用 ILB 位址建立 App Service Environment v2	使用私人內部負載平衡器位址在虛擬網路中建立App Service Environment v2
使用 ILB 位址建立 App Service 環境	使用私人內部負載平衡器位址在虛擬網路中建立App Service環境
使用新增的 Web 應用程式建立 Azure App Service 環境	在虛擬網路子網內建立 Azure App Service 環境。此範本也會在 App Service 環境內新增 Azure Web 應用程式。範本最初由 PixelPin 的 Callum Brankin 撰寫
使用 Azure 防火牆 ILB App Service 環境	Resource Manager 範本和參數，示範如何使用 Azure 防火牆整合來部署 App Service 環境
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@2018-02-01"
  name = "string"
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "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
        }
      ]
    }
  })
}

屬性值

AppServiceEnvironment

名字	描述	價值
apiManagementAccountId	與 App Service 環境相關聯的 API 管理帳戶。	字串
clusterSettings	變更 App Service 環境的行為的自訂設定。	NameValuePair[]
dnsSuffix	App Service 環境的 DNS 後綴。	字串
dynamicCacheEnabled	True/false 表示 App Service 環境是否暫停。環境可以暫停，例如當不再提供管理端點時（最有可能是因為 NSG 封鎖了傳入的流量）。	bool
frontEndScaleFactor	前端的縮放比例。	int
hasLinuxWorkers	顯示 ASE 是否有 Linux 背景工作角色的旗標	bool
internalLoadBalancingMode	指定要在 App Service 環境的虛擬網路內部提供服務的端點。	'None' 'Publishing' 'Web'
ipsslAddressCount	保留給 App Service 環境的 IP SSL 位址數目。	int
位置	App Service 環境的位置，例如「美國西部」。	字串（必要）
multiRoleCount	前端實例的數目。	int
multiSize	前端 VM 大小，例如「中」、「大型」。	字串
名字	App Service 環境的名稱。	字串（必要）
networkAccessControlList	訪問控制清單，用於控制 App Service 環境的流量。	NetworkAccessControlEntry[]
sslCertKeyVaultId	ILB App Service 環境預設 SSL 憑證的 Key Vault 識別碼	字串
sslCertKeyVaultSecretName	ILB App Service 環境預設 SSL 憑證的 Key Vault 秘密名稱	字串
暫停	如果 App Service 環境暫停，<程式代碼>true</code>;否則，<程式代碼>false</code>。環境可以暫停，例如當管理端點不再可用時（最有可能是因為 NSG 封鎖了傳入的流量）。	bool
userWhitelistedIpRanges	在 ASE db 上允許的使用者新增 IP 範圍清單	string[]
virtualNetwork	虛擬網路的描述。	VirtualNetworkProfile （必要）
vnetName	App Service 環境的虛擬網路名稱。	字串
vnetResourceGroupName	虛擬網路的資源群組。	字串
vnetSubnetName	虛擬網路的子網。	字串
workerPools	描述每個集區中具有背景工作角色大小標識碼、VM 大小和背景工作角色數目的背景工作集區。	WorkerPool[] （必要）

Microsoft.Web/hostingEnvironments

名字	描述	價值
類	資源種類。	字串
位置	資源位置。	字串（必要）
名字	資源名稱	字串（必要）
性能	核心資源屬性	AppServiceEnvironment
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.Web/hostingEnvironments@2018-02-01”

NameValuePair

名字	描述	價值
名字	配對名稱。	字串
價值	配對值。	字串

NetworkAccessControlEntry

名字	描述	價值
行動	Action 物件。	'Deny' 'Permit'
描述	網路訪問控制專案的描述。	字串
次序	優先順序。	int
remoteSubnet	遠端子網。	字串

ResourceTags

名字	描述	價值

VirtualNetworkProfile

名字	描述	價值
id	虛擬網路的資源識別碼。	字串
子	虛擬網路內的子網。	字串

WorkerPool

名字	描述	價值
computeMode	共用或專用的應用程式裝載。	'Dedicated' 'Dynamic' 'Shared'
workerCount	背景工作集區中的實例數目。	int
workerSize	背景工作集區實例的 VM 大小。	字串
workerSizeId	參考此背景工作集區的背景工作大小標識碼。	int

共用方式為

Microsoft.Web hostingEnvironments 2018-02-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

意見反應

其他資源

共用方式為

Microsoft.Web hostingEnvironments 2018-02-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

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義