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

Definição de recurso do Bicep

O tipo de recurso hostingEnvironments pode ser implementado com operações que visam:

Grupos de recursos – veja os comandos de implementação do grupo de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Web/hostingEnvironments, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Web/hostingEnvironments@2022-09-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
  }
}

Valores de propriedade

hostingEnvironments

Nome	Descrição	Valor
name	O nome do recurso	cadeia (obrigatório)
localização	Localização do Recurso.	cadeia (obrigatório)
etiquetas	Etiquetas de recursos.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
tipo	Tipo de recurso.	string
propriedades	Principais propriedades do recurso	AppServiceEnvironment

AppServiceEnvironment

Nome	Descrição	Valor
clusterDefinições	Definições personalizadas para alterar o comportamento do Ambiente do Serviço de Aplicações.	NameValuePair[]
customDnsSuffixConfiguration	Vista completa da configuração do sufixo de domínio personalizado para ASEv3.	CustomDnsSuffixConfiguration
dedicatedHostCount	Contagem de Anfitriões Dedicados	int
dnsSuffix	Sufixo DNS da Ambiente do Serviço de Aplicações.	string
frontEndScaleFactor	Fator de dimensionamento para front-ends.	int
internalLoadBalancingMode	Especifica os pontos finais a servir internamente na Rede Virtual para o Ambiente do Serviço de Aplicações.	"Nenhum" "Publicação" "Web" "Web, Publicação"
ipsslAddressCount	Número de endereços SSL ip reservados para o Ambiente do Serviço de Aplicações.	int
múltiplos tamanhos	Tamanho da VM de front-end, por exemplo, "Médio", "Grande".	string
networkingConfiguration	Vista completa da configuração de rede para um ASE.	AseV3NetworkingConfiguration
upgradePreference	Preferência de Atualização	"Cedo" "Atrasado" "Manual" "Nenhum"
userWhitelistedIpRanges	O utilizador adicionou intervalos ip para permitir na base de dados DO ASE	string[]
virtualNetwork	Descrição do Rede Virtual.	VirtualNetworkProfile (obrigatório)
zoneRedundant	Se esta Ambiente do Serviço de Aplicações é ou não redundante na zona.	bool

NameValuePair

Nome	Descrição	Valor
name	Nome do par.	string
valor	Emparelhar valor.	string

CustomDnsSuffixConfiguration

Nome	Descrição	Valor
tipo	Tipo de recurso.	string
propriedades	Propriedades específicas do recurso CustomDnsSuffixConfiguration	CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

Nome	Descrição	Valor
certificateUrl	O URL que referencia o segredo do certificado Key Vault do Azure que deve ser utilizado como o certificado SSL/TLS predefinido para sites com o sufixo de domínio personalizado.	string
dnsSufixo	O sufixo de domínio personalizado predefinido a utilizar para todos os sites implementados no ASE.	string
keyVaultReferenceIdentity	A identidade atribuída pelo utilizador a utilizar para resolver a referência do certificado do cofre de chaves. Se não for especificado, a identidade ASE atribuída pelo sistema será utilizada, se disponível.	string

AseV3NetworkingConfiguration

Nome	Descrição	Valor
tipo	Tipo de recurso.	string
propriedades	Propriedades específicas do recurso AseV3NetworkingConfiguration	AseV3NetworkingConfigurationProperties

AseV3NetworkingConfigurationProperties

Nome	Descrição	Valor
allowNewPrivateEndpointConnections	Propriedade para ativar e desativar a criação de nova ligação de ponto final privado no ASE	bool
ftpEnabled	Propriedade para ativar e desativar o FTP no ASEV3	bool
inboundIpAddressOverride	O cliente forneceu o Endereço IP de Entrada. Só é possível definir na criação do Ase.	string
remoteDebugEnabled	Propriedade para ativar e desativar a Depuração Remota no ASEV3	bool

VirtualNetworkProfile

