Share via

App Service Environments - List App Service Plans

  • Référence
Service:
App Service
API Version:
2023-12-01

Description pour Obtenir tous les plans App Service dans un App Service Environment.

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

Paramètres URI

Nom Dans Obligatoire Type Description
name
 path True

string

Nom du App Service Environment.
resourceGroupName
 path True

string

Nom du groupe de ressources auquel appartient la ressource.

Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId
 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

Réponses

Nom Type Description
200 OK

AppServicePlanCollection

Ok
Other Status Codes

DefaultErrorResponse

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

Get all App Service plans in an App Service Environment.

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/serverfarms/test-asp",
      "name": "test-asp",
      "type": "Microsoft.Web/serverfarms",
      "kind": "app",
      "location": "Central US EUAP",
      "tags": {},
      "properties": {
        "workerTierName": null,
        "status": "Ready",
        "subscription": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
        "hostingEnvironmentProfile": {
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
          "name": "test-ase",
          "type": "Microsoft.Web/hostingEnvironments"
        },
        "maximumNumberOfWorkers": 100,
        "geoRegion": "Central US EUAP",
        "perSiteScaling": false,
        "elasticScaleEnabled": false,
        "maximumElasticWorkerCount": 0,
        "numberOfSites": 0,
        "isSpot": false,
        "spotExpirationTime": null,
        "freeOfferExpirationTime": null,
        "resourceGroup": "test-rg",
        "reserved": false,
        "isXenon": false,
        "hyperV": false,
        "targetWorkerCount": 1,
        "targetWorkerSizeId": 0,
        "provisioningState": null,
        "kubeEnvironmentProfile": null,
        "zoneRedundant": false
      },
      "sku": {
        "name": "I1",
        "tier": "Isolated",
        "size": "I1",
        "family": "I",
        "capacity": 0
      }
    }
  ],
  "nextLink": null
}

Définitions

Nom Description
AppServicePlan

Plan App Service.
AppServicePlanCollection

Collection de plans App Service.
Capability

Décrit les fonctionnalités autorisées pour une référence SKU spécifique.
DefaultErrorResponse

App Service réponse d’erreur.
Details
Error

Modèle d’erreur.
ExtendedLocation

Emplacement étendu.
HostingEnvironmentProfile

Spécification d’un App Service Environment à utiliser pour cette ressource.
KubeEnvironmentProfile

Spécification d’un environnement Kubernetes à utiliser pour cette ressource.
ProvisioningState

État d’approvisionnement du App Service Environment.
SkuCapacity

Description des options de mise à l’échelle du plan App Service.
SkuDescription

Description d’une référence SKU pour une ressource évolutive.
StatusOptions

App Service status de plan.

AppServicePlan

Plan App Service.

Nom Type Valeur par défaut Description
extendedLocation

ExtendedLocation

Emplacement étendu.
id

string

ID de ressource.
kind

string

Type de ressource.
location

string

Emplacement de la ressource.
name

string

Nom de la ressource.
properties.elasticScaleEnabled

boolean

ServerFarm prend en charge ElasticScale. Les applications de ce plan sont mises à l’échelle comme si la référence ServerFarm était ElasticPremium
properties.freeOfferExpirationTime

string

Heure à laquelle l’offre gratuite de batterie de serveurs expire.
properties.geoRegion

string

Emplacement géographique du plan App Service.
properties.hostingEnvironmentProfile

HostingEnvironmentProfile

Spécification du App Service Environment à utiliser pour le plan App Service.
properties.hyperV

boolean

False

Si vous prévoyez trueun service d’application de conteneur Hyper-V , false sinon.
properties.isSpot

boolean

Si truela valeur est , cette App Service Plan possède des instances spot.
properties.isXenon

boolean

False

Obsolète : si le plan truede service d’application de conteneur Hyper-V est , false sinon.
properties.kubeEnvironmentProfile

KubeEnvironmentProfile

Spécification de l’environnement Kubernetes à utiliser pour le plan App Service.
properties.maximumElasticWorkerCount

integer

Nombre maximal de workers autorisés pour ce plan de App Service ElasticScaleEnabled
properties.maximumNumberOfWorkers

integer

Nombre maximal d’instances pouvant être affectées à ce plan App Service.
properties.numberOfSites

integer

