Usages - List By Instance Pool

リファレンス

サービス:: SQL Database

API バージョン:: 2021-11-01

すべてのインスタンスプールの使用状況メトリックを取得します

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}/usages?api-version=2021-11-01

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}/usages?expandChildren={expandChildren}&api-version=2021-11-01

URI パラメーター

名前	/	必須	型	説明
instancePoolName	path	True	string	取得するインスタンスプールの名前。
resourceGroupName	path	True	string	リソースが含まれているリソースグループの名前。この値は、Azure リソースマネージャー API またはポータルから取得できます。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。
expandChildren	query		boolean	インスタンスプール内のマネージドインスタンスの使用状況を含める省略可能な要求パラメーター。

応答

名前	型	説明
200 OK	UsageListResult	インスタンスプールの使用状況が正常に取得されました。
Other Status Codes		エラー応答: *** 400 InstancePoolWrongUsageName - インスタンスプールの使用状況の要求にサポートされていない使用名がある 400 InstancePoolManagedInstanceInfoUnavailable - このインスタンスプール内のマネージドインスタンスの情報は使用できません 404 InstancePoolNotFound - インスタンスプールが見つかりません

名前

型

説明

200 OK

UsageListResult

インスタンスプールの使用状況が正常に取得されました。

Other Status Codes

エラー応答: ***

400 InstancePoolWrongUsageName - インスタンスプールの使用状況の要求にサポートされていない使用名がある
400 InstancePoolManagedInstanceInfoUnavailable - このインスタンスプール内のマネージドインスタンスの情報は使用できません
404 InstancePoolNotFound - インスタンスプールが見つかりません

例

List instance pool usages expanded with children.

List instance pool usages.

List instance pool usages expanded with children.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/usages?expandChildren=True&api-version=2021-11-01


/**
 * Samples for Usages ListByInstancePool.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListInstancePoolUsageExpanded.json
     */
    /**
     * Sample code: List instance pool usages expanded with children.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listInstancePoolUsagesExpandedWithChildren(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getUsages().listByInstancePool("group1", "testIP", true,
            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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/usages/vcore_utilization",
      "name": {
        "value": "VCore utilization",
        "localizedValue": "VCore utilization"
      },
      "type": "Microsoft.Sql/instancePools/usages",
      "unit": "VCores",
      "currentValue": 12,
      "limit": 16,
      "requestedLimit": 40
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/usages/storage_utilization",
      "name": {
        "value": "Storage utilization",
        "localizedValue": "Storage utilization"
      },
      "type": "Microsoft.Sql/instancePools/usages",
      "unit": "VCores",
      "currentValue": 384,
      "limit": 8196,
      "requestedLimit": null
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/usages/database_utilization",
      "name": {
        "value": "Database utilization",
        "localizedValue": "Database utilization"
      },
      "type": "Microsoft.Sql/instancePools/usages",
      "unit": "Number Of Databases",
      "currentValue": 5,
      "limit": 100,
      "requestedLimit": null
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/managedInstances/managedInstance1/usages/vcore_utilization",
      "name": {
        "value": "VCore utilization",
        "localizedValue": "VCore utilization"
      },
      "type": "Microsoft.Sql/instancePools/managedInstances/usages",
      "unit": "VCores",
      "currentValue": null,
      "limit": 4,
      "requestedLimit": null
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/managedInstances/managedInstance2/usages/vcore_utilization",
      "name": {
        "value": "VCore utilization",
        "localizedValue": "VCore utilization"
      },
      "type": "Microsoft.Sql/instancePools/managedInstances/usages",
      "unit": "VCores",
      "currentValue": null,
      "limit": 4,
      "requestedLimit": 8
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/managedInstances/managedInstance1/usages/storage_utilization",
      "name": {
        "value": "Storage utilization",
        "localizedValue": "Storage utilization"
      },
      "type": "Microsoft.Sql/instancePools/managedInstances/usages",
      "unit": "Gigabytes",
      "currentValue": null,
      "limit": 128,
      "requestedLimit": null
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/managedInstances/managedInstance2/usages/storage_utilization",
      "name": {
        "value": "VCore utilization",
        "localizedValue": "VCore utilization"
      },
      "type": "Microsoft.Sql/instancePools/managedInstances/usages",
      "unit": "Gigabytes",
      "currentValue": null,
      "limit": 128,
      "requestedLimit": 256
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/managedInstances/managedInstance1/usages/database_utilization",
      "name": {
        "value": "Database utilization",
        "localizedValue": "Database utilization"
      },
      "type": "Microsoft.Sql/instancePools/managedInstances/usages",
      "unit": "Number Of Databases",
      "currentValue": 2,
      "limit": 100,
      "requestedLimit": null
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/managedInstances/managedInstance2/usages/database_utilization",
      "name": {
        "value": "Database utilization",
        "localizedValue": "Database utilization"
      },
      "type": "Microsoft.Sql/instancePools/managedInstances/usages",
      "unit": "Number Of Databases",
      "currentValue": 3,
      "limit": 100,
      "requestedLimit": null
    }
  ]
}

List instance pool usages.

要求のサンプル

HTTP
Java

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/usages?api-version=2021-11-01


/**
 * Samples for Usages ListByInstancePool.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListInstancePoolUsage.json
     */
    /**
     * Sample code: List instance pool usages.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listInstancePoolUsages(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getUsages().listByInstancePool("group1", "testIP", null,
            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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/usages/vcore_utilization",
      "name": {
        "value": "VCore utilization",
        "localizedValue": "VCore utilization"
      },
      "type": "Microsoft.Sql/instancePools/usages",
      "unit": "VCores",
      "currentValue": 12,
      "limit": 16,
      "requestedLimit": 40
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/usages/storage_utilization",
      "name": {
        "value": "Storage utilization",
        "localizedValue": "Storage utilization"
      },
      "type": "Microsoft.Sql/instancePools/usages",
      "unit": "VCores",
      "currentValue": 384,
      "limit": 8196,
      "requestedLimit": null
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP/usages/database_utilization",
      "name": {
        "value": "Database utilization",
        "localizedValue": "Database utilization"
      },
      "type": "Microsoft.Sql/instancePools/usages",
      "unit": "Number Of Databases",
      "currentValue": 5,
      "limit": 100,
      "requestedLimit": null
    }
  ]
}

定義

名前	説明
Name	ARM の使用名
Usage	ARM の使用法。
UsageListResult	使用状況の一覧。

Name

ARM の使用名

名前	型	説明
localizedValue	string	使用法名のローカライズされた値。
value	string	使用状況名の値

Usage

ARM の使用法。

名前	型	説明
currentValue	integer	使用状況の現在の値。
id	string	リソースの ID
limit	integer	使用制限。
name	Name	リソース名。
requestedLimit	integer	使用量の要求された制限。
type	string	リソースの種類。
unit	string	使用単位。

UsageListResult

使用状況の一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	Usage[]	結果の配列。

次の方法で共有

Usages - List By Instance Pool

URI パラメーター

応答

例

List instance pool usages expanded with children.

要求のサンプル

応答のサンプル

List instance pool usages.

要求のサンプル

応答のサンプル

定義

Name

Usage

UsageListResult

その他のリソース