App Service Environments - Get Worker Pool

Référence

Service:: App Service

API Version:: 2023-12-01

Description pour obtenir les propriétés d’un pool worker.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}?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).
workerPoolName	path	True	string	Nom du pool de workers.
api-version	query	True	string	Version d'API

Réponses

Nom	Type	Description
200 OK	WorkerPoolResource	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 properties of a worker pool.

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/workerPool1",
  "name": "workerPool1",
  "type": "Microsoft.Web/hostingEnvironments/workerPools",
  "kind": "ASEV1",
  "properties": {
    "workerSizeId": 0,
    "workerSize": "Small",
    "workerCount": 2,
    "instanceNames": []
  }
}

Définitions

Nom	Description
Capability	Décrit les fonctionnalités autorisées pour une référence SKU spécifique.
ComputeModeOptions	Des workers partagés/dédiés.
DefaultErrorResponse	App Service réponse d’erreur.
Details
Error	Modèle d’erreur.
SkuCapacity	Description des options de mise à l’échelle du plan App Service.
SkuDescription	Description d’une référence SKU pour une ressource évolutive.
WorkerPoolResource	Pool de workers d’une ressource ARM App Service Environment.

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.

ComputeModeOptions

Des workers partagés/dédiés.

Nom	Type	Description
Dedicated	string
Dynamic	string
Shared	string

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.

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.

WorkerPoolResource

Pool de workers d’une ressource ARM App Service Environment.

Nom	Type	Description
id	string	ID de ressource.
kind	string	Type de ressource.
name	string	Nom de la ressource.
properties.computeMode	ComputeModeOptions	Hébergement d’applications partagé ou dédié.
properties.instanceNames	string[]	Noms de toutes les instances dans le pool de workers (lecture seule).
properties.workerCount	integer	Nombre d’instances dans le pool de workers.
properties.workerSize	string	Taille de machine virtuelle des instances du pool de workers.
properties.workerSizeId	integer	ID de taille de worker pour le référencement de ce pool de workers.
sku	SkuDescription	Description d’une référence SKU pour une ressource évolutive.
type	string	Type de ressource.