Nombre d’applications affectées à ce plan App Service.
properties.numberOfWorkers

integer

Nombre d’instances affectées à ce plan App Service.
properties.perSiteScaling

boolean

False

Si true, les applications affectées à ce plan App Service peuvent être mises à l’échelle indépendamment. Si false, les applications affectées à ce plan App Service seront mises à l’échelle sur toutes les instances du plan.
properties.provisioningState

ProvisioningState

État d’approvisionnement du plan de App Service.
properties.reserved

boolean

False

Si le service d’application Linux plane true, false sinon.
properties.resourceGroup

string

Groupe de ressources du plan App Service.
properties.spotExpirationTime

string

Heure à laquelle la batterie de serveurs expire. Valide uniquement s’il s’agit d’une batterie de serveurs spot.
properties.status

StatusOptions

App Service status de plan.
properties.subscription

string

App Service abonnement au plan.
properties.targetWorkerCount

integer

Mise à l’échelle du nombre de workers.
properties.targetWorkerSizeId

integer

Mise à l’échelle de l’ID de taille de worker.
properties.workerTierName

string

Niveau Worker cible affecté au plan App Service.
properties.zoneRedundant

boolean

False

Si truela valeur est , cette App Service Plan effectue l’équilibrage des zones de disponibilité. Si false, ce plan App Service n’effectue pas l’équilibrage des zones de disponibilité.
sku

SkuDescription

Description d’une référence SKU pour une ressource évolutive.
tags

object

Balises de ressource.
type

string

Type de ressource.

AppServicePlanCollection

Collection de plans App Service.

Nom Type Description
nextLink

string

Lien vers la page suivante de ressources.
value

AppServicePlan[]

Collection de ressources.

Capability

Décrit les fonctionnalités autorisées pour une référence SKU spécifique.

Nom Type Description
name

string

Nom de la fonctionnalité de référence SKU.
reason

string

Raison de la fonctionnalité de référence SKU.
value

string

Valeur de la fonctionnalité de référence SKU.

DefaultErrorResponse

App Service réponse d’erreur.

Nom Type Description
error

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.

ExtendedLocation

Emplacement étendu.

Nom Type Description
name

string

Nom de l’emplacement étendu.
type

string

Type d’emplacement étendu.

HostingEnvironmentProfile

Spécification d’un App Service Environment à utiliser pour cette ressource.

Nom Type Description
id

string

ID de ressource du App Service Environment.
name

string

Nom du App Service Environment.
type

string

Type de ressource du App Service Environment.

KubeEnvironmentProfile

Spécification d’un environnement Kubernetes à utiliser pour cette ressource.

Nom Type Description
id

string

ID de ressource de l’environnement Kubernetes.
name

string

Nom de l’environnement Kubernetes.
type

string

Type de ressource de l’environnement Kubernetes.

ProvisioningState

État d’approvisionnement du App Service Environment.

Nom Type Description
Canceled

string

Deleting

string

Failed

string

InProgress

string

Succeeded

string

SkuCapacity

Description des options de mise à l’échelle du plan App Service.

Nom Type Description
default

integer

Nombre par défaut de workers pour cette référence SKU de plan App Service.
elasticMaximum

integer

Nombre maximal de workers élastiques pour cette référence SKU de plan App Service.
maximum

integer

Nombre maximal de workers pour cette référence SKU de plan App Service.
minimum

integer

Nombre minimal de workers pour cette référence SKU de plan App Service.
scaleType

string

Configurations de mise à l’échelle disponibles pour un plan App Service.

SkuDescription

Description d’une référence SKU pour une ressource évolutive.

Nom Type Description
capabilities

Capability[]

Les fonctionnalités de la référence SKU, par exemple, le gestionnaire de trafic est-il activé ?
capacity

integer

Nombre actuel d’instances affectées à la ressource.
family

string

Code de famille de la référence SKU de ressource.
locations

string[]

Emplacements de la référence SKU.
name

string

Nom de la référence SKU de ressource.
size

string

Spécificateur de taille de la référence SKU de ressource.
skuCapacity

SkuCapacity

Valeurs d’échelle min, max et par défaut de la référence SKU.
tier

string

Niveau de service de la référence SKU de ressource.

StatusOptions

App Service status de plan.

Nom Type Description
Creating

string

Pending

string

Ready

string