Nome	Descrição	Valor
ID	ID de recurso do Rede Virtual.	cadeia (obrigatório)
sub-rede	Sub-rede na Rede Virtual.	string

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
ILB Ambiente do Serviço de Aplicações com Azure Firewall	Resource Manager modelos e parâmetros que demonstram como implementar Serviço de Aplicações ambiente com integração Azure Firewall
Ambiente do Serviço de Aplicações com SQL do Azure back-end	Este modelo cria um Ambiente do Serviço de Aplicações com um back-end SQL do Azure juntamente com pontos finais privados, juntamente com recursos associados normalmente utilizados num ambiente privado/isolado.
Ambiente do Serviço de Aplicações com o Plano de Alojamento e o Azure WebApp	Cria um Ambiente do Serviço de Aplicações v2 com um Endereço ILB numa rede virtual existente que será disponível em privado. O Ambiente do Serviço de Aplicações irá conter um Plano de Alojamento e uma Aplicação Web do Azure
Criar Serviço de Aplicações do Azure ambiente com uma aplicação Web adicionada	Cria um Ambiente de Serviço de Aplicações do Azure dentro da Sub-rede A Rede Virtual. Este modelo também adiciona uma Aplicação Web do Azure dentro do Ambiente do Serviço de Aplicações. Modelo originalmente criado por Callum Brankin da PixelPin
Criar um Ambiente do Serviço de Aplicações	Cria uma Ambiente do Serviço de Aplicações na sua rede virtual
Certificado SSL para um ASE ILB ou um ASE V2 do ILB	Configura o certificado SSL predefinido para um ASE ILB ou ASE v2 ILB
Criar Ambiente do Serviço de Aplicações com um Endereço ILB	Cria um Ambiente do Serviço de Aplicações na sua rede virtual com um endereço de balanceador de carga interno privado
Criar um Ambiente do Serviço de Aplicações v2	Cria um Ambiente do Serviço de Aplicações v2 na sua rede virtual
Criar um Ambiente de Serviço de Aplicações v2 com um Endereço ILB	Cria um Ambiente do Serviço de Aplicações v2 na sua rede virtual com um endereço de balanceador de carga interno privado
Criar um AppServicePlan e uma Aplicação num ASEv3	Criar um AppServicePlan e uma Aplicação num ASEv3

Definição de recurso de modelo do ARM

O tipo de recurso hostingEnvironments pode ser implementado com operações que visam:

Grupos de recursos – veja comandos de implementação de grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Web/hostingEnvironments, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Web/hostingEnvironments",
  "apiVersion": "2022-09-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"
  }
}

Valores de propriedade

hostingEnvironments

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Web/hostingEnvironments"
apiVersion	A versão da API de recursos	'2022-09-01'
name	O nome do recurso	cadeia (obrigatório)
localização	Localização do Recurso.	cadeia (obrigatório)
etiquetas	Etiquetas de recursos.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
tipo	Tipo de recurso.	string
propriedades	Principais propriedades do recurso	AppServiceEnvironment

AppServiceEnvironment

Nome	Descrição	Valor
clusterDefinições	Definições personalizadas para alterar o comportamento do Ambiente do Serviço de Aplicações.	NameValuePair[]
customDnsSuffixConfiguration	Vista completa da configuração do sufixo de domínio personalizado para ASEv3.	CustomDnsSuffixConfiguration
dedicatedHostCount	Contagem de Anfitriões Dedicados	int
dnsSuffix	Sufixo DNS da Ambiente do Serviço de Aplicações.	string
frontEndScaleFactor	Fator de dimensionamento para front-ends.	int
internalLoadBalancingMode	Especifica os pontos finais a servir internamente na Rede Virtual para o Ambiente do Serviço de Aplicações.	"Nenhum" "Publicação" "Web" "Web, Publicação"
ipsslAddressCount	Número de endereços SSL ip reservados para o Ambiente do Serviço de Aplicações.	int
múltiplos tamanhos	Tamanho da VM de front-end, por exemplo, "Médio", "Grande".	string
networkingConfiguration	Vista completa da configuração de rede para um ASE.	AseV3NetworkingConfiguration
upgradePreference	Preferência de Atualização	"Cedo" "Atrasado" "Manual" "Nenhum"
userWhitelistedIpRanges	O utilizador adicionou intervalos ip para permitir na base de dados DO ASE	string[]
virtualNetwork	Descrição do Rede Virtual.	VirtualNetworkProfile (obrigatório)
zoneRedundant	Se esta Ambiente do Serviço de Aplicações é ou não redundante na zona.	bool

NameValuePair

Nome	Descrição	Valor
name	Nome do par.	string
valor	Emparelhar valor.	string

CustomDnsSuffixConfiguration

