Elastic Pools - Get

Serviço:: SQL Database

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

Obtém um pool elástico.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
elasticPoolName	path	True	string	O nome do pool elástico.
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 uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ElasticPool	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
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get a Hyperscale elastic pool

Get an elastic pool

Get an elastic pool with Availability Zone

Get an elastic pool with preferred enclave type parameter

Get an elastic pool with serverless properties

Get a Hyperscale elastic pool

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "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": "vcore,pool",
  "location": "Japan East",
  "properties": {
    "creationDate": "2021-08-26T03:46:20.57Z",
    "highAvailabilityReplicaCount": 2,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default",
    "maxSizeBytes": 0,
    "perDatabaseSettings": {
      "maxCapacity": 4,
      "minCapacity": 0
    },
    "state": "Ready",
    "zoneRedundant": false
  },
  "sku": {
    "name": "HS_Gen5",
    "capacity": 4,
    "family": "Gen5",
    "tier": "Hyperscale"
  }
}

Get an elastic pool

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "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-10-10T01:25:25.033Z",
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_1",
    "maxSizeBytes": 5242880000,
    "perDatabaseSettings": {
      "maxCapacity": 1,
      "minCapacity": 0.25
    },
    "state": "Ready",
    "zoneRedundant": true
  },
  "sku": {
    "name": "GP_Gen5_2",
    "capacity": 2,
    "tier": "GeneralPurpose"
  }
}

Get an elastic pool with Availability Zone

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "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": {
    "availabilityZone": "1",
    "creationDate": "2017-10-10T01:25:25.033Z",
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_1",
    "maxSizeBytes": 5242880000,
    "perDatabaseSettings": {
      "maxCapacity": 1,
      "minCapacity": 0.25
    },
    "state": "Ready",
    "zoneRedundant": true
  },
  "sku": {
    "name": "GP_Gen5_2",
    "capacity": 2,
    "tier": "GeneralPurpose"
  }
}

Get an elastic pool with preferred enclave type parameter

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "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": "vcore,pool",
  "location": "Japan East",
  "properties": {
    "creationDate": "2022-08-26T03:46:20.57Z",
    "highAvailabilityReplicaCount": 2,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default",
    "maxSizeBytes": 0,
    "perDatabaseSettings": {
      "maxCapacity": 4,
      "minCapacity": 0
    },
    "preferredEnclaveType": "VBS",
    "state": "Ready",
    "zoneRedundant": false
  },
  "sku": {
    "name": "GP_Gen5",
    "capacity": 4,
    "family": "Gen5",
    "tier": "GeneralPurpose"
  }
}

Get an elastic pool with serverless properties

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "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": {
    "autoPauseDelay": 60,
    "creationDate": "2017-10-10T01:25:25.033Z",
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_1",
    "maxSizeBytes": 5242880000,
    "minCapacity": 0.5,
    "perDatabaseSettings": {
      "autoPauseDelay": 60,
      "maxCapacity": 1,
      "minCapacity": 0
    },
    "state": "Ready",
    "zoneRedundant": true
  },
  "sku": {
    "name": "GP_S_Gen5_2",
    "capacity": 2,
    "tier": "GeneralPurpose"
  }
}

Definições

Nome	Description
AlwaysEncryptedEnclaveType	Tipo de enclave solicitado no banco de dados, ou seja, enclaves padrão ou VBS.
AvailabilityZoneType	Especifica a zona de disponibilidade à qual o banco de dados está fixado.
createdByType	O tipo de identidade que criou o recurso.
ElasticPool	Um pool elástico.
ElasticPoolLicenseType	O tipo de licença a ser aplicado a esse 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.
systemData	Metadados relativos à 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	Default
VBS	VBS

AvailabilityZoneType

Enumeração

Especifica a zona de disponibilidade à 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

Objeto

Um pool elástico.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de pool elástico. Esses são metadados usados para a experiência do portal Azure.
location	string	A localização geográfica onde o recurso reside
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á 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, nível/edição, família e capacidade) disponíveis para sua assinatura em uma região Azure, use 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. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

ElasticPoolLicenseType

Enumeração

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

Valor	Description
LicenseIncluded	LicençaIncluído
BasePrice	BasePrice

ElasticPoolPerDatabaseSettings

Objeto

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

Enumeração

O estado do pool elástico.

Valor	Description
Creating	Criando
Ready	Pronto
Disabled	Desactivado

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Sku

Objeto

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.

systemData

Objeto

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

Nome	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.

Compartilhar via

Elastic Pools - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Get a Hyperscale elastic pool

Solicitação de exemplo

Resposta de exemplo

Get an elastic pool

Solicitação de exemplo

Resposta de exemplo

Get an elastic pool with Availability Zone

Solicitação de exemplo

Resposta de exemplo

Get an elastic pool with preferred enclave type parameter

Solicitação de exemplo

Resposta de exemplo

Get an elastic pool with serverless properties

Solicitação de exemplo

Resposta de exemplo

Definições

AlwaysEncryptedEnclaveType

AvailabilityZoneType

createdByType

ElasticPool

ElasticPoolLicenseType

ElasticPoolPerDatabaseSettings

ElasticPoolState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

systemData