Databases - List By Elastic Pool

Obtém uma lista de bases de dados numa piscina elástica.

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 In Required Type Description
elasticPoolName
path True
  • string

O nome da piscina elástica.

resourceGroupName
path True
  • string

O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir do Azure Resource Manager API ou do portal.

serverName
path True
  • string

O nome do servidor.

subscriptionId
path True
  • string

O ID de subscrição que identifica uma subscrição do Azure.

api-version
query True
  • string

A versão API a utilizar para o pedido.

Respostas

Name Type Description
200 OK

Conseguiu recuperar com sucesso uma lista de bases de dados numa piscina elástica.

Other Status Codes

Respostas de erro: ***

  • 404 SubscriçãoDoesNotHaveServer - O servidor solicitado não foi encontrado

  • 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos especificado e na subscrição.

  • 404 Não PodeFindObject - Não é possível encontrar o objeto porque não existe ou não tem permissões

  • 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos especificado e na subscrição.

  • 404 ServerNotInSubscription - O servidor especificado não existe na subscrição especificada.

  • 429 SubscriçõesTooManyCreateUpdateRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis.

  • 429 SubscriçõesTooManyRequests - 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 - Pedido de serviço excedeu o tempo limite permitido.

Exemplos

Gets a list of databases in an elastic pool.

Sample Request

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

Sample Response

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

BackupStorageRedundancy

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

CatalogCollationType

Colagem do catálogo de metadados.

CreateMode

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

Padrão: criação regular de base de dados.

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

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

PointInTimeRestore: Cria uma base de dados restaurando uma cópia de segurança pontual de uma base de dados existente. sourceDatabaseId deve ser especificado como o ID de recurso da base de dados existente, e restaurarPointInTime deve ser especificado.

Recuperação: Cria uma base de dados restaurando uma cópia de segurança geo-replicada. sourceDatabaseId deve ser especificado como o ID de recurso de base de dados recuperável para restaurar.

Restaurar: Cria uma base de dados restaurando uma cópia de segurança de uma base de dados eliminada. fonteDatabaseId deve ser especificado. Se o SourceDatabaseId for o ID original do recurso da base de dados, então o database DedtionDate de origem deve ser especificado. Caso contrário, o SourceDatabaseId deve ser o ID de recursos de base de dados restaurador e o sourceDatabaseDeletionDate é ignorado. restaurarPointInTime também pode ser especificado para restaurar a partir de um ponto anterior no tempo.

RestoreLongTermRetentionBackup: Cria uma base de dados restaurando a partir de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId deve ser especificado como o ID 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 Ative Directory para um recurso.

DatabaseIdentityType

O tipo de identidade

DatabaseLicenseType

O tipo de licença para se candidatar 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.

DatabaseListResult

Uma lista de bases de dados.

DatabaseReadScale

O estado do encaminhamento só de leitura. Se ativado, as ligações que tenham a intenção de aplicação definida para serem lidas apenas na sua cadeia de ligação podem ser encaminhada para uma réplica secundária apenas na mesma região. Não é aplicável a uma base de dados de hiperescala dentro de uma piscina elástica.

DatabaseStatus

O estado da base de dados.

DatabaseUserIdentity

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

SampleName

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

SecondaryType

O tipo secundário da base de dados se for secundário. Valores válidos são Geo e Nomeados.

Sku

Um SKU de Recursos ARM.

BackupStorageRedundancy

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

Name Type Description
Geo
  • string
GeoZone
  • string
Local
  • string
Zone
  • string

CatalogCollationType

Colagem do catálogo de metadados.

Name Type Description
DATABASE_DEFAULT
  • string
SQL_Latin1_General_CP1_CI_AS
  • string

CreateMode

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

Padrão: criação regular de base de dados.

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

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

PointInTimeRestore: Cria uma base de dados restaurando uma cópia de segurança pontual de uma base de dados existente. sourceDatabaseId deve ser especificado como o ID de recurso da base de dados existente, e restaurarPointInTime deve ser especificado.

Recuperação: Cria uma base de dados restaurando uma cópia de segurança geo-replicada. sourceDatabaseId deve ser especificado como o ID de recurso de base de dados recuperável para restaurar.

Restaurar: Cria uma base de dados restaurando uma cópia de segurança de uma base de dados eliminada. fonteDatabaseId deve ser especificado. Se o SourceDatabaseId for o ID original do recurso da base de dados, então o database DedtionDate de origem deve ser especificado. Caso contrário, o SourceDatabaseId deve ser o ID de recursos de base de dados restaurador e o sourceDatabaseDeletionDate é ignorado. restaurarPointInTime também pode ser especificado para restaurar a partir de um ponto anterior no tempo.

