App Service Environments - List Multi Role Metric Definitions

リファレンス

Service:: App Service

API Version:: 2023-12-01

「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 パラメーター

名前	/	必須	型	説明
name	path	True	string	App Service Environmentの名前。
resourceGroupName	path	True	string	リソースが属しているリソースグループの名前。 Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Azure のサブスクリプション ID。これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-00000000000000)。
api-version	query	True	string	API バージョン

応答

名前	型	説明
200 OK	ResourceMetricDefinitionCollection	OK
Other Status Codes	DefaultErrorResponse	エラー応答をApp Serviceします。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Get metric definitions for a multi-role 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/multiRolePools/default/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/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
}

定義

名前	説明
DefaultErrorResponse	エラー応答をApp Serviceします。
Details
Error	エラーモデル。
ResourceMetricAvailability	メトリックの可用性と保持。
ResourceMetricDefinition	メトリックのメタデータ。
ResourceMetricDefinitionCollection	メトリック定義のコレクション。

DefaultErrorResponse

エラー応答をApp Serviceします。

名前	型	説明
error	Error	エラーモデル。

Details

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

Error

エラーモデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細なエラー。
innererror	string	デバッグエラーの詳細。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

ResourceMetricAvailability

メトリックの可用性と保持。

名前	型	説明
retention	string	現在の時間グレインの保持期間。
timeGrain	string	時間グレイン。

ResourceMetricDefinition

メトリックのメタデータ。

名前	型	説明
id	string	リソース ID。
kind	string	リソースの種類。
name	string	リソース名。
properties.metricAvailabilities	ResourceMetricAvailability[]	メトリックでサポートされている時間グレインと保持期間の一覧。
properties.primaryAggregationType	string	プライマリ集計の種類。
properties.properties	object	リソースメトリック定義のプロパティ。
properties.resourceUri	string	リソース URI。
properties.unit	string	メトリックの単位。
type	string	リソースの種類。

ResourceMetricDefinitionCollection

メトリック定義のコレクション。

名前	型	説明
nextLink	string	リソースの次のページへのリンク。
value	ResourceMetricDefinition[]	リソースのコレクション。