App Service Environments - List Web Worker Metric Definitions

Usługa:

App Service

Wersja interfejsu API:

2024-11-01

Opis definicji metryk dla puli procesów roboczych środowiska App Service Environment.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa środowiska App Service Environment.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nazwa grupy zasobów, do której należy zasób.
subscriptionId	path	True	string	Twój identyfikator subskrypcji Azure. Jest to ciąg w formacie GUID (np. 0000000000-0000-0000-0000-0000000000000).
workerPoolName	path	True	string	Nazwa puli procesów roboczych.
api-version	query	True	string	Wersja interfejsu API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ResourceMetricDefinitionCollection	OK
Other Status Codes	DefaultErrorResponse	Odpowiedź na błąd usługi App Service.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Przykładowe żądanie

HTTP

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

Java

/**
 * Samples for AppServiceEnvironments ListWebWorkerMetricDefinitions.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/
     * AppServiceEnvironments_ListWebWorkerMetricDefinitions.json
     */
    /**
     * Sample code: Get metric definitions for a worker pool of an App Service Environment.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getMetricDefinitionsForAWorkerPoolOfAnAppServiceEnvironment(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getAppServiceEnvironments().listWebWorkerMetricDefinitions("test-rg",
            "test-ase", "0", com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python app_service_environments_list_web_worker_metric_definitions.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.app_service_environments.list_web_worker_metric_definitions(
        resource_group_name="test-rg",
        name="test-ase",
        worker_pool_name="0",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_ListWebWorkerMetricDefinitions.json
if __name__ == "__main__":
    main()

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

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_ListWebWorkerMetricDefinitions.json
func ExampleEnvironmentsClient_NewListWebWorkerMetricDefinitionsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewEnvironmentsClient().NewListWebWorkerMetricDefinitionsPager("test-rg", "test-ase", "0", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ResourceMetricDefinitionCollection = armappservice.ResourceMetricDefinitionCollection{
		// 	Value: []*armappservice.ResourceMetricDefinition{
		// 		{
		// 			Name: to.Ptr("CpuPercentage"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/CpuPercentage"),
		// 		},
		// 		{
		// 			Name: to.Ptr("MemoryPercentage"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/MemoryPercentage"),
		// 		},
		// 		{
		// 			Name: to.Ptr("DiskQueueLength"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/DiskQueueLength"),
		// 		},
		// 		{
		// 			Name: to.Ptr("HttpQueueLength"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/HttpQueueLength"),
		// 	}},
		// }
	}
}

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

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Get metric definitions for a worker pool of an App Service Environment.
 *
 * @summary Description for Get metric definitions for a worker pool of an App Service Environment.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_ListWebWorkerMetricDefinitions.json
 */
async function getMetricDefinitionsForAWorkerPoolOfAnAppServiceEnvironment() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "test-rg";
  const name = "test-ase";
  const workerPoolName = "0";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.appServiceEnvironments.listWebWorkerMetricDefinitions(
    resourceGroupName,
    name,
    workerPoolName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

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_ListWebWorkerMetricDefinitions.json
// this example is just showing the usage of "AppServiceEnvironments_ListWebWorkerMetricDefinitions" 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
await foreach (ResourceMetricDefinition item in hostingEnvironmentWorkerPool.GetWebWorkerMetricDefinitionsAsync())
{
    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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
DefaultErrorResponse	Odpowiedź na błąd usługi App Service.
Details
Error	Model błędu.
ResourceMetricAvailability	Dostępność i przechowywanie metryk.
ResourceMetricDefinition	Metadane metryk.
ResourceMetricDefinitionCollection	Kolekcja definicji metryk.

DefaultErrorResponse

Objekt

Odpowiedź na błąd usługi App Service.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Objekt

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Objekt

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

ResourceMetricAvailability

Objekt

Dostępność i przechowywanie metryk.

Nazwa	Typ	Opis
retention	string	Okres przechowywania dla bieżącego ziarna czasu.
timeGrain	string	Ziarno czasu .

ResourceMetricDefinition

Objekt

Metadane metryk.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.metricAvailabilities	ResourceMetricAvailability[]	Lista ziarna czasu obsługiwane dla metryki wraz z okresem przechowywania.
properties.primaryAggregationType	string	Podstawowy typ agregacji.
properties.properties	object	Właściwości definicji metryki zasobów.
properties.resourceUri	string	Identyfikator URI zasobu.
properties.unit	string	Jednostka metryki.
type	string	Typ zasobu.

ResourceMetricDefinitionCollection

Objekt

Kolekcja definicji metryk.

Nazwa	Typ	Opis
nextLink	string	Łącze do następnej strony zasobów.
value	ResourceMetricDefinition[]	Kolekcja zasobów.