Compartilhar via


Elastic Pools - List By Server

Obtém todos os pools elásticos em um servidor.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.

serverName
path True

string

O nome do servidor.

subscriptionId
path True

string

A ID da assinatura que identifica uma assinatura do Azure.

api-version
query True

string

A versão da API a ser usada para a solicitação.

$skip
query

integer (int64)

O número de elementos na coleção a ser ignorada.

Respostas

Nome Tipo Description
200 OK

ElasticPoolListResult

Conseguiu

Other Status Codes

ErrorResponse

Respostas de erro: ***

  • 400 ManagedInstanceStoppingOrStopped – Operação conflitante enviada enquanto a instância está no estado de parada/parada

  • 400 ManagedInstanceStarting – Operação conflitante enviada enquanto a instância está no estado inicial

  • 400 ElasticPoolOverStorageUsage – Tentativa de gravar dados em um banco de dados quando o limite de armazenamento do pool elástico for atingido.

  • 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases – O pool elástico contém bancos de dados inacessíveis que perderam o acesso ao Azure Key Vault necessário para a configuração do TDE. Mova os bancos de dados acessíveis para um pool diferente para dimensionar ou restaurar o acesso perdido do Azure Key Vault para os bancos de dados inacessíveis.

  • 400 CreateElasticPoolAttemptedWhenKeyRotationInProgress - A operação criar pool elástico não pode ser executada no momento devido à rotação de chaves TDE (Transparent Data Encryption) contínua no servidor. Tente a operação novamente mais tarde.

  • 400 InvalidSku – O usuário especificou um sku inválido.

  • 400 InvalidTierSkuCombination – a camada especificada não dá suporte ao sku especificado.

  • 400 ServerQuotaExceeded - O servidor atingiu seu limite para a Unidade de Taxa de Transferência de Banco de Dados permitida.

  • 400 ElasticPoolAlreadyExists - O servidor já contém um pool elástico com o nome especificado.

  • 400 SubscriptionVcoreQuotaExceeded - Não foi possível executar a operação porque a assinatura excederia a cota de vCore permitida.

  • 400 InvalidInputValueForEdition – Não há suporte para edição especificada para provisionamento de pool elástico.

  • 400 ElasticPoolDtuBelowLimit - O valor de DTU solicitado é muito baixo para a camada de serviço do pool elástico solicitada.

  • 400 ElasticPoolDtuAboveLimit - O valor de DTU solicitado é muito alto para a camada de serviço do pool elástico solicitada.

  • 400 InvalidMaxSize – Tamanho máximo inválido.

  • 400 ElasticPoolDbDtuMaxBelowLimit – o máximo de DTU solicitado por banco de dados é muito baixo para a camada de serviço do pool elástico solicitada.

  • 400 ElasticPoolDbDtuMaxAboveLimit – o máximo de DTU solicitado por banco de dados é muito alto para a camada de serviço do pool elástico solicitada.

  • 400 InvalidInputValueForDatabaseDtuMax – Tentando definir o máximo de DTU por banco de dados para o Pool de Recursos que não corresponde aos valores permitidos.

  • 400 ElasticPoolDbDtuMinAboveLimit – o mínimo de DTU solicitado por banco de dados é muito alto para a camada de serviço solicitada.

  • 400 ElasticPoolOverStorage – Tentativa de gravar dados em um banco de dados quando o limite de armazenamento do pool elástico for atingido.

  • 400 InvalidInputValueForDatabaseDtuMin – Tentativa de definir o mínimo de DTU por banco de dados para o Pool de Recursos que não corresponde aos valores permitidos.

  • 400 ElasticPoolInconsistentDtuGuaranteeSettings – Tentando fornecer dtu min para bancos de dados no pool elástico que excede as DTUs solicitadas do pool elástico.

  • 400 ElasticPoolDtuUnsupported – O usuário tentou criar ou atualizar um pool elástico com uma capacidade de DTU sem suporte.

  • 400 ElasticPoolStorageAboveLimitGB – tentando definir o limite de armazenamento do pool elástico abaixo do limite com suporte.

  • 400 ElasticPoolsNotEnabled – Os pools elásticos não foram habilitados nesta região.

  • 400 ElasticPoolNotEmpty – Solicitação para excluir um pool elástico que não está vazio.

  • 400 ElasticPoolStorageBelowLimitGB – tentando definir o limite de armazenamento do pool elástico abaixo do limite com suporte.

  • 400 ElasticPoolStorageNotAllowedGB – tentativa de definir o limite de armazenamento do pool elástico em gb que não corresponde aos valores permitidos.

  • 400 ElasticPoolDatabaseLimit – O pool elástico atingiu seu limite para o número de bancos de dados.

  • 400 ElasticPoolDecreaseStorageLimitBelowUsage – Tentando diminuir o limite de armazenamento do pool elástico abaixo de seu uso de armazenamento.

  • 400 InvalidInputValueDatabaseDtuMinLargerThanMax – Tentando definir o mínimo de DTU por banco de dados maior que o máximo de DTU por banco de dados.

  • 400 ElasticPoolInconsistentVcoreGuaranteeSettings - O número de bancos de dados e VCore min por banco de dados não pode exceder VCores solicitados do pool elástico.

  • 400 ElasticPoolStorageBelowLimitMB – Tentando definir o limite de armazenamento do pool elástico abaixo do limite com suporte.

  • 400 ElasticPoolStorageNotAllowedMB – Tentativa de definir o limite de armazenamento do pool elástico em mb que não corresponde aos valores permitidos.

  • 400 ElasticPoolCapacityStorageNotAllowedMB – Tentativa de definir o limite de armazenamento do pool elástico em mb que não corresponde aos valores permitidos.

  • 400 InvalidReadScaleUnits – O usuário tentou fornecer um valor de escala de leitura sem suporte.

  • 400 ElasticPoolStorageAboveLimitMB – Tentando definir o limite de armazenamento do pool elástico abaixo do limite com suporte.

  • 400 RegionDoesNotSupportVersion – Um usuário tentou criar um servidor de uma versão especificada em um local onde não há suporte para essa versão do servidor.

  • 400 InvalidTier – O usuário especificou uma camada inválida.

  • 400 SourceDatabaseEditionCouldNotBeUpgraded - O banco de dados de origem não pode ter uma edição maior do que o banco de dados de destino.

  • 400 TargetDatabaseEditionCouldNotBeDowngraded – O banco de dados de destino não pode ter uma edição menor que o banco de dados de origem.

  • 400 ElasticPoolUpdateHkNotAllowed - O pool elástico não pode reduzir sua camada de serviço de Premium para Standard ou Basic, pois um ou mais de seus bancos de dados usam objetos com otimização de memória.

  • 400 UpdateNotAllowedIfGeoDrOperationInProgress – A operação não é permitida porque a operação de cópia ou failover do banco de dados '{0}' no servidor '{1}' está em andamento no momento.

  • 400 RegionDoesNotAllowProvisioning - O local selecionado não está aceitando novos servidores do Banco de Dados SQL do Windows Azure. Isso pode mudar posteriormente.

  • 400 HSElasticPoolUpdateSloPRMSNotSupported – Falha na atribuição de objetivo de serviço do banco de dados. Entre em contato com o suporte ao cliente da Microsoft e forneça o nome do servidor, o nome do banco de dados e a ID da atividade.

  • 400 ElasticPoolOverFileSpace – Espaço de arquivo insuficiente no pool elástico.

  • 400 ElasticPoolDbDtuMinBelowLimit – o mínimo de DTU solicitado por banco de dados é muito baixo para a camada de serviço do pool elástico solicitada.

  • 400 ElasticPoolDbVcoreMaxBelowLimit - O máximo de VCore solicitado por banco de dados é muito baixo para a camada de serviço do pool elástico solicitada.

  • 400 ElasticPoolDbVcoreMaxAboveLimit – o máximo de VCore solicitado por banco de dados é muito alto para a camada de serviço do pool elástico solicitada.

  • 400 InvalidInputValueForDatabaseVcoreMax – Tentando definir o máximo de VCore por banco de dados para o Pool de Recursos que não corresponde aos valores permitidos.

  • 400 ElasticPoolDbVcoreMinBelowLimit – o mínimo de VCore solicitado por banco de dados é muito baixo para a camada de serviço do pool elástico solicitada.

  • 400 InvalidInputValueForDatabaseVcoreMin – Tentando definir o min VCore por banco de dados para o Pool de Recursos que não corresponde aos valores permitidos.

  • 400 PartnerDBNotCompatibleForSGXEnclave – A tentativa de definir o link GeoDR ou atualizar o SLO para o banco de dados habilitado para enclave só tem suporte quando ambos os bancos de dados estão em execução no hardware da série DC.

  • 400 InvalidInputValueDatabaseVcoreMinLargerThanMax – tentando definir o min VCore por banco de dados maior que o máximo de VCore por banco de dados.

  • 400 InvalidLicenseType – O usuário tentou criar ou atualizar um banco de dados ou pool elástico com tipo de licença sem suporte.

  • 400 ProvisioningDisabled – Exibe mensagem de erro do autorizador de operação de recursos como está, sem alterações

  • 400 CapacityGroupThresholdExceeded - O objetivo de nível de serviço solicitado e o tamanho do armazenamento são mapeados para um grupo de capacidade específico e, atualmente, os recursos para esse grupo de capacidade têm um limite de alcance e outras ações precisam ser executadas antes que mais bancos de dados possam ser colocados nesses anéis.

  • 400 CapacityGroupThresholdCheckFail – Falha na verificação de restrição de recurso do grupo de capacidade, portanto, não foi possível verificar se existe capacidade suficiente para concluir a operação.

  • 400 InvalidPublicMaintenanceConfiguration – o usuário tentou especificar a configuração de manutenção pública que não pode ser convertida em ID interna (região malformada ou incorreta).

  • 404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados.

  • 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado

  • 404 ElasticPoolNotFound – O pool elástico especificado não existe para o servidor especificado.

  • 404 OperationIdNotFound – A operação com id não existe.

  • 405 NotSupported – Não há suporte para essa funcionalidade.

  • 409 ElasticPoolBusy – Uma operação de gerenciamento foi tentada em um pool elástico que está ocupado.

  • 409 ServerDisabled – O servidor está desabilitado.

  • 409 SimultaneousSkuChangeNotAllowed – As operações de alteração de objetivo de serviço não podem ser executadas em ambos os bancos de dados de uma relação de replicação ao mesmo tempo.

  • 409 ElasticPoolUpdateLinksNotInCatchup – Não é possível atualizar o pool elástico enquanto um de seus bancos de dados está executando uma operação de failover de cópia ou replicação geográfica.

  • 409 CannotCancelOperation – A operação de gerenciamento está em um estado que não pode ser cancelado.

  • 409 OperationCancelled – A operação foi cancelada pelo usuário.

  • 409 OperationInterrupted – A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso.

  • 429 SubscriptionTooManyCreateUpdateRequests – Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis.

  • 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

  • 500 ElasticPoolFailedMoveDbToElasticPool – Falha ao mover o banco de dados para o pool elástico devido a restrições de recursos internas. Pode ser uma condição transitória, tente novamente.

  • 500 OperationTimedOut – A operação atingiu o tempo limite e foi revertida automaticamente. Tente novamente a operação.

  • 503 ServiceTemporarilyUnavailable – Recurso temporariamente indisponível.

  • 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

