Databases - List By Elastic Pool

Referência

Service:: SQL Database

API Version:: 2021-11-01

Obtém uma lista de bases de dados num conjunto elástico.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
elasticPoolName	path	True	string	O nome do conjunto elástico.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.

Respostas

Name	Tipo	Description
200 OK	DatabaseListResult	Obteve com êxito uma lista de bases de dados num conjunto elástico.
Other Status Codes		Respostas de Erro: *** 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e subscrição especificados. 404 CannotFindObject – Não é possível localizar o objeto porque não existe ou não tem permissões 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e subscrição especificados. 404 ServerNotInSubscription - O servidor especificado não existe na subscrição especificada. 429 SubscriptionTooManyCreateUpdateRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis. 429 SubscriptionTooManyRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis. 503 TooManyRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis. 504 RequestTimeout - O pedido de serviço excedeu o tempo limite permitido.

Name

Tipo

Description

200 OK

DatabaseListResult

Obteve com êxito uma lista de bases de dados num conjunto elástico.

Other Status Codes

Respostas de Erro: ***

404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado
404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e subscrição especificados.
404 CannotFindObject – Não é possível localizar o objeto porque não existe ou não tem permissões
404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e subscrição especificados.
404 ServerNotInSubscription - O servidor especificado não existe na subscrição especificada.
429 SubscriptionTooManyCreateUpdateRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis.
429 SubscriptionTooManyRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis.
503 TooManyRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis.
504 RequestTimeout - O pedido de serviço excedeu o tempo limite permitido.

Exemplos

Gets a list of databases in an elastic pool.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/elasticPools/pool1/databases?api-version=2021-11-01


import com.azure.core.util.Context;

