Elastic Pools - List By Server

Service:

SQL Database

API Version:

2021-11-01

Возвращает все эластичные пулы на сервере.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools?$skip={$skip}&api-version=2021-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.
$skip	query		integer int64	Количество элементов в коллекции, которые необходимо пропустить.

Ответы

Имя	Тип	Описание
200 OK	ElasticPoolListResult	Выполнено
Other Status Codes		Ответы об ошибках: *** 400 ElasticPoolOverStorageUsage — попытка записи данных в базу данных при достижении предела хранилища эластичного пула. 400 InvalidSku — пользователь указал недопустимый номер SKU. 400 InvalidTierSkuCombination — указанный уровень не поддерживает указанный номер SKU. 400 ServerQuotaExceeded — сервер достиг предела для разрешенной единицы пропускной способности базы данных. 400 ElasticPoolAlreadyExists — сервер уже содержит эластичный пул с указанным именем. 400 SubscriptionVcoreQuotaExceeded — не удалось выполнить операцию, так как подписка превысит допустимую квоту виртуальных ядер. 400 InvalidInputValueForEdition — указанный выпуск не поддерживается для подготовки эластичных пулов. 400 ElasticPoolDtuBelowLimit — запрошенное значение DTU слишком низко для запрошенного уровня служб эластичного пула. 400 ElasticPoolDtuAboveLimit — запрошенное значение DTU слишком велико для запрошенного уровня служб эластичного пула. 400 InvalidMaxSize — недопустимый максимальный размер. 400 ElasticPoolDbDtuMaxBelowLimit — запрошенное максимальное значение DTU базы данных слишком мало для запрошенного уровня служб эластичного пула. 400 ElasticPoolDbDtuMaxAboveLimit — запрошенное максимальное значение DTU базы данных слишком велико для запрошенного уровня служб эластичного пула. 400 InvalidInputValueForDatabaseDtuMax — попытка задать максимальное значение DTU на базу данных для пула ресурсов, которое не соответствует допустимым значениям. 400 ElasticPoolDbDtuMinAboveLimit — запрошенное минимальное значение DTU на базу данных слишком велико для запрошенного уровня служб. 400 ElasticPoolOverStorage — попытка записи данных в базу данных при достижении предельного объема хранилища эластичного пула. 400 InvalidInputValueForDatabaseDtuMin — попытка задать минимальное значение DTU для каждой базы данных для пула ресурсов, который не соответствует допустимым значениям. 400 ElasticPoolInconsistentDtuGuaranteeSettings — попытка указать минимальное значение DTU для баз данных в эластичном пуле, превышающих запрошенные единицы DTU эластичного пула. 400 ElasticPoolDtuUnsupported — пользователь попытался создать или обновить эластичный пул с емкостью DTU, которая не поддерживается. 400 ElasticPoolStorageAboveLimitGB — попытка установить ограничение хранилища эластичного пула ниже поддерживаемого ограничения. 400 ElasticPoolsNotEnabled — эластичные пулы не включены в этом регионе. 400 ElasticPoolNotEmpty — запрос на удаление непустого эластичного пула. 400 ElasticPoolStorageBelowLimitGB — попытка установить ограничение хранилища эластичного пула ниже поддерживаемого ограничения. 400 ElasticPoolStorageNotAllowedGB — попытка установить ограничение хранилища эластичного пула в ГБ, которое не соответствует допустимым значениям. 400 ElasticPoolDatabaseLimit — для эластичного пула достигнуто предельное количество баз данных. 400 ElasticPoolDecreaseStorageLimitBelowUsage — попытка уменьшить ограничение хранилища эластичного пула ниже его использования. 400 InvalidInputValueDatabaseDtuMinLargerThanMax — попытка установить минимальное значение DTU для базы данных, превышающее максимальное значение DTU на базу данных. 400 ElasticPoolInconsistentVcoreGuaranteeSettings — количество баз данных и минимальное количество виртуальных ядер на базу данных не может превышать запрошенные виртуальные ядра эластичного пула. 400 ElasticPoolStorageBelowLimitMB — попытка установить ограничение хранилища эластичного пула ниже поддерживаемого ограничения. 400 ElasticPoolStorageNotAllowedMB — попытка установить ограничение хранилища эластичного пула в МБ, которое не соответствует допустимым значениям. 400 ElasticPoolCapacityStorageNotAllowedMB — попытка установить ограничение хранилища эластичного пула в МБ, которое не соответствует допустимым значениям. 400 ElasticPoolStorageAboveLimitMB — попытка установить ограничение хранилища эластичного пула ниже поддерживаемого ограничения. 400 RegionDoesNotSupportVersion — пользователь пытался создать сервер указанной версии в расположении, где эта версия сервера не поддерживается. 400 InvalidTier — пользователь указал недопустимый уровень. 400 SourceDatabaseEditionCouldNotBeUpgraded — база данных-источник не может иметь более высокий выпуск, чем целевая база данных. 400 TargetDatabaseEditionCouldNotBeDowngraded — целевая база данных не может иметь более низкий выпуск, чем база данных-источник. 400 ElasticPoolUpdateHkNotAllowed — эластичный пул не может понизить уровень служб с уровня "Премиум" до уровня "Стандартный" или "Базовый", так как одна или несколько баз данных используют объекты, оптимизированные для памяти. 400 UpdateNotAllowedIfGeoDrOperationInProgress — операция запрещена, так как операция копирования или отработки отказа для базы данных "{0}" на сервере "{1}" в настоящее время выполняется. 400 RegionDoesNotAllowProvisioning — выбранное расположение не принимает новые серверы Windows Azure SQL Database. Это может измениться позже. 400 ElasticPoolOverFileSpace — недостаточно места в файле в эластичном пуле. 400 ElasticPoolDbDtuMinBelowLimit — запрошенный минимум DTU базы данных слишком мал для запрошенного уровня служб эластичного пула. 400 ElasticPoolDbVcoreMaxBelowLimit — запрошенное максимальное количество виртуальных ядер базы данных слишком мало для запрошенного уровня служб эластичного пула. 400 ElasticPoolDbVcoreMaxAboveLimit — запрошенное максимальное количество виртуальных ядер базы данных слишком велико для запрошенного уровня служб эластичного пула. 400 InvalidInputValueForDatabaseVcoreMax — попытка задать максимальное число виртуальных ядер для базы данных для пула ресурсов, который не соответствует допустимым значениям. 400 ElasticPoolDbVcoreMinBelowLimit — запрошенное минимальное значение для каждого виртуального ядра базы данных слишком мало для запрошенного уровня служб эластичного пула. 400 InvalidInputValueForDatabaseVcoreMin — попытка задать минимальное значение виртуального ядра для базы данных для пула ресурсов, который не соответствует допустимым значениям. 400 PartnerDBNotCompatibleForSGXEnclave — попытка задать ссылку GeoDR или обновить SLO для базы данных с поддержкой анклава поддерживается только в том случае, если обе базы данных работают на оборудовании серии DC. 400 InvalidInputValueDatabaseVcoreMinLargerThanMax — попытка установить минимальное значение виртуального ядра для базы данных, превышающее максимальное число виртуальных ядер на базу данных. 400 InvalidLicenseType — пользователь пытался создать или обновить базу данных или эластичный пул с неподдерживаемого типа лицензии. 400 ProvisioningDisabled — отображает сообщение об ошибке от авторизации операции ресурсов без изменений. 400 InvalidPublicMaintenanceConfiguration — пользователь попытался указать общедоступную конфигурацию обслуживания, которая не может быть преобразована во внутренний идентификатор (неправильно сформированный или неправильный регион). 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден. 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке. 404 ElasticPoolNotFound — указанный эластичный пул не существует для указанного сервера. 404 OperationIdNotFound — операция с идентификатором не существует. 405 NotSupported — эта функция не поддерживается. 409 ElasticPoolBusy — попытка выполнить операцию управления в эластичном пуле, который занят. 409 ServerDisabled — сервер отключен. 409 SimultaneousSkuChangeNotAllowed — операции изменения цели службы не могут выполняться одновременно в обеих базах данных связи репликации. 409 ElasticPoolUpdateLinksNotInCatchup — не удается обновить эластичный пул, пока одна из его баз данных выполняет отработку отказа копирования или георепликации. 409 OperationCancelled — операция была отменена пользователем. 409 OperationInterrupted — не удалось завершить операцию с ресурсом, так как она была прервана другой операцией с тем же ресурсом. 429 SubscriptionTooManyCreateUpdateRequests — запросы сверх максимального количества запросов, которые могут быть обработаны доступными ресурсами. 429 SubscriptionTooManyRequests — запросы, превышающие максимальное количество запросов, которые могут быть обработаны доступными ресурсами. 500 ElasticPoolFailedMoveDbToElasticPool — не удалось переместить базу данных в эластичный пул из-за внутренних ограничений ресурсов. Это может быть временное условие, повторите попытку. 500 OperationTimedOut — время ожидания операции истекло и автоматически откатывается. Повторите операцию. 503 ServiceTemporarilyUnavailable — компонент временно недоступен. 503 TooManyRequests — запросы сверх максимального числа запросов, которые могут быть обработаны доступными ресурсами.

