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

Définition de ressource Bicep

Le type de ressource hostingEnvironments peut être déployé avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Web/hostingEnvironments, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

AppServiceEnvironment

Nom	Description	Valeur
clusterSettings	Paramètres personnalisés pour modifier le comportement de l’environnement App Service.	NameValuePair[]
customDnsSuffixConfiguration	Vue complète de la configuration du suffixe de domaine personnalisé pour ASEv3.	CustomDnsSuffixConfiguration
dedicatedHostCount	Nombre d’hôtes dédiés	Int
dnsSuffix	Suffixe DNS de l’environnement App Service.	corde
frontEndScaleFactor	Facteur d’échelle pour les serveurs frontaux.	Int
internalLoadBalancingMode	Spécifie les points de terminaison à servir en interne dans le réseau virtuel pour l’environnement App Service.	'None' 'Publication' 'Web' 'Web, Publication'
ipsslAddressCount	Nombre d’adresses SSL IP réservées à l’environnement App Service.	Int
multiSize	Taille de machine virtuelle frontale, par exemple « Moyen », « Large ».	corde
networkingConfiguration	Vue complète de la configuration réseau d’un ENVIRONNEMENT ASE.	AseV3NetworkingConfiguration
upgradePreference	Préférence de mise à niveau	'Tôt' 'Late' 'Manuel' 'None'
userWhitelistedIpRanges	Plages d’adresses IP ajoutées par l’utilisateur à la liste verte sur la base de données ASE	string[]
virtualNetwork	Description du réseau virtuel.	virtualNetworkProfile (obligatoire)
zoneRedundant	Indique si cet environnement App Service Est redondant interzone ou non.	Bool

AseV3NetworkingConfiguration

Nom	Description	Valeur
gentil	Type de ressource.	corde
Propriétés	Propriétés spécifiques de la ressource AseV3NetworkingConfiguration	AseV3NetworkingConfigurationProperties

AseV3NetworkingConfigurationProperties

Nom	Description	Valeur
allowNewPrivateEndpointConnections	Propriété permettant d’activer et de désactiver la création d’une nouvelle connexion de point de terminaison privé sur ASE	Bool
ftpEnabled	Propriété permettant d’activer et de désactiver FTP sur ASEV3	Bool
inboundIpAddressOverride	Le client a fourni une adresse IP entrante. Seule la possibilité d’être définie sur Ase create.	corde
remoteDebugEnabled	Propriété permettant d’activer et de désactiver le débogage distant sur ASEV3	Bool

CustomDnsSuffixConfiguration

Nom	Description	Valeur
gentil	Type de ressource.	corde
Propriétés	Propriétés spécifiques de la ressource CustomDnsSuffixConfiguration	CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

Nom	Description	Valeur
certificateUrl	URL référençant le secret de certificat Azure Key Vault qui doit être utilisé comme certificat SSL/TLS par défaut pour les sites avec le suffixe de domaine personnalisé.	corde
dnsSuffix	Suffixe de domaine personnalisé par défaut à utiliser pour tous les sites déployés sur l’ASE.	corde
keyVaultReferenceIdentity	Identité affectée par l’utilisateur à utiliser pour résoudre la référence du certificat key vault. Si elle n’est pas spécifiée, l’identité ASE affectée par le système est utilisée si disponible.	corde

Microsoft.Web/hostingEnvironments

Nom	Description	Valeur
gentil	Type de ressource.	corde
emplacement	Emplacement de la ressource.	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés de ressources principales	AppServiceEnvironment
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

NameValuePair

Nom	Description	Valeur
nom	Nom de paire.	corde
valeur	Valeur de paire.	corde

ResourceTags

Nom	Description	Valeur

VirtualNetworkProfile

Nom	Description	Valeur
id	ID de ressource du réseau virtuel.	chaîne (obligatoire)
sous-réseau	Sous-réseau au sein du réseau virtuel.	corde

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep	Description
Environnement App Service avec plan d’hébergement et Azure WebApp	Crée un environnement App Service Environment v2 avec une adresse ILB dans un réseau virtuel existant qui sera disponible en privé. L’environnement App Service contient un plan d’hébergement et une application web Azure
Créer un environnement App Service Environment v2	Crée un environnement App Service v2 dans votre réseau virtuel
créer un appServicePlan et une application dans un ASEv3	Créer un AppServicePlan et une application dans un ASEv3

Définition de ressource de modèle ARM

Le type de ressource hostingEnvironments peut être déployé avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Web/hostingEnvironments, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Web/hostingEnvironments",
  "apiVersion": "2022-09-01",
  "name": "string",
  "kind": "string",
  "location": "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

AppServiceEnvironment