/** Samples for Databases ListByElasticPool. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListDatabasesByElasticPool.json
     */
    /**
     * Sample code: Gets a list of databases in an elastic pool.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsAListOfDatabasesInAnElasticPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabases().listByElasticPool("Default-SQL-SouthEastAsia",
            "testsvr", "pool1", 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": [
    {
      "sku": {
        "name": "ElasticPool",
        "tier": "Standard"
      },
      "kind": "v12.0,user",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "elasticPoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/elasticPools/Pool1",
        "status": "Online",
        "databaseId": "bfe0735f-bc87-447f-b2c2-481f4b100614",
        "creationDate": "2017-07-12T22:08:39.163Z",
        "currentServiceObjectiveName": "ElasticPool",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS"
      },
      "location": "southeastasia",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/DB001",
      "name": "DB001",
      "type": "Microsoft.Sql/servers/databases"
    },
    {
      "sku": {
        "name": "ElasticPool",
        "tier": "Standard"
      },
      "kind": "v12.0,user",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "elasticPoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/elasticPools/Pool1",
        "status": "Online",
        "databaseId": "82246152-3177-4357-b81c-a16d87ce3593",
        "creationDate": "2017-07-12T22:10:10.773Z",
        "currentServiceObjectiveName": "ElasticPool",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS"
      },
      "location": "southeastasia",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/DB002",
      "name": "DB002",
      "type": "Microsoft.Sql/servers/databases"
    }
  ]
}

Definições

Name	Description
BackupStorageRedundancy	O tipo de conta de armazenamento utilizado para armazenar cópias de segurança para esta base de dados.
CatalogCollationType	Agrupamento do catálogo de metadados.
CreateMode	Especifica o modo de criação da base de dados. Predefinição: criação regular de bases de dados. Copiar: cria uma base de dados como uma cópia de uma base de dados existente. sourceDatabaseId tem de ser especificado como o ID de recurso da base de dados de origem. Secundário: cria uma base de dados como uma réplica secundária de uma base de dados existente. sourceDatabaseId tem de ser especificado como o ID de recurso da base de dados primária existente. PointInTimeRestore: cria uma base de dados ao restaurar uma cópia de segurança para um ponto anterior no tempo de uma base de dados existente. sourceDatabaseId tem de ser especificado como o ID de recurso da base de dados existente e o restorePointInTime tem de ser especificado. Recuperação: cria uma base de dados ao restaurar uma cópia de segurança georreplicada. sourceDatabaseId tem de ser especificado como o ID de recurso de base de dados recuperável a restaurar. Restauro: cria uma base de dados ao restaurar uma cópia de segurança de uma base de dados eliminada. sourceDatabaseId tem de ser especificado. Se sourceDatabaseId for o ID de recurso original da base de dados, tem de especificar sourceDatabaseDeletionDate. Caso contrário, sourceDatabaseId tem de ser o ID do recurso de base de dados removido recuperável e sourceDatabaseDeletionDate é ignorado. restorePointInTime também pode ser especificado para restaurar a partir de um ponto anterior no tempo. RestoreLongTermRetentionBackup: cria uma base de dados ao restaurar a partir de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId tem de ser especificado como o ID do recurso do ponto de recuperação. Copy, Secondary e RestoreLongTermRetentionBackup não são suportados para a edição DataWarehouse.
Database	Um recurso de base de dados.
DatabaseIdentity	Configuração de identidade do Azure Active Directory para um recurso.
DatabaseIdentityType	O tipo de identidade
DatabaseLicenseType	O tipo de licença a aplicar a esta base de dados. `LicenseIncluded`se precisar de uma licença ou `BasePrice` se tiver uma licença e for elegível para o Benefício Híbrido do Azure.
DatabaseListResult	Uma lista de bases de dados.
DatabaseReadScale	O estado do encaminhamento só de leitura. Se estiver ativada, as ligações que tenham a intenção da aplicação definidas de forma só de leitura no respetivo cadeia de ligação podem ser encaminhadas para uma réplica só de leitura secundária na mesma região. Não aplicável a uma base de dados Hyperscale num conjunto elástico.
DatabaseStatus	O estado da base de dados.
DatabaseUserIdentity	Configuração de identidade do Azure Active Directory para um recurso.
SampleName	O nome do esquema de exemplo a aplicar ao criar esta base de dados.
SecondaryType	O tipo secundário da base de dados, se for secundário. Os valores válidos são Geo e Named.
Sku	Um SKU de Recurso do ARM.

BackupStorageRedundancy

O tipo de conta de armazenamento utilizado para armazenar cópias de segurança para esta base de dados.

Name	Tipo	Description
Geo	string
GeoZone	string
Local	string
Zone	string

CatalogCollationType

Agrupamento do catálogo de metadados.

Name	Tipo	Description
DATABASE_DEFAULT	string
SQL_Latin1_General_CP1_CI_AS	string

CreateMode

Especifica o modo de criação da base de dados.

Predefinição: criação regular de bases de dados.

Copiar: cria uma base de dados como uma cópia de uma base de dados existente. sourceDatabaseId tem de ser especificado como o ID de recurso da base de dados de origem.

Secundário: cria uma base de dados como uma réplica secundária de uma base de dados existente. sourceDatabaseId tem de ser especificado como o ID de recurso da base de dados primária existente.

PointInTimeRestore: cria uma base de dados ao restaurar uma cópia de segurança para um ponto anterior no tempo de uma base de dados existente. sourceDatabaseId tem de ser especificado como o ID de recurso da base de dados existente e o restorePointInTime tem de ser especificado.

Recuperação: cria uma base de dados ao restaurar uma cópia de segurança georreplicada. sourceDatabaseId tem de ser especificado como o ID de recurso de base de dados recuperável a restaurar.

Restauro: cria uma base de dados ao restaurar uma cópia de segurança de uma base de dados eliminada. sourceDatabaseId tem de ser especificado. Se sourceDatabaseId for o ID de recurso original da base de dados, tem de especificar sourceDatabaseDeletionDate. Caso contrário, sourceDatabaseId tem de ser o ID do recurso de base de dados removido recuperável e sourceDatabaseDeletionDate é ignorado. restorePointInTime também pode ser especificado para restaurar a partir de um ponto anterior no tempo.

RestoreLongTermRetentionBackup: cria uma base de dados ao restaurar a partir de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId tem de ser especificado como o ID do recurso do ponto de recuperação.

Copy, Secondary e RestoreLongTermRetentionBackup não são suportados para a edição DataWarehouse.

Name	Tipo	Description
Copy	string
Default	string
OnlineSecondary	string
PointInTimeRestore	string
Recovery	string
Restore	string
RestoreExternalBackup	string
RestoreExternalBackupSecondary	string
RestoreLongTermRetentionBackup	string
Secondary	string

Database

Um recurso de base de dados.

Name	Tipo	Description
id	string	ID do Recurso.
identity	DatabaseIdentity	A identidade do Azure Active Directory da base de dados.
kind	string	Tipo de base de dados. Estes são os metadados utilizados para a experiência de portal do Azure.
location	string	Localização do recurso.
managedBy	string	Recurso que gere a base de dados.
name	string	Nome do recurso.
properties.autoPauseDelay	integer	Tempo em minutos após o qual a base de dados é colocada automaticamente em pausa. Um valor de -1 significa que a pausa automática está desativada
properties.catalogCollation	CatalogCollationType	Agrupamento do catálogo de metadados.
properties.collation	string	O agrupamento da base de dados.
properties.createMode	CreateMode	Especifica o modo de criação da base de dados. Predefinição: criação regular de bases de dados. Copiar: cria uma base de dados como uma cópia de uma base de dados existente. sourceDatabaseId tem de ser especificado como o ID de recurso da base de dados de origem. Secundário: cria uma base de dados como uma réplica secundária de uma base de dados existente. sourceDatabaseId tem de ser especificado como o ID de recurso da base de dados primária existente. PointInTimeRestore: cria uma base de dados ao restaurar uma cópia de segurança para um ponto anterior no tempo de uma base de dados existente. sourceDatabaseId tem de ser especificado como o ID de recurso da base de dados existente e o restorePointInTime tem de ser especificado. Recuperação: cria uma base de dados ao restaurar uma cópia de segurança georreplicada. sourceDatabaseId tem de ser especificado como o ID de recurso de base de dados recuperável a restaurar. Restauro: cria uma base de dados ao restaurar uma cópia de segurança de uma base de dados eliminada. sourceDatabaseId tem de ser especificado. Se sourceDatabaseId for o ID de recurso original da base de dados, tem de especificar sourceDatabaseDeletionDate. Caso contrário, sourceDatabaseId tem de ser o ID do recurso de base de dados removido recuperável e sourceDatabaseDeletionDate é ignorado. restorePointInTime também pode ser especificado para restaurar a partir de um ponto anterior no tempo. RestoreLongTermRetentionBackup: cria uma base de dados ao restaurar a partir de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId tem de ser especificado como o ID do recurso do ponto de recuperação. Copy, Secondary e RestoreLongTermRetentionBackup não são suportados para a edição DataWarehouse.
properties.creationDate	string	A data de criação da base de dados (formato ISO8601).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	O tipo de conta de armazenamento utilizado para armazenar cópias de segurança para esta base de dados.
properties.currentServiceObjectiveName	string	O nome do objetivo do nível de serviço atual da base de dados.
properties.currentSku	Sku	O nome e a camada do SKU.
properties.databaseId	string	O ID da base de dados.
properties.defaultSecondaryLocation	string	A região secundária predefinida para esta base de dados.
properties.earliestRestoreDate	string	Isto regista a data e hora de início mais antigas que o restauro está disponível para esta base de dados (formato ISO8601).
properties.elasticPoolId	string	O identificador de recursos do conjunto elástico que contém esta base de dados.
properties.failoverGroupId	string	Identificador de recursos do Grupo de Ativação Pós-falha a que esta base de dados pertence.
properties.federatedClientId	string	O ID de cliente utilizado para o cenário de CMK entre inquilinos por base de dados
properties.highAvailabilityReplicaCount	integer	O número de réplicas secundárias associadas à base de dados que são utilizadas para fornecer elevada disponibilidade. Não aplicável a uma base de dados Hyperscale num conjunto elástico.
properties.isInfraEncryptionEnabled	boolean	A encriptação de infra-encriptação está ativada para esta base de dados.
properties.isLedgerOn	boolean	Se esta base de dados é ou não uma base de dados razão, o que significa que todas as tabelas na base de dados são tabelas de livros razão. Nota: o valor desta propriedade não pode ser alterado após a criação da base de dados.
properties.licenseType	DatabaseLicenseType	O tipo de licença a aplicar a esta base de dados. `LicenseIncluded`se precisar de uma licença ou `BasePrice` se tiver uma licença e for elegível para o Benefício Híbrido do Azure.
properties.longTermRetentionBackupResourceId	string	O identificador de recursos da cópia de segurança de retenção de longo prazo associada à operação de criação desta base de dados.
properties.maintenanceConfigurationId	string	ID de configuração de manutenção atribuído à base de dados. Esta configuração define o período em que as atualizações de manutenção irão ocorrer.
properties.maxLogSizeBytes	integer	O tamanho máximo do registo para esta base de dados.
properties.maxSizeBytes	integer	O tamanho máximo da base de dados expressa em bytes.
properties.minCapacity	number	Capacidade mínima que a base de dados sempre terá alocado, se não estiver em pausa
properties.pausedDate	string	A data em que a base de dados foi colocada em pausa pela configuração ou ação do utilizador (formato ISO8601). Nulo se a base de dados estiver pronta.
properties.readScale	DatabaseReadScale	O estado do encaminhamento só de leitura. Se estiver ativada, as ligações que tenham a intenção da aplicação definidas de forma só de leitura no respetivo cadeia de ligação podem ser encaminhadas para uma réplica só de leitura secundária na mesma região. Não aplicável a uma base de dados Hyperscale num conjunto elástico.
properties.recoverableDatabaseId	string	O identificador de recursos da base de dados recuperável associada à operação de criação desta base de dados.
properties.recoveryServicesRecoveryPointId	string	O identificador de recursos do ponto de recuperação associado à operação de criação desta base de dados.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	O tipo de conta de armazenamento a ser utilizado para armazenar cópias de segurança para esta base de dados.
properties.requestedServiceObjectiveName	string	O nome do objetivo de nível de serviço pedido da base de dados.
properties.restorableDroppedDatabaseId	string	O identificador de recursos da base de dados removida restabelecida associada à operação de criação desta base de dados.
properties.restorePointInTime	string	Especifica o ponto anterior no tempo (ISO8601 formato) da base de dados de origem que será restaurada para criar a nova base de dados.
properties.resumedDate	string	A data em que a base de dados foi retomada pela ação do utilizador ou pelo início de sessão da base de dados (ISO8601 formato). Nulo se a base de dados estiver em pausa.
properties.sampleName	SampleName	O nome do esquema de exemplo a aplicar ao criar esta base de dados.
properties.secondaryType	SecondaryType	O tipo secundário da base de dados, se for secundário. Os valores válidos são Geo e Named.
properties.sourceDatabaseDeletionDate	string	Especifica a hora em que a base de dados foi eliminada.
properties.sourceDatabaseId	string	O identificador de recursos da base de dados de origem associada à operação de criação desta base de dados.
properties.sourceResourceId	string	O identificador de recursos da origem associada à operação de criação desta base de dados. Esta propriedade só é suportada para a edição DataWarehouse e permite restaurar entre subscrições. Quando sourceResourceId é especificado, sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId e sourceDatabaseDeletionDate não devem ser especificados e CreateMode tem de ser PointInTimeRestore, Restore ou Recover. Quando createMode é PointInTimeRestore, sourceResourceId tem de ser o ID de recurso da base de dados existente ou do conjunto de sql existente e o restorePointInTime tem de ser especificado. Quando createMode é Restaurar, sourceResourceId tem de ser o ID de recurso da base de dados removida recuperável ou do conjunto de sql removido recuperável. Quando createMode é Recuperar, sourceResourceId tem de ser o ID de recurso da base de dados recuperável ou do conjunto de sql recuperável. Quando a subscrição de origem pertence a um inquilino diferente da subscrição de destino, o cabeçalho "x-ms-authorization-auxiliary" tem de conter o token de autenticação para o inquilino de origem. Para obter mais detalhes sobre o cabeçalho "x-ms-authorization-auxiliary", consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status	DatabaseStatus	O estado da base de dados.
properties.zoneRedundant	boolean	Se esta base de dados é ou não redundante em zonas, o que significa que as réplicas desta base de dados serão distribuídas por várias zonas de disponibilidade.
sku	Sku	O SKU da base de dados. A lista de SKUs pode variar consoante a região e a oferta de suporte. Para determinar os SKUs (incluindo o nome do SKU, escalão/edição, família e capacidade) que estão disponíveis para a sua subscrição numa região do Azure, utilize a `Capabilities_ListByLocation` API REST ou um dos seguintes comandos: `az sql db list-editions -l <location> -o table` `Get-AzSqlServerServiceObjective -Location <location>`
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

DatabaseIdentity

Configuração de identidade do Azure Active Directory para um recurso.

Name	Tipo	Description
tenantId	string	O ID de inquilino do Azure Active Directory.
type	DatabaseIdentityType	O tipo de identidade
userAssignedIdentities	<string, DatabaseUserIdentity>	Os IDs de recursos das identidades atribuídas pelo utilizador a utilizar

DatabaseIdentityType

O tipo de identidade

Name	Tipo	Description
None	string
UserAssigned	string

DatabaseLicenseType

O tipo de licença a aplicar a esta base de dados. LicenseIncludedse precisar de uma licença ou BasePrice se tiver uma licença e for elegível para o Benefício Híbrido do Azure.

Name	Tipo	Description
BasePrice	string
LicenseIncluded	string

DatabaseListResult

Uma lista de bases de dados.

Name	Tipo	Description
nextLink	string	Ligação para obter a página seguinte dos resultados.
value	Database[]	Matriz de resultados.

DatabaseReadScale

O estado do encaminhamento só de leitura. Se estiver ativada, as ligações que tenham a intenção da aplicação definidas de forma só de leitura no respetivo cadeia de ligação podem ser encaminhadas para uma réplica só de leitura secundária na mesma região. Não aplicável a uma base de dados Hyperscale num conjunto elástico.

Name	Tipo	Description
Disabled	string
Enabled	string

DatabaseStatus

O estado da base de dados.

Name	Tipo	Description
AutoClosed	string
Copying	string
Creating	string
Disabled	string
EmergencyMode	string
Inaccessible	string
Offline	string
OfflineChangingDwPerformanceTiers	string
OfflineSecondary	string
Online	string
OnlineChangingDwPerformanceTiers	string
Paused	string
Pausing	string
Recovering	string
RecoveryPending	string
Restoring	string
Resuming	string
Scaling	string
Shutdown	string
Standby	string
Starting	string
Stopped	string
Stopping	string
Suspect	string

DatabaseUserIdentity

Configuração de identidade do Azure Active Directory para um recurso.

Name	Tipo	Description
clientId	string	O ID de cliente do Azure Active Directory.
principalId	string	O ID principal do Azure Active Directory.

SampleName

O nome do esquema de exemplo a aplicar ao criar esta base de dados.

Name	Tipo	Description
AdventureWorksLT	string
WideWorldImportersFull	string
WideWorldImportersStd	string

SecondaryType

O tipo secundário da base de dados, se for secundário. Os valores válidos são Geo e Named.

Name	Tipo	Description
Geo	string
Named	string

Sku

Um SKU de Recurso do ARM.

Name	Tipo	Description
capacity	integer	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 de número, por exemplo, P3.
size	string	Tamanho do SKU específico
tier	string	O escalão ou edição do SKU específico, por exemplo, Básico, Premium.

Databases - List By Elastic Pool

Parâmetros do URI

Respostas

Exemplos

Gets a list of databases in an elastic pool.

Sample Request

Sample Response

Definições

BackupStorageRedundancy

CatalogCollationType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseLicenseType

DatabaseListResult

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

SampleName

SecondaryType

Sku

Recursos adicionais