Примеры

Get all elastic pools in a server

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for ElasticPools ListByServer. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ElasticPoolListByServer.json
     */
    /**
     * Sample code: Get all elastic pools in a server.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAllElasticPoolsInAServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getElasticPools().listByServer("sqlcrudtest-2369",
            "sqlcrudtest-8069", 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/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-2729",
      "name": "sqlcrudtest-2729",
      "type": "Microsoft.Sql/servers/elasticPools",
      "location": "Japan East",
      "kind": null,
      "sku": {
        "name": "GP_Gen4_2",
        "tier": "GeneralPurpose",
        "capacity": 2
      },
      "properties": {
        "creationDate": "2017-02-10T01:27:21.32Z",
        "state": "Ready",
        "maxSizeBytes": 5242880000,
        "perDatabaseSettings": {
          "minCapacity": 0.25,
          "maxCapacity": 1
        },
        "zoneRedundant": true,
        "licenseType": "LicenseIncluded"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-3191",
      "name": "sqlcrudtest-3191",
      "type": "Microsoft.Sql/servers/elasticPools",
      "location": "Japan East",
      "kind": null,
      "sku": {
        "name": "BasicPool",
        "tier": "Basic",
        "capacity": 50
      },
      "properties": {
        "creationDate": "2017-02-10T01:26:26.45Z",
        "state": "Ready",
        "maxSizeBytes": 5242880000,
        "perDatabaseSettings": {
          "minCapacity": 0,
          "maxCapacity": 5
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
      "name": "sqlcrudtest-8102",
      "type": "Microsoft.Sql/servers/elasticPools",
      "location": "Japan East",
      "kind": null,
      "sku": {
        "name": "BasicPool",
        "tier": "Basic",
        "capacity": 50
      },
      "properties": {
        "creationDate": "2017-02-10T01:25:25.033Z",
        "state": "Ready",
        "maxSizeBytes": 5242880000,
        "perDatabaseSettings": {
          "minCapacity": 0,
          "maxCapacity": 5
        }
      }
    }
  ]
}

Определения

Имя	Описание
ElasticPool	Пул эластичных баз данных.
ElasticPoolLicenseType	Тип лицензии, применяемой для этого эластичного пула.
ElasticPoolListResult	Результат запроса списка эластичных пулов.
ElasticPoolPerDatabaseSettings	Параметры базы данных эластичного пула.
ElasticPoolState	Состояние эластичного пула.
Sku	SKU ресурса ARM.

ElasticPool

Пул эластичных баз данных.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
kind	string	Тип эластичного пула. Это метаданные, используемые для портал Azure взаимодействия.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.creationDate	string	Дата создания эластичного пула (ISO8601 формате).
properties.highAvailabilityReplicaCount	integer	Количество вторичных реплик, связанных с эластичным пулом, которые используются для обеспечения высокого уровня доступности. Применимо только к эластичным пулам с гипермасштабированием.
properties.licenseType	ElasticPoolLicenseType	Тип лицензии, применяемой для этого эластичного пула.
properties.maintenanceConfigurationId	string	Идентификатор конфигурации обслуживания, назначенный эластичному пулу. Эта конфигурация определяет период, когда будут выполняться обновления для обслуживания.
properties.maxSizeBytes	integer	Ограничение хранилища для эластичного пула базы данных в байтах.
properties.minCapacity	number	Минимальная емкость, что бессерверный пул не будет уменьшаться ниже, если не приостановлено
properties.perDatabaseSettings	ElasticPoolPerDatabaseSettings	Параметры базы данных для эластичного пула.
properties.state	ElasticPoolState	Состояние эластичного пула.
properties.zoneRedundant	boolean	Является ли этот эластичный пул избыточным между зонами. Это означает, что реплики этого эластичного пула будут распределены по нескольким зонам доступности.
sku	Sku	Номер SKU эластичного пула. Список номеров SKU может отличаться в зависимости от региона и предложения поддержки. Чтобы определить номера SKU (включая имя SKU, уровень или выпуск, семейство и емкость), доступные для вашей подписки в регионе Azure, используйте Capabilities_ListByLocation REST API или следующую команду: az sql elastic-pool list-editions -l <location> -o table
tags	object	Теги ресурсов.
type	string	Тип ресурса.

ElasticPoolLicenseType

Тип лицензии, применяемой для этого эластичного пула.

Имя	Тип	Описание
BasePrice	string
LicenseIncluded	string

ElasticPoolListResult

Результат запроса списка эластичных пулов.

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей страницы результатов.
value	ElasticPool[]	Массив результатов.

ElasticPoolPerDatabaseSettings

Параметры базы данных эластичного пула.

Имя	Тип	Описание
maxCapacity	number	Максимальная емкость, доступная для любой базы данных.
minCapacity	number	Гарантируется минимальная емкость всех баз данных.

ElasticPoolState

Состояние эластичного пула.

Имя	Тип	Описание
Creating	string
Disabled	string
Ready	string

Sku

SKU ресурса ARM.

Имя	Тип	Описание
capacity	integer	Емкость конкретного номера SKU.
family	string	Если служба имеет разные поколения оборудования для одного номера SKU, то это можно записать здесь.
name	string	Имя номера SKU, как правило, буква + номер, например P3.
size	string	Размер конкретного номера SKU
tier	string	Уровень или выпуск конкретного номера SKU, например "Базовый", "Премиум".