Usages - List By Instance Pool

  • Ссылка
Service:
SQL Database
API Version:
2021-11-01

Возвращает все метрики использования пула экземпляров.

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

Параметры URI

Имя В Обязательно Тип Описание
instancePoolName
 path True

string

Имя извлекаемого пула экземпляров.
resourceGroupName
 path True

string

Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
subscriptionId
 path True

string

Идентификатор подписки Azure.
api-version
 query True

string

Версия API для использования в запросе.
expandChildren
 query

boolean

Необязательный параметр запроса для включения использования управляемого экземпляра в пуле экземпляров.

Ответы

Имя Тип Описание
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.

Sample Request

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

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

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

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

Определения

Имя Описание
Name

Имя использования ARM
Usage

Использование ARM.
UsageListResult

Список использования.

Name

Имя использования ARM

Имя Тип Описание
localizedValue

string

Локализованное значение имени использования.
value

string

Значение имени использования

Usage

Использование ARM.

Имя Тип Описание
currentValue

integer

Текущее значение использования.
id

string

Идентификатор ресурса.
limit

integer

Ограничение использования.
name

Name

Имя ресурса.
requestedLimit

integer

Запрошенный предел использования.
type

string

Тип ресурса.
unit

string

Единица использования.

UsageListResult

Список использования.

Имя Тип Описание
nextLink

string

Ссылка для получения следующей страницы результатов.
value

Usage[]

Массив результатов.