Nome	Descrição	Valor
tipo	Tipo de recurso.	string
propriedades	Propriedades específicas do recurso CustomDnsSuffixConfiguration	CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

Nome	Descrição	Valor
certificateUrl	O URL que referencia o segredo do certificado Key Vault do Azure que deve ser utilizado como o certificado SSL/TLS predefinido para sites com o sufixo de domínio personalizado.	string
dnsSufixo	O sufixo de domínio personalizado predefinido a utilizar para todos os sites implementados no ASE.	string
keyVaultReferenceIdentity	A identidade atribuída pelo utilizador a utilizar para resolver a referência do certificado do cofre de chaves. Se não for especificado, a identidade ASE atribuída pelo sistema será utilizada, se disponível.	string

AseV3NetworkingConfiguration

Nome	Descrição	Valor
tipo	Tipo de recurso.	string
propriedades	Propriedades específicas do recurso AseV3NetworkingConfiguration	AseV3NetworkingConfigurationProperties

AseV3NetworkingConfigurationProperties

Nome	Descrição	Valor
allowNewPrivateEndpointConnections	Propriedade para ativar e desativar a criação de nova ligação de ponto final privado no ASE	bool
ftpEnabled	Propriedade para ativar e desativar o FTP no ASEV3	bool
inboundIpAddressOverride	O cliente forneceu o Endereço IP de Entrada. Só é possível definir na criação do Ase.	string
remoteDebugEnabled	Propriedade para ativar e desativar a Depuração Remota no ASEV3	bool

VirtualNetworkProfile

Nome	Descrição	Valor
ID	ID de recurso do Rede Virtual.	cadeia (obrigatório)
sub-rede	Sub-rede na Rede Virtual.	string

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
ILB Ambiente do Serviço de Aplicações com Azure Firewall	Resource Manager modelos e parâmetros que demonstram como implementar Serviço de Aplicações ambiente com integração Azure Firewall
Ambiente do Serviço de Aplicações com SQL do Azure back-end	Este modelo cria um Ambiente do Serviço de Aplicações com um back-end SQL do Azure juntamente com pontos finais privados, juntamente com recursos associados normalmente utilizados num ambiente privado/isolado.
Ambiente do Serviço de Aplicações com o Plano de Alojamento e o Azure WebApp	Cria um Ambiente do Serviço de Aplicações v2 com um Endereço ILB numa rede virtual existente que será disponível em privado. O Ambiente do Serviço de Aplicações irá conter um Plano de Alojamento e uma Aplicação Web do Azure
Criar Serviço de Aplicações do Azure ambiente com uma aplicação Web adicionada	Cria um Ambiente de Serviço de Aplicações do Azure dentro da Sub-rede A Rede Virtual. Este modelo também adiciona uma Aplicação Web do Azure dentro do Ambiente do Serviço de Aplicações. Modelo originalmente criado por Callum Brankin da PixelPin
Criar um Ambiente do Serviço de Aplicações	Cria uma Ambiente do Serviço de Aplicações na sua rede virtual
Certificado SSL para um ASE ILB ou um ASE V2 do ILB	Configura o certificado SSL predefinido para um ASE ILB ou ASE v2 ILB
Criar Ambiente do Serviço de Aplicações com um Endereço ILB	Cria um Ambiente do Serviço de Aplicações na sua rede virtual com um endereço de balanceador de carga interno privado
Criar um Ambiente do Serviço de Aplicações v2	Cria um Ambiente do Serviço de Aplicações v2 na sua rede virtual
Criar um Ambiente de Serviço de Aplicações v2 com um Endereço ILB	Cria um Ambiente do Serviço de Aplicações v2 na sua rede virtual com um endereço de balanceador de carga interno privado
Criar um AppServicePlan e uma Aplicação num ASEv3	Criar um AppServicePlan e uma Aplicação num ASEv3

Definição de recurso do Terraform (fornecedor AzAPI)

O tipo de recurso hostingEnvironments pode ser implementado com operações que visam:

Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Web/hostingEnvironments, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/hostingEnvironments@2022-09-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"
  })
}

Valores de propriedade

hostingEnvironments

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Web/hostingEnvironments@2022-09-01"
name	O nome do recurso	cadeia (obrigatório)
localização	Localização do Recurso.	cadeia (obrigatório)
parent_id	Para implementar num grupo de recursos, utilize o ID desse grupo de recursos.	cadeia (obrigatório)
etiquetas	Etiquetas de recursos.	Dicionário de nomes e valores de etiquetas.
tipo	Tipo de recurso.	string
propriedades	Principais propriedades do recurso	AppServiceEnvironment