RestoreLongTermRetentionBackup: Cria uma base de dados restaurando a partir de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId deve ser especificado como o ID do ponto de recuperação.

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

Name Type 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 Type Description
id
  • string

Identificação de recursos.

identity

A identidade do Diretório Ativo Azure da base de dados.

kind
  • string

Tipo de base de dados. Estes são metadados usados para a experiência portal do Azure.

location
  • string

Localização do recurso.

managedBy
  • string

Recurso que gere a base de dados.

name
  • string

Nome de recurso.

properties.autoPauseDelay
  • integer

Tempo em minutos após a qual a base de dados é automaticamente interrompida. Um valor de -1 significa que a pausa automática é desativada

properties.catalogCollation

Colagem do catálogo de metadados.

properties.collation
  • string

A colagem da base de dados.

properties.createMode

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

Padrão: criação regular de base de dados.

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

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

PointInTimeRestore: Cria uma base de dados restaurando uma cópia de segurança pontual de uma base de dados existente. sourceDatabaseId deve ser especificado como o ID de recurso da base de dados existente, e restaurarPointInTime deve ser especificado.

Recuperação: Cria uma base de dados restaurando uma cópia de segurança geo-replicada. sourceDatabaseId deve ser especificado como o ID de recurso de base de dados recuperável para restaurar.

Restaurar: Cria uma base de dados restaurando uma cópia de segurança de uma base de dados eliminada. fonteDatabaseId deve ser especificado. Se o SourceDatabaseId for o ID original do recurso da base de dados, então o database DedtionDate de origem deve ser especificado. Caso contrário, o SourceDatabaseId deve ser o ID de recursos de base de dados restaurador e o sourceDatabaseDeletionDate é ignorado. restaurarPointInTime também pode ser especificado para restaurar a partir de um ponto anterior no tempo.

RestoreLongTermRetentionBackup: Cria uma base de dados restaurando a partir de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId deve ser especificado como o ID 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

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

properties.currentServiceObjectiveName
  • string

O nome objetivo do nível de serviço atual da base de dados.

properties.currentSku

O nome e o nível do SKU.

properties.databaseId
  • string

A identificação da base de dados.

properties.defaultSecondaryLocation
  • string

A região secundária padrão para esta base de dados.

properties.earliestRestoreDate
  • string

Isto regista a data e hora de início mais cedo que a restauração está disponível para esta base de dados (formato ISO8601).

properties.elasticPoolId
  • string

O identificador de recursos da piscina elástica que contém esta base de dados.

properties.failoverGroupId
  • string

Falha no identificador de recursos do Grupo a que esta base de dados pertence.

properties.federatedClientId
  • string

O id do Cliente usado para inquilino cruzado por cenário CMK de base de dados

properties.highAvailabilityReplicaCount
  • integer

O número de réplicas secundárias associadas à base de dados que são usadas para fornecer alta disponibilidade. Não é aplicável a uma base de dados de hiperescala dentro de uma piscina elástica.

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 de livros, o que significa que todas as tabelas na base de dados são tabelas de livros. Nota: o valor deste imóvel não pode ser alterado após a criação da base de dados.

properties.licenseType

O tipo de licença para se candidatar 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.

properties.longTermRetentionBackupResourceId
  • string

O identificador de recursos da cópia de segurança de retenção de longo prazo associado à criação de operação desta base de dados.

properties.maintenanceConfigurationId
  • string

Identificação de configuração de manutenção atribuída à base de dados. Esta configuração define o período em que as atualizações de manutenção ocorrerão.

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 terá sempre atribuído, se não pausado

properties.pausedDate
  • string

A data em que a base de dados foi interrompida pela configuração ou ação do utilizador (formato ISO8601). Nulo se a base de dados estiver pronta.

properties.readScale

O estado do encaminhamento só de leitura. Se ativado, as ligações que tenham a intenção de aplicação definida para serem lidas apenas na sua cadeia de ligação podem ser encaminhada para uma réplica secundária apenas na mesma região. Não é aplicável a uma base de dados de hiperescala dentro de uma piscina elástica.

properties.recoverableDatabaseId
  • string

O identificador de recursos da base de dados recuperável associado à criação de operação desta base de dados.

properties.recoveryServicesRecoveryPointId
  • string

O identificador de recursos do ponto de recuperação associado à criação de operação desta base de dados.

properties.requestedBackupStorageRedundancy

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

properties.requestedServiceObjectiveName
  • string