Exemplos

Get all elastic pools in a server

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
AlwaysEncryptedEnclaveType

Tipo de enclave solicitado no pool elástico.

AvailabilityZoneType

Especifica a zona de disponibilidade à qual a réplica primária do pool está fixada.

ElasticPool

Um pool elástico.

ElasticPoolLicenseType

O tipo de licença a ser aplicado a esse pool elástico.

ElasticPoolListResult

O resultado de uma solicitação de lista de pool elástico.

ElasticPoolPerDatabaseSettings

Por configurações de banco de dados de um pool elástico.

ElasticPoolState

O estado do pool elástico.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

Sku

Um SKU de recurso do ARM.

AlwaysEncryptedEnclaveType

Tipo de enclave solicitado no pool elástico.

Valor Description
Default
VBS

AvailabilityZoneType

Especifica a zona de disponibilidade à qual a réplica primária do pool está fixada.

Valor Description
NoPreference
1
2
3

ElasticPool

Um pool elástico.

Nome Tipo Description
id

string

ID do recurso.

kind

string

Tipo de pool elástico. Esses são metadados usados para a experiência do portal do Azure.

location

string

Local do recurso.

name

string

Nome do recurso.

properties.autoPauseDelay

integer (int32)

Tempo em minutos após o qual o pool elástico é pausado automaticamente. Um valor de -1 significa que a pausa automática está desabilitada