AppServiceEnvironment

Nome	Descrição	Valor
clusterDefinições	Definições personalizadas para alterar o comportamento do Ambiente do Serviço de Aplicações.	NameValuePair[]
customDnsSuffixConfiguration	Vista completa da configuração do sufixo de domínio personalizado para ASEv3.	CustomDnsSuffixConfiguration
dedicatedHostCount	Contagem de Anfitriões Dedicados	int
dnsSuffix	Sufixo DNS da Ambiente do Serviço de Aplicações.	string
frontEndScaleFactor	Fator de dimensionamento para front-ends.	int
internalLoadBalancingMode	Especifica os pontos finais a servir internamente na Rede Virtual para o Ambiente do Serviço de Aplicações.	"Nenhum" "Publicação" "Web" "Web, Publicação"
ipsslAddressCount	Número de endereços SSL ip reservados para o Ambiente do Serviço de Aplicações.	int
múltiplos tamanhos	Tamanho da VM de front-end, por exemplo, "Médio", "Grande".	string
networkingConfiguration	Vista completa da configuração de rede para um ASE.	AseV3NetworkingConfiguration
upgradePreference	Preferência de Atualização	"Cedo" "Atrasado" "Manual" "Nenhum"
userWhitelistedIpRanges	O utilizador adicionou intervalos ip para permitir na base de dados DO ASE	string[]
virtualNetwork	Descrição do Rede Virtual.	VirtualNetworkProfile (obrigatório)
zoneRedundant	Se esta Ambiente do Serviço de Aplicações é ou não redundante na zona.	bool

NameValuePair

Nome	Descrição	Valor
name	Nome do par.	string
valor	Emparelhar valor.	string

CustomDnsSuffixConfiguration

Nome	Descrição	Valor
tipo	Tipo de recurso.	string
propriedades	Propriedades específicas do recurso CustomDnsSuffixConfiguration	CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

Nome	Descrição	Valor
certificateUrl	O URL que referencia o segredo do certificado do Azure Key Vault que deve ser utilizado como o certificado SSL/TLS predefinido para sites com o sufixo de domínio personalizado.	string
dnsSuffix	O sufixo de domínio personalizado predefinido a utilizar para todos os sites implementados no ASE.	string
keyVaultReferenceIdentity	A identidade atribuída pelo utilizador a utilizar para resolver a referência do certificado do cofre de chaves. Se não for especificado, a identidade do ASE atribuída pelo sistema será utilizada, se disponível.	string

AseV3NetworkingConfiguration

Nome	Descrição	Valor
tipo	Tipo de recurso.	string
propriedades	Propriedades específicas do recurso AseV3NetworkingConfiguration	AseV3NetworkingConfigurationProperties

AseV3NetworkingConfigurationProperties

Nome	Descrição	Valor
allowNewPrivateEndpointConnections	Propriedade para ativar e desativar a criação de nova ligação de ponto final privado no ASE	bool
ftpEnabled	Propriedade para ativar e desativar o FTP no ASEV3	bool
inboundIpAddressOverride	O cliente forneceu o Endereço IP de Entrada. Só é possível definir a criação do Ase.	string
remoteDebugEnabled	Propriedade para ativar e desativar a Depuração Remota no ASEV3	bool

VirtualNetworkProfile

Nome	Descrição	Valor
ID	ID do recurso do Rede Virtual.	cadeia (obrigatório)
sub-rede	Sub-rede na Rede Virtual.	string

Partilhar via

Microsoft.Web hostingEnvironments

Definição de recurso do Bicep

Formato do recurso

Valores de propriedade

hostingEnvironments

AppServiceEnvironment

NameValuePair

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

VirtualNetworkProfile

Modelos de início rápido

Definição de recurso de modelo do ARM

Formato do recurso

Valores de propriedade

hostingEnvironments

AppServiceEnvironment

NameValuePair

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

VirtualNetworkProfile

Modelos de início rápido

Definição de recurso do Terraform (fornecedor AzAPI)

Formato do recurso

Valores de propriedade

hostingEnvironments

AppServiceEnvironment

NameValuePair

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

VirtualNetworkProfile

Comentários

Recursos adicionais