O nome objetivo do nível de serviço solicitado da base de dados.

properties.restorableDroppedDatabaseId
  • string

O identificador de recursos da base de dados restauradora associada à criação de operação desta base de dados.

properties.restorePointInTime
  • string

Especifica o ponto no tempo (formato ISO8601) 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 por ação do utilizador ou login de base de dados (formato ISO8601). Nulo se a base de dados for interrompida.

properties.sampleName

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

properties.secondaryType

O tipo secundário da base de dados se for secundário. Valores válidos são Geo e Nomeados.

properties.sourceDatabaseDeletionDate
  • string

Especifica o tempo que a base de dados foi eliminada.

properties.sourceDatabaseId
  • string

O identificador de recursos da base de dados de origem associada à criação de operação desta base de dados.

properties.sourceResourceId
  • string

O identificador de recursos da fonte associada à criação de operação desta base de dados.

Esta propriedade é suportada apenas para a edição DataWarehouse e permite restaurar através de subscrições.

Quando a fonteResourceId é especificada, sourceDatabaseId, ResreguredbaseId, RestorableDroppedDatabaseId e sourceDataBaseDtionDate não deve ser especificado e CreateMode deve ser PointInTimeRestore, Restore ou Recuperar.

Quando o CreateMode é PointInTimeRestore, o sourceResourceId deve ser o ID de recursos da base de dados existente ou da piscina de sql existente, e deve ser especificado o restorePointInTime.

Quando o CreateMode é Restaurado, o sourceResourceId deve ser o ID de recursos da base de dados restauradora ou da piscina de sql restauradora.

Quando o CreateMode é Recuperar, o sourceResourceId deve ser o ID de recursos de base de dados recuperável ou piscina de sql recuperável.

Quando a subscrição de origem pertence a um inquilino diferente da subscrição-alvo, o cabeçalho "x-ms-autorização-auxiliar" deve conter ficha de autenticação para o arrendatário de origem. Para mais detalhes sobre o cabeçalho "x-ms-autorização-auxiliar" ver https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

properties.status

O estado da base de dados.

properties.zoneRedundant
  • boolean

Se esta base de dados é ou não uma zona redundante, o que significa que as réplicas desta base de dados serão espalhadas por várias zonas de disponibilidade.

sku

A base de dados SKU.

A lista de SKUs pode variar por região e oferta de apoio. Para determinar os SKUs (incluindo o nome SKU, nível/edição, família e capacidade) que estão disponíveis para a sua subscrição numa região de 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 Ative Directory para um recurso.

Name Type Description
tenantId
  • string

O ID do Inquilino Azure Ative Directory.

type

O tipo de identidade

userAssignedIdentities

Os ids de recursos do utilizador atribuiu identidades para usar

DatabaseIdentityType

O tipo de identidade

Name Type Description
None
  • string
UserAssigned
  • string

DatabaseLicenseType

O tipo de licença para se candidatar 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 Type Description
BasePrice
  • string
LicenseIncluded
  • string

DatabaseListResult

Uma lista de bases de dados.

Name Type Description
nextLink
  • string

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

value

Conjunto de resultados.

DatabaseReadScale

O estado do encaminhamento só de leitura. Se ativado, as ligações que tenham a intenção de aplicação definida para serem lidas apenas na sua cadeia de ligação podem ser encaminhada para uma réplica secundária apenas na mesma região. Não é aplicável a uma base de dados de hiperescala dentro de uma piscina elástica.

Name Type Description
Disabled
  • string
Enabled
  • string

DatabaseStatus

O estado da base de dados.

Name Type 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 Ative Directory para um recurso.

Name Type Description
clientId
  • string

O ID do cliente do Azure Ative Directory.

principalId
  • string

O ID principal do Azure Ative Directory.

SampleName

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

Name Type Description
AdventureWorksLT
  • string
WideWorldImportersFull
  • string
WideWorldImportersStd
  • string

SecondaryType

O tipo secundário da base de dados se for secundário. Valores válidos são Geo e Nomeados.

Name Type Description
Geo
  • string
Named
  • string

Sku

Um SKU de Recursos ARM.

Name Type Description
capacity
  • integer

Capacidade do SKU em particular.

family
  • string

Se o serviço tem diferentes gerações de hardware, para o mesmo SKU, então isso pode ser capturado aqui.

name
  • string

O nome do SKU, tipicamente, uma letra + código número, por exemplo P3.

size
  • string

Tamanho do SKU em particular

tier
  • string

O nível ou edição do SKU em particular, por exemplo, Básico, Premium.