Usages - List By Instance Pool

Service:: SQL Database

API Version:: 2025-01-01

Gets all instance pool usage metrics

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
instancePoolName	path	True	string	The name of the instance pool to be retrieved.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.
expandChildren	query		boolean	Optional request parameter to include managed instance usages within the instance pool.

Responses

Name	Type	Description
200 OK	UsageListResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List instance pool usages expanded with children.

List instance pool usages.

List instance pool usages expanded with children.

Sample request

HTTP

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

Sample response

Status code:: 200

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

List instance pool usages.

Sample request

HTTP

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

Sample response

Status code:: 200

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

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Name	ARM Usage Name
Usage	ARM usage.
UsageListResult	A list of usages.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Name

Object

ARM Usage Name

Name	Type	Description
localizedValue	string	Usage name localized value.
value	string	Usage name value

Usage

Object

ARM usage.

Name	Type	Description
currentValue	integer (int32)	Usage current value.
id	string	Resource ID.
limit	integer (int32)	Usage limit.
name	Name	Resource name.
requestedLimit	integer (int32)	Usage requested limit.
type	string	Resource type.
unit	string	Usage unit.

UsageListResult

Object

A list of usages.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	Usage[]	The Usage items on this page

Share via

Usages - List By Instance Pool

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List instance pool usages expanded with children.

Sample request

Sample response

List instance pool usages.

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Name

Usage

UsageListResult