App Service Environments - List Multi Role Metric Definitions

Description for Get metric definitions for a multi-role pool of an App Service Environment.

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

URI Parameters

Name In Required Type Description
name
path True

string

Name of the App Service Environment.

resourceGroupName
path True

string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

api-version
query True

string

API Version

Responses

Name Type Description
200 OK

ResourceMetricDefinitionCollection

OK

Other Status Codes

DefaultErrorResponse

App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get metric definitions for a multi-role pool of an App Service Environment.

Sample request

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

Sample response

{
  "value": [
    {
      "name": "CpuPercentage",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/cpupercentage"
    },
    {
      "name": "MemoryPercentage",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/MemoryPercentage"
    },
    {
      "name": "DiskQueueLength",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/DiskQueueLength"
    },
    {
      "name": "HttpQueueLength",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/HttpQueueLength"
    },
    {
      "name": "BytesReceived",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/BytesReceived"
    },
    {
      "name": "BytesSent",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/BytesSent"
    }
  ],
  "nextLink": null
}

Definitions

Name Description
DefaultErrorResponse

App Service error response.

Details
Error

Error model.

ResourceMetricAvailability

Metrics availability and retention.

ResourceMetricDefinition

Metadata for the metrics.

ResourceMetricDefinitionCollection

Collection of metric definitions.

DefaultErrorResponse

App Service error response.

Name Type Description
error

Error

Error model.

Details

Name Type Description
code

string

Standardized string to programmatically identify the error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

Error

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.

details

Details[]

Detailed errors.

innererror

string

More information to debug error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

ResourceMetricAvailability

Metrics availability and retention.

Name Type Description
retention

string

Retention period for the current time grain.

timeGrain

string

Time grain .

ResourceMetricDefinition

Metadata for the metrics.

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.metricAvailabilities

ResourceMetricAvailability[]

List of time grains supported for the metric together with retention period.

properties.primaryAggregationType

string

Primary aggregation type.

properties.properties

object

Resource metric definition properties.

properties.resourceUri

string

Resource URI.

properties.unit

string

Unit of the metric.

type

string

Resource type.

ResourceMetricDefinitionCollection

Collection of metric definitions.

Name Type Description
nextLink

string

Link to next page of resources.

value

ResourceMetricDefinition[]

Collection of resources.