Usages - List By Instance Pool

Référence

Service:: SQL Database

API Version:: 2021-11-01

Obtient toutes les métriques d’utilisation du pool instance

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

With optional parameters:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
instancePoolName	path	True	string	Nom du pool instance à récupérer.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.
expandChildren	query		boolean	Paramètre de requête facultatif pour inclure les utilisations de instance managées dans le pool de instance.

Réponses

Nom	Type	Description
200 OK	UsageListResult	Récupération réussie des utilisations du pool instance.
Other Status Codes		Réponses d’erreur : *** 400 InstancePoolWrongUsageName - Demande d’utilisation d’un pool instance a un nom d’utilisation non pris en charge 400 InstancePoolManagedInstanceInfoUnavailable - Les informations relatives aux instances gérées à l’intérieur de ce pool instance ne sont pas disponibles 404 InstancePoolNotFound - Un pool instance est introuvable

Nom

Type

Description

200 OK

UsageListResult

Récupération réussie des utilisations du pool instance.

Other Status Codes

Réponses d’erreur : ***

400 InstancePoolWrongUsageName - Demande d’utilisation d’un pool instance a un nom d’utilisation non pris en charge
400 InstancePoolManagedInstanceInfoUnavailable - Les informations relatives aux instances gérées à l’intérieur de ce pool instance ne sont pas disponibles
404 InstancePoolNotFound - Un pool instance est introuvable

Exemples

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


import com.azure.core.util.Context;

/** 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,
            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

Sample Response

Status code:: 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.

Sample Request

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


import com.azure.core.util.Context;

/** 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,
            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

Sample Response

Status code:: 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
    }
  ]
}

Définitions

Nom	Description
Name	Nom d’utilisation ARM
Usage	Utilisation d’ARM.
UsageListResult	Liste des utilisations.

Name

Nom d’utilisation ARM

Nom	Type	Description
localizedValue	string	Valeur localisée du nom d’utilisation.
value	string	Valeur du nom d’utilisation

Usage

Utilisation d’ARM.

Nom	Type	Description
currentValue	integer	Valeur actuelle d’utilisation.
id	string	ID de la ressource
limit	integer	Limite d’utilisation.
name	Name	Nom de la ressource.
requestedLimit	integer	Limite d’utilisation demandée.
type	string	Type de ressource.
unit	string	Unité d’utilisation.

UsageListResult

Liste des utilisations.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	Usage[]	Tableau de résultats.

Usages - List By Instance Pool

Paramètres URI

Réponses

Exemples

List instance pool usages expanded with children.

Sample Request

Sample Response

List instance pool usages.

Sample Request

Sample Response

Définitions

Name

Usage

UsageListResult

Ressources supplémentaires