App Service Environments - Get

Service:: App Service

Version d'API:: 2025-03-01

Description de Obtenir les propriétés d’un environnement App Service.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}?api-version=2025-03-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom de l’environnement App Service.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Nom du groupe de ressources auquel appartient la ressource.
subscriptionId	path	True	string	Votre ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 000000000-0000-0000-0000-00000000000000000000000).
api-version	query	True	string	Version de l’API

Réponses

Nom	Type	Description
200 OK	AppServiceEnvironmentResource	Ok
Other Status Codes	DefaultErrorResponse	Réponse d’erreur App Service.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get the properties of an App Service Environment.

Exemple de requête

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase?api-version=2025-03-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python app_service_environments_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.app_service_environments.get(
        resource_group_name="test-rg",
        name="test-ase",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/AppServiceEnvironments_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9f4cb2884f1948b879ecfb3f410e8cbc8805c213/specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/AppServiceEnvironments_Get.json
func ExampleEnvironmentsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEnvironmentsClient().Get(ctx, "test-rg", "test-ase", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.EnvironmentResource = armappservice.EnvironmentResource{
	// 	Name: to.Ptr("test-ase"),
	// 	Type: to.Ptr("Microsoft.Web/hostingEnvironments"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase"),
	// 	Kind: to.Ptr("ASEV3"),
	// 	Location: to.Ptr("South Central US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armappservice.Environment{
	// 		DedicatedHostCount: to.Ptr[int32](0),
	// 		DNSSuffix: to.Ptr("test-ase.p.azurewebsites.net"),
	// 		FrontEndScaleFactor: to.Ptr[int32](15),
	// 		HasLinuxWorkers: to.Ptr(true),
	// 		InternalLoadBalancingMode: to.Ptr(armappservice.LoadBalancingModeNone),
	// 		IpsslAddressCount: to.Ptr[int32](0),
	// 		MaximumNumberOfMachines: to.Ptr[int32](250),
	// 		MultiSize: to.Ptr("Standard_D2d_v4"),
	// 		NetworkingConfiguration: &armappservice.AseV3NetworkingConfiguration{
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking"),
	// 			Properties: &armappservice.AseV3NetworkingConfigurationProperties{
	// 				AllowNewPrivateEndpointConnections: to.Ptr(false),
	// 				ExternalInboundIPAddresses: []*string{
	// 					to.Ptr("52.153.248.36")},
	// 					FtpEnabled: to.Ptr(false),
	// 					InternalInboundIPAddresses: []*string{
	// 					},
	// 					LinuxOutboundIPAddresses: []*string{
	// 						to.Ptr("20.88.241.56"),
	// 						to.Ptr("20.88.241.9")},
	// 						RemoteDebugEnabled: to.Ptr(false),
	// 						WindowsOutboundIPAddresses: []*string{
	// 							to.Ptr("20.88.241.56"),
	// 							to.Ptr("20.88.241.9")},
	// 						},
	// 					},
	// 					ProvisioningState: to.Ptr(armappservice.ProvisioningStateSucceeded),
	// 					Status: to.Ptr(armappservice.HostingEnvironmentStatusReady),
	// 					Suspended: to.Ptr(false),
	// 					VirtualNetwork: &armappservice.VirtualNetworkProfile{
	// 						Name: to.Ptr("delegated"),
	// 						Type: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
	// 						ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated"),
	// 						Subnet: to.Ptr(""),
	// 					},
	// 					ZoneRedundant: to.Ptr(false),
	// 				},
	// 			}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Get the properties of an App Service Environment.
 *
 * @summary Description for Get the properties of an App Service Environment.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/AppServiceEnvironments_Get.json
 */
async function getThePropertiesOfAnAppServiceEnvironment() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "test-rg";
  const name = "test-ase";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.appServiceEnvironments.get(resourceGroupName, name);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:: 200

{
  "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
AppServiceEnvironmentResource	Ressource ARM de l’environnement App Service.
AseV3NetworkingConfiguration	Vue complète de la configuration réseau d’un ENVIRONNEMENT ASE.
CustomDnsSuffixConfiguration	Vue complète de la configuration du suffixe de domaine personnalisé pour ASEv3.
CustomDnsSuffixProvisioningState
DefaultErrorResponse	Réponse d’erreur App Service.
Details
Error	Modèle d’erreur.
HostingEnvironmentStatus	État actuel de l’environnement App Service.
LoadBalancingMode	Spécifie les points de terminaison à servir en interne dans le réseau virtuel pour l’environnement App Service.
NameValuePair	Paire nom-valeur.
ProvisioningState	État d’approvisionnement de l’environnement App Service.
UpgradeAvailability	Indique si une mise à niveau est disponible pour cet environnement App Service.
UpgradePreference	Préférence de mise à niveau
VirtualNetworkProfile	Spécification pour l’utilisation d’un réseau virtuel.

AppServiceEnvironmentResource

Objet

Ressource ARM de l’environnement App Service.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource.
kind	string		Type de ressource. Si la ressource est une application, vous pouvez faire référence à https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference pour plus d’informations sur les valeurs prises en charge pour le type.
location	string		Emplacement de la ressource.
name	string		Nom de la ressource.
properties.clusterSettings	NameValuePair[]		Paramètres personnalisés pour modifier le comportement de l’environnement App Service.
properties.customDnsSuffixConfiguration	CustomDnsSuffixConfiguration		Vue complète de la configuration du suffixe de domaine personnalisé pour ASEv3.
properties.dedicatedHostCount	integer (int32)		Nombre d’hôtes dédiés
properties.dnsSuffix	string		Suffixe DNS de l’environnement App Service.
properties.frontEndScaleFactor	integer (int32)		Facteur d’échelle pour les serveurs frontaux.
properties.hasLinuxWorkers	boolean		Indicateur qui indique si un ASE a des workers Linux ou non
properties.internalLoadBalancingMode	LoadBalancingMode		Spécifie les points de terminaison à servir en interne dans le réseau virtuel pour l’environnement App Service.
properties.ipsslAddressCount	integer (int32)		Nombre d’adresses SSL IP réservées à l’environnement App Service.
properties.maximumNumberOfMachines	integer (int32)		Nombre maximal de machines virtuelles dans l’environnement App Service.
properties.multiRoleCount	integer (int32)		Nombre d’instances frontales.
properties.multiSize	string		Taille de machine virtuelle frontale, par exemple « Moyen », « Large ».
properties.networkingConfiguration	AseV3NetworkingConfiguration		Vue complète de la configuration réseau d’un ENVIRONNEMENT ASE.
properties.provisioningState	ProvisioningState		État d’approvisionnement de l’environnement App Service.
properties.status	HostingEnvironmentStatus		État actuel de l’environnement App Service.
properties.suspended	boolean		`true` si l’environnement App Service est suspendu ; sinon, `false`. L’environnement peut être suspendu, par exemple lorsque le point de terminaison de gestion n’est plus disponible (probablement parce que le groupe de sécurité réseau a bloqué le trafic entrant).
properties.upgradeAvailability	UpgradeAvailability		Indique si une mise à niveau est disponible pour cet environnement App Service.
properties.upgradePreference	UpgradePreference	None	Préférence de mise à niveau
properties.userWhitelistedIpRanges	string[]		Plages d’adresses IP ajoutées par l’utilisateur à la liste verte sur la base de données ASE
properties.virtualNetwork	VirtualNetworkProfile		Description du réseau virtuel.
properties.zoneRedundant	boolean		Indique si cet environnement App Service Est redondant interzone ou non.
tags	object		Balises de ressource.
type	string		Type de ressource.

AseV3NetworkingConfiguration

Objet

Vue complète de la configuration réseau d’un ENVIRONNEMENT 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 nouvelle 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	Le client a fourni une adresse IP entrante. Seule la possibilité d’être définie 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

Objet

Vue complète 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 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.
properties.provisioningDetails	string
properties.provisioningState	CustomDnsSuffixProvisioningState
type	string	Type de ressource.

CustomDnsSuffixProvisioningState

Énumération

Valeur	Description
Succeeded
Failed
Degraded
InProgress

DefaultErrorResponse

Objet

Réponse d’erreur App Service.

Nom	Type	Description
error	Error	Modèle d’erreur.

Details

Objet

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

Objet

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 pour déboguer l’erreur.
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

Énumération

État actuel de l’environnement App Service.

Valeur	Description
Preparing
Ready
Scaling
Deleting

LoadBalancingMode

Énumération

Spécifie les points de terminaison à servir en interne dans le réseau virtuel pour l’environnement App Service.

Valeur	Description
None
Web
Publishing
Web, Publishing

NameValuePair

Objet

Paire nom-valeur.

Nom	Type	Description
name	string	Nom de paire.
value	string	Valeur de paire.

ProvisioningState

Énumération

État d’approvisionnement de l’environnement App Service.

Valeur	Description
Succeeded
Failed
Canceled
InProgress
Deleting

UpgradeAvailability

Énumération

Indique si une mise à niveau est disponible pour cet environnement App Service.

Valeur	Description
None	Aucune mise à niveau n’est actuellement disponible pour cet environnement App Service
Ready	Une mise à niveau est prête à être lancée manuellement sur cet environnement App Service

UpgradePreference

Énumération

Préférence de mise à niveau

Valeur	Description
None	Aucune préférence quant au moment de la mise à niveau de cet environnement App Service
Early	Cet environnement App Service sera mis à niveau avant les autres environnements de la même région qui ont la préférence de mise à niveau « En retard »
Late	Cet environnement App Service sera mis à niveau après d’autres environnements de la même région qui ont la préférence de mise à niveau « Précoce »
Manual	ASEv3 uniquement. Une fois qu’une mise à niveau est disponible, cet environnement App Service attend 10 jours pour que la mise à niveau soit lancée manuellement. Après 10 jours, la mise à niveau commencera automatiquement

VirtualNetworkProfile

Objet

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 (en lecture seule).
subnet	string	Sous-réseau au sein du réseau virtuel.
type	string	Type de ressource du réseau virtuel (lecture seule).

Partager via

App Service Environments - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Get the properties of an App Service Environment.

Exemple de requête

Exemple de réponse

Définitions

AppServiceEnvironmentResource

AseV3NetworkingConfiguration

CustomDnsSuffixConfiguration

CustomDnsSuffixProvisioningState

DefaultErrorResponse

Details

Error

HostingEnvironmentStatus

LoadBalancingMode

NameValuePair

ProvisioningState

UpgradeAvailability

UpgradePreference

VirtualNetworkProfile