App Service Environments - Create Or Update
Description pour Create ou mettre à jour un App Service Environment.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}?api-version=2023-12-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
name
|
path | True |
string |
Nom du App Service Environment. |
resource
|
path | True |
string |
Nom du groupe de ressources auquel appartient la ressource. Regex pattern: |
subscription
|
path | True |
string |
Votre ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 000000-0000-0000-0000-000000000000000). |
api-version
|
query | True |
string |
Version d'API |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
location | True |
string |
Emplacement de la ressource. |
properties.virtualNetwork | True |
Description du Réseau virtuel. |
|
kind |
string |
Type de ressource. |
|
properties.clusterSettings |
Paramètres personnalisés pour modifier le comportement du App Service Environment. |
||
properties.customDnsSuffixConfiguration |
Vue d’ensemble de la configuration du suffixe de domaine personnalisé pour ASEv3. |
||
properties.dedicatedHostCount |
integer |
Nombre d’hôtes dédiés |
|
properties.dnsSuffix |
string |
Suffixe DNS du App Service Environment. |
|
properties.frontEndScaleFactor |
integer |
Facteur de mise à l’échelle pour les serveurs frontaux. |
|
properties.internalLoadBalancingMode |
Spécifie les points de terminaison à servir en interne dans le Réseau virtuel pour le App Service Environment. |
||
properties.ipsslAddressCount |
integer |
Nombre d’adresses IP SSL réservées pour le App Service Environment. |
|
properties.multiSize |
string |
Taille de la machine virtuelle frontale, par exemple « Moyenne », « Grande ». |
|
properties.networkingConfiguration |
Vue d’ensemble de la configuration réseau pour un ASE. |
||
properties.upgradePreference |
Préférence de mise à niveau |
||
properties.userWhitelistedIpRanges |
string[] |
L’utilisateur a ajouté des plages d’adresses IP à la liste verte sur la base de données ASE |
|
properties.zoneRedundant |
boolean |
Indique si cette App Service Environment est redondante interzone ou non. |
|
tags |
object |
Balises de ressource. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Ok |
|
201 Created |
Date de création |
|
202 Accepted |
L’opération est en cours. Headers location: string |
|
Other Status Codes |
App Service réponse d’erreur. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
Create or update an App Service Environment.
Sample Request
PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase?api-version=2023-12-01
{
"kind": "Asev3",
"location": "South Central US",
"properties": {
"virtualNetwork": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/delegated"
}
}
}
Sample Response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
"name": "test-ase",
"type": "Microsoft.Web/hostingEnvironments",
"kind": "ASEV3",
"location": "South Central US",
"tags": {},
"properties": {
"provisioningState": "Succeeded",
"status": "Ready",
"virtualNetwork": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
"name": "delegated",
"type": "Microsoft.Network/virtualNetworks/subnets",
"subnet": ""
},
"internalLoadBalancingMode": "None",
"multiSize": "Standard_D2d_v4",
"multiRoleCount": null,
"ipsslAddressCount": 0,
"dnsSuffix": "test-ase.p.azurewebsites.net",
"maximumNumberOfMachines": 250,
"frontEndScaleFactor": 15,
"suspended": false,
"clusterSettings": null,
"userWhitelistedIpRanges": null,
"hasLinuxWorkers": true,
"dedicatedHostCount": 0,
"zoneRedundant": false,
"networkingConfiguration": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
"properties": {
"windowsOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"linuxOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"externalInboundIpAddresses": [
"52.153.248.36"
],
"internalInboundIpAddresses": [],
"allowNewPrivateEndpointConnections": false,
"ftpEnabled": false,
"remoteDebugEnabled": false,
"inboundIpAddressOverride": null
}
}
}
}
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
"name": "test-ase",
"type": "Microsoft.Web/hostingEnvironments",
"kind": "ASEV3",
"location": "South Central US",
"tags": {},
"properties": {
"provisioningState": "Succeeded",
"status": "Ready",
"virtualNetwork": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
"name": "delegated",
"type": "Microsoft.Network/virtualNetworks/subnets",
"subnet": ""
},
"internalLoadBalancingMode": "None",
"multiSize": "Standard_D2d_v4",
"multiRoleCount": null,
"ipsslAddressCount": 0,
"dnsSuffix": "test-ase.p.azurewebsites.net",
"maximumNumberOfMachines": 250,
"frontEndScaleFactor": 15,
"suspended": false,
"clusterSettings": null,
"userWhitelistedIpRanges": null,
"hasLinuxWorkers": true,
"dedicatedHostCount": 0,
"zoneRedundant": false,
"networkingConfiguration": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
"properties": {
"windowsOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"linuxOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"externalInboundIpAddresses": [
"52.153.248.36"
],
"internalInboundIpAddresses": [],
"allowNewPrivateEndpointConnections": false,
"ftpEnabled": false,
"remoteDebugEnabled": false,
"inboundIpAddressOverride": null
}
}
}
}
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
"name": "test-ase",
"type": "Microsoft.Web/hostingEnvironments",
"kind": "ASEV3",
"location": "South Central US",
"tags": {},
"properties": {
"provisioningState": "Succeeded",
"status": "Ready",
"virtualNetwork": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
"name": "delegated",
"type": "Microsoft.Network/virtualNetworks/subnets",
"subnet": ""
},
"internalLoadBalancingMode": "None",
"multiSize": "Standard_D2d_v4",
"multiRoleCount": null,
"ipsslAddressCount": 0,
"dnsSuffix": "test-ase.p.azurewebsites.net",
"maximumNumberOfMachines": 250,
"frontEndScaleFactor": 15,
"suspended": false,
"clusterSettings": null,
"userWhitelistedIpRanges": null,
"hasLinuxWorkers": true,
"dedicatedHostCount": 0,
"zoneRedundant": false,
"networkingConfiguration": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
"properties": {
"windowsOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"linuxOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"externalInboundIpAddresses": [
"52.153.248.36"
],
"internalInboundIpAddresses": [],
"allowNewPrivateEndpointConnections": false,
"ftpEnabled": false,
"remoteDebugEnabled": false,
"inboundIpAddressOverride": null
}
}
}
}
Définitions
Nom | Description |
---|---|
App |
App Service Environment ressource ARM. |
AseV3Networking |
Vue d’ensemble de la configuration réseau pour un ASE. |
Custom |
Vue d’ensemble de la configuration du suffixe de domaine personnalisé pour ASEv3. |
Custom |
|
Default |
App Service réponse d’erreur. |
Details | |
Error |
Modèle d’erreur. |
Hosting |
Status actuelle du App Service Environment. |
Load |
Spécifie les points de terminaison à servir en interne dans le Réseau virtuel pour le App Service Environment. |
Name |
Paire de valeurs de nom. |
Provisioning |
État d’approvisionnement du App Service Environment. |
Upgrade |
Indique si une mise à niveau est disponible pour cette App Service Environment. |
Upgrade |
Préférence de mise à niveau |
Virtual |
Spécification pour l’utilisation d’un Réseau virtuel. |
AppServiceEnvironmentResource
App Service Environment ressource ARM.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
id |
string |
ID de ressource. |
|
kind |
string |
Type de ressource. |
|
location |
string |
Emplacement de la ressource. |
|
name |
string |
Nom de la ressource. |
|
properties.clusterSettings |
Paramètres personnalisés pour modifier le comportement du App Service Environment. |
||
properties.customDnsSuffixConfiguration |
Vue d’ensemble de la configuration du suffixe de domaine personnalisé pour ASEv3. |
||
properties.dedicatedHostCount |
integer |
Nombre d’hôtes dédiés |
|
properties.dnsSuffix |
string |
Suffixe DNS du App Service Environment. |
|
properties.frontEndScaleFactor |
integer |
Facteur de mise à l’échelle pour les serveurs frontaux. |
|
properties.hasLinuxWorkers |
boolean |
Indicateur qui indique si un ASE a des workers linux ou non |
|
properties.internalLoadBalancingMode |
Spécifie les points de terminaison à servir en interne dans le Réseau virtuel pour le App Service Environment. |
||
properties.ipsslAddressCount |
integer |
Nombre d’adresses IP SSL réservées pour le App Service Environment. |
|
properties.maximumNumberOfMachines |
integer |
Nombre maximal de machines virtuelles dans le App Service Environment. |
|
properties.multiRoleCount |
integer |
Nombre d’instances front-end. |
|
properties.multiSize |
string |
Taille de la machine virtuelle frontale, par exemple « Moyenne », « Grande ». |
|
properties.networkingConfiguration |
Vue d’ensemble de la configuration réseau pour un ASE. |
||
properties.provisioningState |
État d’approvisionnement du App Service Environment. |
||
properties.status |
Status actuelle du App Service Environment. |
||
properties.suspended |
boolean |
|
|
properties.upgradeAvailability |
Indique si une mise à niveau est disponible pour cette App Service Environment. |
||
properties.upgradePreference | None |
Préférence de mise à niveau |
|
properties.userWhitelistedIpRanges |
string[] |
L’utilisateur a ajouté des plages d’adresses IP à la liste verte sur la base de données ASE |
|
properties.virtualNetwork |
Description du Réseau virtuel. |
||
properties.zoneRedundant |
boolean |
Indique si cette App Service Environment est redondante interzone ou non. |
|
tags |
object |
Balises de ressource. |
|
type |
string |
Type de ressource. |
AseV3NetworkingConfiguration
Vue d’ensemble de la configuration réseau pour un ASE.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource. |
kind |
string |
Type de ressource. |
name |
string |
Nom de la ressource. |
properties.allowNewPrivateEndpointConnections |
boolean |
Propriété permettant d’activer et de désactiver la création d’une connexion de point de terminaison privé sur ASE |
properties.externalInboundIpAddresses |
string[] |
|
properties.ftpEnabled |
boolean |
Propriété permettant d’activer et de désactiver FTP sur ASEV3 |
properties.inboundIpAddressOverride |
string |
Adresse IP entrante fournie par le client. Ne peut être défini que sur Ase create. |
properties.internalInboundIpAddresses |
string[] |
|
properties.linuxOutboundIpAddresses |
string[] |
|
properties.remoteDebugEnabled |
boolean |
Propriété permettant d’activer et de désactiver le débogage distant sur ASEV3 |
properties.windowsOutboundIpAddresses |
string[] |
|
type |
string |
Type de ressource. |
CustomDnsSuffixConfiguration
Vue d’ensemble de la configuration du suffixe de domaine personnalisé pour ASEv3.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource. |
kind |
string |
Type de ressource. |
name |
string |
Nom de la ressource. |
properties.certificateUrl |
string |
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é. |
properties.dnsSuffix |
string |
Suffixe de domaine personnalisé par défaut à utiliser pour tous les sites déployés sur l’ASE. |
properties.keyVaultReferenceIdentity |
string |
Identité affectée par l’utilisateur à utiliser pour résoudre la référence de certificat de coffre de clés. Si elle n’est pas spécifiée, l’identité ASE affectée par le système est utilisée si disponible. |
properties.provisioningDetails |
string |
|
properties.provisioningState | ||
type |
string |
Type de ressource. |
CustomDnsSuffixProvisioningState
Nom | Type | Description |
---|---|---|
Degraded |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
DefaultErrorResponse
App Service réponse d’erreur.
Nom | Type | Description |
---|---|---|
error |
Modèle d’erreur. |
Details
Nom | Type | Description |
---|---|---|
code |
string |
Chaîne standardisée pour identifier l’erreur par programmation. |
message |
string |
Description détaillée de l’erreur et informations de débogage. |
target |
string |
Description détaillée de l’erreur et informations de débogage. |
Error
Modèle d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Chaîne standardisée pour identifier l’erreur par programmation. |
details |
Details[] |
Erreurs détaillées. |
innererror |
string |
Plus d’informations sur l’erreur de débogage. |
message |
string |
Description détaillée de l’erreur et informations de débogage. |
target |
string |
Description détaillée de l’erreur et informations de débogage. |
HostingEnvironmentStatus
Status actuelle du App Service Environment.
Nom | Type | Description |
---|---|---|
Deleting |
string |
|
Preparing |
string |
|
Ready |
string |
|
Scaling |
string |
LoadBalancingMode
Spécifie les points de terminaison à servir en interne dans le Réseau virtuel pour le App Service Environment.
Nom | Type | Description |
---|---|---|
None |
string |
|
Publishing |
string |
|
Web |
string |
|
Web, Publishing |
string |
NameValuePair
Paire de valeurs de nom.
Nom | Type | Description |
---|---|---|
name |
string |
Nom de la paire. |
value |
string |
Valeur de paire. |
ProvisioningState
État d’approvisionnement du App Service Environment.
Nom | Type | Description |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
UpgradeAvailability
Indique si une mise à niveau est disponible pour cette App Service Environment.
Nom | Type | Description |
---|---|---|
None |
string |
Aucune mise à niveau n’est actuellement disponible pour cette App Service Environment |
Ready |
string |
Une mise à niveau est prête à être lancée manuellement sur ce App Service Environment |
UpgradePreference
Préférence de mise à niveau
Nom | Type | Description |
---|---|---|
Early |
string |
Cette App Service Environment sera mise à niveau avant d’autres personnes de la même région dont la préférence de mise à niveau est « tardive » |
Late |
string |
Cette App Service Environment sera mise à niveau après d’autres personnes de la même région dont la préférence de mise à niveau est « précoce » |
Manual |
string |
ASEv3 uniquement. Une fois qu’une mise à niveau est disponible, cette App Service Environment attend 10 jours avant que la mise à niveau soit lancée manuellement. Après 10 jours, la mise à niveau commence automatiquement |
None |
string |
Aucune préférence sur le moment où cette App Service Environment sera mise à niveau |
VirtualNetworkProfile
Spécification pour l’utilisation d’un Réseau virtuel.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource du Réseau virtuel. |
name |
string |
Nom du Réseau virtuel (lecture seule). |
subnet |
string |
Sous-réseau dans le Réseau virtuel. |
type |
string |
Type de ressource du Réseau virtuel (lecture seule). |