Usages - List By Instance Pool

Referencia

Service:: SQL Database

API Version:: 2021-11-01

Obtiene todas las métricas de uso del grupo de instancias.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
instancePoolName	path	True	string	Nombre del grupo de instancias que se va a recuperar.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.
expandChildren	query		boolean	Parámetro de solicitud opcional para incluir usos de instancias administradas dentro del grupo de instancias.

Respuestas

Nombre	Tipo	Description
200 OK	UsageListResult	Recuperó correctamente los usos del grupo de instancias.
Other Status Codes		Respuestas de error: *** 400 InstancePoolWrongUsageName: la solicitud de uso de un grupo de instancias tiene un nombre de uso no admitido 400 InstancePoolManagedInstanceInfoUnavailable: la información de las instancias administradas dentro de este grupo de instancias no está disponible. 404 InstancePoolNotFound: no se encuentra un grupo de instancias

Nombre

Tipo

Description

200 OK

UsageListResult

Recuperó correctamente los usos del grupo de instancias.

Other Status Codes

Respuestas de error: ***

400 InstancePoolWrongUsageName: la solicitud de uso de un grupo de instancias tiene un nombre de uso no admitido
400 InstancePoolManagedInstanceInfoUnavailable: la información de las instancias administradas dentro de este grupo de instancias no está disponible.
404 InstancePoolNotFound: no se encuentra un grupo de instancias

Ejemplos

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
    }
  ]
}

Definiciones

Nombre	Description
Name	Nombre de uso de ARM
Usage	Uso de ARM.
UsageListResult	Una lista de usos.

Name

Nombre de uso de ARM

Nombre	Tipo	Description
localizedValue	string	Valor localizado del nombre de uso.
value	string	Valor de nombre de uso

Usage

Uso de ARM.

Nombre	Tipo	Description
currentValue	integer	Valor actual de uso.
id	string	Identificador del recurso.
limit	integer	Límite de uso.
name	Name	Nombre del recurso.
requestedLimit	integer	Límite solicitado de uso.
type	string	Tipo de recurso.
unit	string	Unidad de uso.

UsageListResult

Una lista de usos.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la página siguiente de resultados.
value	Usage[]	Matriz de resultados.

Usages - List By Instance Pool

Parámetros de identificador URI

Respuestas

Ejemplos

List instance pool usages expanded with children.

Sample Request

Sample Response

List instance pool usages.

Sample Request

Sample Response

Definiciones

Name

Usage

UsageListResult

Recursos adicionales