App Service Environments - List Worker Pool Instance Metric Definitions

Serviço:

App Service

Versão da API:

2024-11-01

Descrição para obter definições de métrica para uma instância específica de um pool de trabalho de um Ambiente do Serviço de Aplicativo.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
instance	path	True	string	Nome da instância no pool de trabalho.
name	path	True	string	Nome do Ambiente do Serviço de Aplicativo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
subscriptionId	path	True	string	Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
workerPoolName	path	True	string	Nome do pool de trabalho.
api-version	query	True	string	Versão da API

Respostas

Nome	Tipo	Description
200 OK	ResourceMetricDefinitionCollection	OKEY
Other Status Codes	DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get metric definitions for a specific instance of a worker pool of an App Service Environment.

Solicitação de exemplo

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=2024-11-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions.json
// this example is just showing the usage of "AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this HostingEnvironmentWorkerPoolResource created on azure
// for more information of creating HostingEnvironmentWorkerPoolResource, please refer to the document of HostingEnvironmentWorkerPoolResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-rg";
string name = "test-ase";
string workerPoolName = "0";
ResourceIdentifier hostingEnvironmentWorkerPoolResourceId = HostingEnvironmentWorkerPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, workerPoolName);
HostingEnvironmentWorkerPoolResource hostingEnvironmentWorkerPool = client.GetHostingEnvironmentWorkerPoolResource(hostingEnvironmentWorkerPoolResourceId);

// invoke the operation and iterate over the result
string instance = "10.8.0.7";
await foreach (ResourceMetricDefinition item in hostingEnvironmentWorkerPool.GetWorkerPoolInstanceMetricDefinitionsAsync(instance))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

Resposta de exemplo

Código de status:

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
    }
  ]
}

Definições

Nome	Description
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
ResourceMetricAvailability	Disponibilidade e retenção de métricas.
ResourceMetricDefinition	Metadados para as métricas.
ResourceMetricDefinitionCollection	Coleção de definições de métrica.

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Error

Objeto

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

ResourceMetricAvailability

Objeto

Disponibilidade e retenção de métricas.

Nome	Tipo	Description
retention	string	Período de retenção para o grão de tempo atual.
timeGrain	string	Grãos de tempo.

ResourceMetricDefinition

Objeto

Metadados para as métricas.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de recurso.
name	string	Nome do Recurso.
properties.metricAvailabilities	ResourceMetricAvailability[]	Lista de grãos de tempo com suporte para a métrica junto com o período de retenção.
properties.primaryAggregationType	string	Tipo de agregação primária.
properties.properties	object	Propriedades de definição da métrica de recurso.
properties.resourceUri	string	URI do recurso.
properties.unit	string	Unidade da métrica.
type	string	Tipo de recurso.

ResourceMetricDefinitionCollection

Objeto

Coleção de definições de métrica.

Nome	Tipo	Description
nextLink	string	Link para a próxima página de recursos.
value	ResourceMetricDefinition[]	Coleção de recursos.