App Service Plans - Get

Description de l’obtention d’un plan App Service.

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

Paramètres URI

Name In Required Type Description
name
path True
  • string

Nom du plan App Service.

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, 00000000-0000-0000-0000-00000000000000000000000000000000000000000000000000000000000000000000000000000000000).

api-version
query True
  • string

Version d'API

Réponses

Name Type Description
200 OK

OK.

404 Not Found

Introuvable.

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

Name Description
user_impersonation emprunt d’identité de votre compte d’utilisateur

Exemples

Get App Service plan

Sample Request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141?api-version=2022-03-01

Sample Response

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141",
  "name": "testsf6141",
  "type": "Microsoft.Web/serverfarms",
  "kind": "app",
  "location": "East US",
  "properties": {
    "status": "Ready",
    "maximumNumberOfWorkers": 20,
    "numberOfWorkers": 19,
    "geoRegion": "East US",
    "numberOfSites": 4,
    "isSpot": false,
    "reserved": false,
    "targetWorkerCount": 0,
    "targetWorkerSizeId": 0,
    "provisioningState": "Succeeded"
  },
  "sku": {
    "name": "P1",
    "tier": "Premium",
    "size": "P1",
    "family": "P",
    "capacity": 1
  }
}

Définitions

AppServicePlan

Plan App Service.

Capability

Décrit les fonctionnalités/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 plan App Service.

SkuCapacity

Description des options d’échelle de plan App Service.

SkuDescription

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

StatusOptions

App Service état du plan.

AppServicePlan

Plan App Service.

Name Type Default Value Description
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 seront mises à l’échelle comme si ServerFarm était elasticPremium sku

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

Spécification de la App Service Environment à utiliser pour le plan de App Service.

properties.hyperV
  • boolean
False

Si le plan trued’app service d’application de conteneur Hyper-V , false sinon.

properties.isSpot
  • boolean

Si true, ce App Service Plan possède des instances spot.

properties.isXenon
  • boolean
False

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

properties.kubeEnvironmentProfile

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

properties.maximumElasticWorkerCount
  • integer

Nombre maximal de travailleurs 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 de 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 de App Service peuvent être mises à l’échelle indépendamment. Si false, les applications affectées à ce plan App Service seront mises à l’échelle à toutes les instances du plan.

properties.provisioningState

État d’approvisionnement du plan App Service.

properties.reserved
  • boolean
False

Si le plan App Service Linux , truefalse sinon.

properties.resourceGroup
  • string

Groupe de ressources du plan App Service.

properties.spotExpirationTime
  • string

Heure d’expiration de la batterie de serveurs. Valide uniquement s’il s’agit d’une batterie de serveurs spot.

properties.status

App Service état du plan.

properties.subscription
  • string

abonnement App Service plan.

properties.targetWorkerCount
  • integer

Mise à l’échelle du nombre de workers.

properties.targetWorkerSizeId
  • integer

Mise à l’échelle de l’ID de taille du worker.

properties.workerTierName
  • string

Niveau Worker cible affecté au plan App Service.

properties.zoneRedundant
  • boolean
False

Si true, ce plan App Service effectue l’équilibrage de zone de disponibilité. Si false, ce plan App Service n’effectue pas d’équilibrage de zone de disponibilité.

sku

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

tags
  • object

Balises de ressource.

type
  • string

Type de ressource.

Capability

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

Name 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.

Name Type Description
error

Modèle d’erreur.

Details

Name Type Description
code
  • string

Chaîne standardisée pour identifier par programmation l’erreur.

message
  • string

Description détaillée des erreurs et informations de débogage.

target
  • string

Description détaillée des erreurs et informations de débogage.

Error

Modèle d’erreur.

Name Type Description
code
  • string

Chaîne standardisée pour identifier par programmation l’erreur.

details

Erreurs détaillées.

innererror
  • string

Plus d’informations sur l’erreur de débogage.

message
  • string

Description détaillée des erreurs et informations de débogage.

target
  • string

Description détaillée des erreurs et informations de débogage.

ExtendedLocation

Emplacement étendu.

Name 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.

Name 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.

Name 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 plan App Service.

Name Type Description
Canceled
  • string
Deleting
  • string
Failed
  • string
InProgress
  • string
Succeeded
  • string

SkuCapacity

Description des options d’échelle de plan App Service.

Name Type Description
default
  • integer

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

elasticMaximum
  • integer

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

maximum
  • integer

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

minimum
  • integer

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

scaleType
  • string

Configurations d’échelle disponibles pour un plan de App Service.

SkuDescription

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

Name Type Description
capabilities

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 familial 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

Valeurs d’échelle minimale, maximale 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 état du plan.

Name Type Description
Creating
  • string
Pending
  • string
Ready
  • string