properties.availabilityZone

AvailabilityZoneType

Especifica a zona de disponibilidade à qual a réplica primária do pool está fixada.

properties.creationDate

string (date-time)

A data de criação do pool elástico (formato ISO8601).

properties.highAvailabilityReplicaCount

integer (int32)

O número de réplicas secundárias associadas ao pool elástico da edição Business Critical, Premium ou Hyperscale que são usadas para fornecer alta disponibilidade. Aplicável somente a pools elásticos de Hiperescala.

properties.licenseType

ElasticPoolLicenseType

O tipo de licença a ser aplicado a esse pool elástico.

properties.maintenanceConfigurationId

string

ID de configuração de manutenção atribuída ao pool elástico. Essa configuração define o período em que as atualizações de manutenção ocorrerão.

properties.maxSizeBytes

integer (int64)

O limite de armazenamento do pool elástico do banco de dados em bytes.

properties.minCapacity

number (double)

Capacidade mínima que o pool sem servidor não reduzirá abaixo, se não estiver em pausa

properties.perDatabaseSettings

ElasticPoolPerDatabaseSettings

As configurações por banco de dados para o pool elástico.

properties.preferredEnclaveType

AlwaysEncryptedEnclaveType

Tipo de enclave solicitado no pool elástico.

properties.state

