Usages - List By Instance Pool

Referência

Service:: SQL Database

API Version:: 2021-11-01

Obtém todas as métricas de uso do pool de instâncias

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 URI

Nome	Em	Obrigatório	Tipo	Description
instancePoolName	path	True	string	O nome do pool de instâncias a ser recuperado.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.
expandChildren	query		boolean	Parâmetro de solicitação opcional para incluir usos de instância gerenciada no pool de instâncias.

Respostas

Nome	Tipo	Description
200 OK	UsageListResult	Recuperou com êxito os usos do pool de instâncias.
Other Status Codes		Respostas de erro: *** 400 InstancePoolWrongUsageName – A solicitação para o uso de um pool de instâncias tem um nome de uso sem suporte 400 InstancePoolManagedInstanceInfoUnavailable – As informações para instâncias gerenciadas dentro desse pool de instâncias não estão disponíveis 404 InstancePoolNotFound – Um pool de instâncias não pode ser encontrado

Nome

Tipo

Description

200 OK

UsageListResult

Recuperou com êxito os usos do pool de instâncias.

Other Status Codes

Respostas de erro: ***

400 InstancePoolWrongUsageName – A solicitação para o uso de um pool de instâncias tem um nome de uso sem suporte
400 InstancePoolManagedInstanceInfoUnavailable – As informações para instâncias gerenciadas dentro desse pool de instâncias não estão disponíveis
404 InstancePoolNotFound – Um pool de instâncias não pode ser encontrado

Exemplos

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

Definições

Nome	Description
Name	Nome de uso do ARM
Usage	Uso do ARM.
UsageListResult	Uma lista de usos.

Name

Nome de uso do ARM

Nome	Tipo	Description
localizedValue	string	Valor localizado do nome de uso.
value	string	Valor do nome de uso

Usage

Uso do ARM.

Nome	Tipo	Description
currentValue	integer	Valor atual de uso.
id	string	ID do recurso.
limit	integer	Limite de uso.
name	Name	Nome do recurso.
requestedLimit	integer	Limite solicitado de uso.
type	string	Tipo de recurso.
unit	string	Unidade de uso.

UsageListResult

Uma lista de usos.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	Usage[]	Matriz de resultados.

Usages - List By Instance Pool

Parâmetros de URI

Respostas

Exemplos

List instance pool usages expanded with children.

Sample Request

Sample Response

List instance pool usages.

Sample Request

Sample Response

Definições

Name

Usage

UsageListResult

Recursos adicionais