Nom	Description	Valeur
clusterSettings	Paramètres personnalisés pour modifier le comportement de l’environnement App Service.	NameValuePair[]
customDnsSuffixConfiguration	Vue complète de la configuration du suffixe de domaine personnalisé pour ASEv3.	CustomDnsSuffixConfiguration
dedicatedHostCount	Nombre d’hôtes dédiés	Int
dnsSuffix	Suffixe DNS de l’environnement App Service.	corde
frontEndScaleFactor	Facteur d’échelle pour les serveurs frontaux.	Int
internalLoadBalancingMode	Spécifie les points de terminaison à servir en interne dans le réseau virtuel pour l’environnement App Service.	'None' 'Publication' 'Web' 'Web, Publication'
ipsslAddressCount	Nombre d’adresses SSL IP réservées à l’environnement App Service.	Int
multiSize	Taille de machine virtuelle frontale, par exemple « Moyen », « Large ».	corde
networkingConfiguration	Vue complète de la configuration réseau d’un ENVIRONNEMENT ASE.	AseV3NetworkingConfiguration
upgradePreference	Préférence de mise à niveau	'Tôt' 'Late' 'Manuel' 'None'
userWhitelistedIpRanges	Plages d’adresses IP ajoutées par l’utilisateur à la liste verte sur la base de données ASE	string[]
virtualNetwork	Description du réseau virtuel.	virtualNetworkProfile (obligatoire)
zoneRedundant	Indique si cet environnement App Service Est redondant interzone ou non.	Bool

AseV3NetworkingConfiguration

Nom	Description	Valeur
gentil	Type de ressource.	corde
Propriétés	Propriétés spécifiques de la ressource AseV3NetworkingConfiguration	AseV3NetworkingConfigurationProperties

AseV3NetworkingConfigurationProperties

Nom	Description	Valeur
allowNewPrivateEndpointConnections	Propriété permettant d’activer et de désactiver la création d’une nouvelle connexion de point de terminaison privé sur ASE	Bool
ftpEnabled	Propriété permettant d’activer et de désactiver FTP sur ASEV3	Bool
inboundIpAddressOverride	Le client a fourni une adresse IP entrante. Seule la possibilité d’être définie sur Ase create.	corde
remoteDebugEnabled	Propriété permettant d’activer et de désactiver le débogage distant sur ASEV3	Bool

CustomDnsSuffixConfiguration

Nom	Description	Valeur
gentil	Type de ressource.	corde
Propriétés	Propriétés spécifiques de la ressource CustomDnsSuffixConfiguration	CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

Nom	Description	Valeur
certificateUrl	URL référençant le secret de certificat Azure Key Vault qui doit être utilisé comme certificat SSL/TLS par défaut pour les sites avec le suffixe de domaine personnalisé.	corde
dnsSuffix	Suffixe de domaine personnalisé par défaut à utiliser pour tous les sites déployés sur l’ASE.	corde
keyVaultReferenceIdentity	Identité affectée par l’utilisateur à utiliser pour résoudre la référence du certificat key vault. Si elle n’est pas spécifiée, l’identité ASE affectée par le système est utilisée si disponible.	corde

Microsoft.Web/hostingEnvironments

Nom	Description	Valeur
apiVersion	Version de l’API	'2022-09-01'
gentil	Type de ressource.	corde
emplacement	Emplacement de la ressource.	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés de ressources principales	AppServiceEnvironment
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type	Type de ressource	'Microsoft.Web/hostingEnvironments'

NameValuePair

Nom	Description	Valeur
nom	Nom de paire.	corde
valeur	Valeur de paire.	corde

ResourceTags

Nom	Description	Valeur

VirtualNetworkProfile

Nom	Description	Valeur
id	ID de ressource du réseau virtuel.	chaîne (obligatoire)
sous-réseau	Sous-réseau au sein du réseau virtuel.	corde

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
App Service Environment avec le serveur principal Azure SQL	Ce modèle crée un environnement App Service avec un back-end Azure SQL, ainsi que des points de terminaison privés, ainsi que des ressources associées généralement utilisées dans un environnement privé/isolé.
Environnement App Service avec plan d’hébergement et Azure WebApp	Crée un environnement App Service Environment v2 avec une adresse ILB dans un réseau virtuel existant qui sera disponible en privé. L’environnement App Service contient un plan d’hébergement et une application web Azure
Créer un App Service Environment	Crée un environnement App Service dans votre réseau virtuel
Créer un environnement App Service Environment v2	Crée un environnement App Service v2 dans votre réseau virtuel
créer un appServicePlan et une application dans un ASEv3	Créer un AppServicePlan et une application dans un ASEv3
Créer un environnement App Service Environment v2 avec une adresse ILB	Crée un environnement App Service Environment v2 dans votre réseau virtuel avec une adresse d’équilibreur de charge interne privée
créer un environnement App Service avec une adresse ILB	Crée un environnement App Service dans votre réseau virtuel avec une adresse d’équilibreur de charge interne privée
créer un environnement Azure App Service avec une application web ajoutée	Crée un environnement Azure App Service à l’intérieur d’un sous-réseau de réseau virtuel. Ce modèle ajoute également une application web Azure dans l’environnement App Service. Modèle créé à l’origine par Callum Brankin de PixelPin
environnement App Service ILB avec le pare-feu Azure	Modèles et paramètres Resource Manager montrant comment déployer un environnement App Service avec l’intégration du Pare-feu Azure
certificat SSL pour un ASE ILB ou un ILB ASE v2	Configure le certificat SSL par défaut pour un ASE ILB ou un ASE ILB v2

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource hostingEnvironments peut être déployé avec des opérations qui ciblent :

groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Web/hostingEnvironments, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/hostingEnvironments@2022-09-01"
  name = "string"
  kind = "string"
  location = "string"
  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
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Valeurs de propriété

AppServiceEnvironment

Nom	Description	Valeur
clusterSettings	Paramètres personnalisés pour modifier le comportement de l’environnement App Service.	NameValuePair[]
customDnsSuffixConfiguration	Vue complète de la configuration du suffixe de domaine personnalisé pour ASEv3.	CustomDnsSuffixConfiguration
dedicatedHostCount	Nombre d’hôtes dédiés	Int
dnsSuffix	Suffixe DNS de l’environnement App Service.	corde
frontEndScaleFactor	Facteur d’échelle pour les serveurs frontaux.	Int
internalLoadBalancingMode	Spécifie les points de terminaison à servir en interne dans le réseau virtuel pour l’environnement App Service.	'None' 'Publication' 'Web' 'Web, Publication'
ipsslAddressCount	Nombre d’adresses SSL IP réservées à l’environnement App Service.	Int
multiSize	Taille de machine virtuelle frontale, par exemple « Moyen », « Large ».	corde
networkingConfiguration	Vue complète de la configuration réseau d’un ENVIRONNEMENT ASE.	AseV3NetworkingConfiguration
upgradePreference	Préférence de mise à niveau	'Tôt' 'Late' 'Manuel' 'None'
userWhitelistedIpRanges	Plages d’adresses IP ajoutées par l’utilisateur à la liste verte sur la base de données ASE	string[]
virtualNetwork	Description du réseau virtuel.	virtualNetworkProfile (obligatoire)
zoneRedundant	Indique si cet environnement App Service Est redondant interzone ou non.	Bool

AseV3NetworkingConfiguration

Nom	Description	Valeur
gentil	Type de ressource.	corde
Propriétés	Propriétés spécifiques de la ressource AseV3NetworkingConfiguration	AseV3NetworkingConfigurationProperties

AseV3NetworkingConfigurationProperties

Nom	Description	Valeur
allowNewPrivateEndpointConnections	Propriété permettant d’activer et de désactiver la création d’une nouvelle connexion de point de terminaison privé sur ASE	Bool
ftpEnabled	Propriété permettant d’activer et de désactiver FTP sur ASEV3	Bool
inboundIpAddressOverride	Le client a fourni une adresse IP entrante. Seule la possibilité d’être définie sur Ase create.	corde
remoteDebugEnabled	Propriété permettant d’activer et de désactiver le débogage distant sur ASEV3	Bool

CustomDnsSuffixConfiguration

Nom	Description	Valeur
gentil	Type de ressource.	corde
Propriétés	Propriétés spécifiques de la ressource CustomDnsSuffixConfiguration	CustomDnsSuffixConfigurationProperties

CustomDnsSuffixConfigurationProperties

Nom	Description	Valeur
certificateUrl	URL référençant le secret de certificat Azure Key Vault qui doit être utilisé comme certificat SSL/TLS par défaut pour les sites avec le suffixe de domaine personnalisé.	corde
dnsSuffix	Suffixe de domaine personnalisé par défaut à utiliser pour tous les sites déployés sur l’ASE.	corde
keyVaultReferenceIdentity	Identité affectée par l’utilisateur à utiliser pour résoudre la référence du certificat key vault. Si elle n’est pas spécifiée, l’identité ASE affectée par le système est utilisée si disponible.	corde

Microsoft.Web/hostingEnvironments

Nom	Description	Valeur
gentil	Type de ressource.	corde
emplacement	Emplacement de la ressource.	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés de ressources principales	AppServiceEnvironment
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.Web/hostingEnvironments@2022-09-01 »

NameValuePair

Nom	Description	Valeur
nom	Nom de paire.	corde
valeur	Valeur de paire.	corde

ResourceTags

Nom	Description	Valeur

VirtualNetworkProfile

Nom	Description	Valeur
id	ID de ressource du réseau virtuel.	chaîne (obligatoire)
sous-réseau	Sous-réseau au sein du réseau virtuel.	corde

Partager via

Microsoft.Web hostingEnvironments 2022-09-01

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

AppServiceEnvironment

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

Microsoft.Web/hostingEnvironments

NameValuePair

ResourceTags

VirtualNetworkProfile

Exemples de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

AppServiceEnvironment

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

Microsoft.Web/hostingEnvironments

NameValuePair

ResourceTags

VirtualNetworkProfile

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

AppServiceEnvironment

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

Microsoft.Web/hostingEnvironments

NameValuePair

ResourceTags

VirtualNetworkProfile

Commentaires

Ressources supplémentaires