ElasticPoolState

O estado do pool elástico.

properties.zoneRedundant

boolean

Se esse pool elástico é ou não redundante por zona, o que significa que as réplicas desse pool elástico serão distribuídas entre várias zonas de disponibilidade.

sku

Sku

O SKU do pool elástico.

A lista de SKUs pode variar de acordo com a região e a oferta de suporte. Para determinar os SKUs (incluindo o nome do SKU, camada/edição, família e capacidade) que estão disponíveis para sua assinatura em uma região do Azure, use a API REST Capabilities_ListByLocation ou o seguinte comando:

az sql elastic-pool list-editions -l <location> -o table
tags

object

Marcas de recurso.

type

string

Tipo de recurso.

ElasticPoolLicenseType

O tipo de licença a ser aplicado a esse pool elástico.

Valor Description
LicenseIncluded
BasePrice

ElasticPoolListResult

O resultado de uma solicitação de lista de pool elástico.

Nome Tipo Description
nextLink

string

Link para recuperar a próxima página de resultados.

value

ElasticPool[]

Matriz de resultados.

ElasticPoolPerDatabaseSettings

Por configurações de banco de dados de um pool elástico.

Nome Tipo Description
autoPauseDelay

integer (int32)

Pausar automaticamente o atraso por banco de dados no pool

maxCapacity

number (double)

A capacidade máxima que qualquer banco de dados pode consumir.

minCapacity

number (double)

A capacidade mínima de todos os bancos de dados é garantida.

ElasticPoolState

O estado do pool elástico.

Valor Description
Creating
Ready
Disabled

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

Sku

Um SKU de recurso do ARM.

Nome Tipo Description
capacity

integer (int32)

Capacidade da SKU específica.

family

string

Se o serviço tiver diferentes gerações de hardware, para a mesma SKU, isso poderá ser capturado aqui.

name

string

O nome da SKU, normalmente, uma letra + código de número, por exemplo, P3.

size

string

Tamanho da SKU específica

tier

string

A camada ou edição da SKU específica, por exemplo, Basic, Premium.