App Service Environments - List Worker Pool Instance Metric Definitions

Référence

Service:: App Service

API Version:: 2023-12-01

Description pour Obtenir des définitions de métriques pour une instance spécifique d’un pool de workers d’un App Service Environment.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
instance	path	True	string	Nom du instance dans le pool de workers.
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	ResourceMetricDefinitionCollection	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 metric definitions for a specific instance of a worker pool of an App Service Environment.

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "CpuPercentage",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/CpuPercentage",
      "properties": null
    },
    {
      "name": "MemoryPercentage",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/MemoryPercentage",
      "properties": null
    },
    {
      "name": "DiskQueueLength",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/DiskQueueLength",
      "properties": null
    },
    {
      "name": "HttpQueueLength",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/HttpQueueLength",
      "properties": null
    }
  ]
}

Définitions

Nom	Description
DefaultErrorResponse	App Service réponse d’erreur.
Details
Error	Modèle d’erreur.
ResourceMetricAvailability	Disponibilité et rétention des métriques.
ResourceMetricDefinition	Métadonnées pour les métriques.
ResourceMetricDefinitionCollection	Collection de définitions de métriques.

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.

ResourceMetricAvailability

Disponibilité et rétention des métriques.

Nom	Type	Description
retention	string	Période de rétention pour le grain d’heure actuel.
timeGrain	string	Grain d’heure .

ResourceMetricDefinition

Métadonnées pour les métriques.

Nom	Type	Description
id	string	ID de ressource.
kind	string	Type de ressource.
name	string	Nom de la ressource.
properties.metricAvailabilities	ResourceMetricAvailability[]	Liste des grains de temps pris en charge pour la métrique, ainsi que la période de rétention.
properties.primaryAggregationType	string	Type d’agrégation principal.
properties.properties	object	Propriétés de définition de métrique de ressource.
properties.resourceUri	string	URI de ressource.
properties.unit	string	Unité de la métrique.
type	string	Type de ressource.

ResourceMetricDefinitionCollection

Collection de définitions de métriques.

Nom	Type	Description
nextLink	string	Lien vers la page suivante de ressources.
value	ResourceMetricDefinition[]	Collection de ressources.

Share via