Elastic Pools - List By Server

Serviço:: SQL Database

Versão da API:: 2025-01-01

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=2025-01-01

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
$skip	query		integer (int64)	O número de elementos na coleção a serem ignorados.

Respostas

Name	Tipo	Description
200 OK	ElasticPoolListResult	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get all elastic pools in a server

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "name": "sqlcrudtest-2729",
      "type": "Microsoft.Sql/servers/elasticPools",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-2729",
      "kind": null,
      "location": "Japan East",
      "properties": {
        "creationDate": "2017-02-10T01:27:21.32Z",
        "licenseType": "LicenseIncluded",
        "maxSizeBytes": 5242880000,
        "perDatabaseSettings": {
          "maxCapacity": 1,
          "minCapacity": 0.25
        },
        "state": "Ready",
        "zoneRedundant": true
      },
      "sku": {
        "name": "GP_Gen4_2",
        "capacity": 2,
        "tier": "GeneralPurpose"
      }
    },
    {
      "name": "sqlcrudtest-3191",
      "type": "Microsoft.Sql/servers/elasticPools",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-3191",
      "kind": null,
      "location": "Japan East",
      "properties": {
        "creationDate": "2017-02-10T01:26:26.45Z",
        "maxSizeBytes": 5242880000,
        "perDatabaseSettings": {
          "maxCapacity": 5,
          "minCapacity": 0
        },
        "state": "Ready"
      },
      "sku": {
        "name": "BasicPool",
        "capacity": 50,
        "tier": "Basic"
      }
    },
    {
      "name": "sqlcrudtest-8102",
      "type": "Microsoft.Sql/servers/elasticPools",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
      "kind": null,
      "location": "Japan East",
      "properties": {
        "creationDate": "2017-02-10T01:25:25.033Z",
        "maxSizeBytes": 5242880000,
        "perDatabaseSettings": {
          "maxCapacity": 5,
          "minCapacity": 0
        },
        "state": "Ready"
      },
      "sku": {
        "name": "BasicPool",
        "capacity": 50,
        "tier": "Basic"
      }
    }
  ]
}

Definições

Name	Description
AlwaysEncryptedEnclaveType	Tipo de enclave solicitado no banco de dados, ou seja, enclaves padrão ou VBS.
AvailabilityZoneType	Especifica a zona de disponibilidade na qual o banco de dados está fixado.
createdByType	O tipo de identidade que criou o recurso.
ElasticPool	Uma piscina elástica.
ElasticPoolLicenseType	O tipo de licença a ser aplicado para esse pool elástico.
ElasticPoolListResult	A resposta de uma operação de lista ElasticPool.
ElasticPoolPerDatabaseSettings	Por configurações de banco de dados de um pool elástico.
ElasticPoolState	O estado do pool elástico.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Sku	Um SKU de recurso ARM.
systemData	Metadados referentes à criação e última modificação do recurso.

AlwaysEncryptedEnclaveType

Enumeração

Tipo de enclave solicitado no banco de dados, ou seja, enclaves padrão ou VBS.

Valor	Description
Default	Predefinição
VBS	VBS

AvailabilityZoneType

Enumeração

Especifica a zona de disponibilidade na qual o banco de dados está fixado.

Valor	Description
NoPreference	Sem Preferência
1	1
2	2
3	3

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ElasticPool

Object

Uma piscina elástica.

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de piscina elástica. Estes são metadados usados para a experiência do portal Azure.
location	string	A geolocalização onde o recurso vive
name	string	O 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á desativada
properties.availabilityZone	AvailabilityZoneType	Especifica a zona de disponibilidade na 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 Business Critical, Premium ou Hyperscale edition que são usadas para fornecer alta disponibilidade. Aplicável apenas a pools elásticos Hyperscale.
properties.licenseType	ElasticPoolLicenseType	O tipo de licença a ser aplicado para esse pool elástico.
properties.maintenanceConfigurationId	string	ID de configuração de manutenção atribuído 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 para o pool elástico de banco de dados em bytes.
properties.minCapacity	number (double)	Capacidade mínima que o pool sem servidor não diminuirá abaixo, se não for pausado
properties.perDatabaseSettings	ElasticPoolPerDatabaseSettings	As configurações por banco de dados para o pool elástico.
properties.preferredEnclaveType	AlwaysEncryptedEnclaveType	Tipo de enclave solicitado na piscina elástica.
properties.state	ElasticPoolState	O estado do pool elástico.
properties.zoneRedundant	boolean	Se esse pool elástico é ou não redundante de zona, o que significa que as réplicas desse pool elástico serão espalhadas por várias zonas de disponibilidade.
sku	Sku	A piscina elástica SKU. A lista de SKUs pode variar de acordo com a região e a oferta de suporte. Para determinar os SKUs (incluindo o nome, nível/edição, família e capacidade) disponíveis para a sua subscrição numa região Azure, utilize a API REST `Capabilities_ListByLocation` ou o seguinte comando: `az sql elastic-pool list-editions -l <location> -o table`
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

ElasticPoolLicenseType

Enumeração

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

Valor	Description
LicenseIncluded	LicençaIncluído
BasePrice	BasePrice

ElasticPoolListResult

Object

A resposta de uma operação de lista ElasticPool.

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	ElasticPool[]	Os itens do ElasticPool nesta página

ElasticPoolPerDatabaseSettings

Object

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

Name	Tipo	Description
autoPauseDelay	integer (int32)	Atraso de pausa automática por banco de dados dentro do pool
maxCapacity	number (double)	A capacidade máxima que qualquer banco de dados pode consumir.
minCapacity	number (double)	A capacidade mínima de todas as bases de dados são garantidas.

ElasticPoolState

Enumeração

O estado do pool elástico.

Valor	Description
Creating	Criação
Ready	Pronto/a
Disabled	Disabled

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Sku

Object

Um SKU de recurso ARM.

Name	Tipo	Description
capacity	integer (int32)	Capacidade do SKU específico.
family	string	Se o serviço tiver diferentes gerações de hardware, para o mesmo SKU, isso pode ser capturado aqui.
name	string	O nome do SKU, normalmente, uma letra + código numérico, por exemplo, P3.
size	string	Tamanho do SKU específico
tier	string	O nível ou edição do SKU específico, por exemplo, Basic, Premium.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Elastic Pools - List By Server

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Get all elastic pools in a server

Pedido de amostra

Resposta da amostra

Definições

AlwaysEncryptedEnclaveType

AvailabilityZoneType

createdByType

ElasticPool

ElasticPoolLicenseType

ElasticPoolListResult

ElasticPoolPerDatabaseSettings

ElasticPoolState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

systemData