HostingEnvironmentWorkerPoolResource.GetWorkerPoolInstanceMetricDefinitions Method

Definition

Namespace:

Azure.ResourceManager.AppService

Assembly:

Azure.ResourceManager.AppService.dll

Package:

Azure.ResourceManager.AppService v1.2.0

Source:

HostingEnvironmentWorkerPoolResource.cs

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

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions
• Operation Id: AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions
• Default Api Version: 2023-12-01

public virtual Azure.Pageable<Azure.ResourceManager.AppService.Models.ResourceMetricDefinition> GetWorkerPoolInstanceMetricDefinitions (string instance, System.Threading.CancellationToken cancellationToken = default);

abstract member GetWorkerPoolInstanceMetricDefinitions : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.AppService.Models.ResourceMetricDefinition>
override this.GetWorkerPoolInstanceMetricDefinitions : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.AppService.Models.ResourceMetricDefinition>

Public Overridable Function GetWorkerPoolInstanceMetricDefinitions (instance As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ResourceMetricDefinition)

Parameters

instance

String

Name of the instance in the worker pool.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Pageable<ResourceMetricDefinition>

A collection of ResourceMetricDefinition that may take multiple service requests to iterate over.

Exceptions

ArgumentException

instance is an empty string, and was expected to be non-empty.

ArgumentNullException

instance is null.