Databases - List By Elastic Pool

Servizio:

SQL Database

Versione API:

2021-11-01

Ottiene un elenco di database in un pool elastico.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
elasticPoolName	path	True	string	Nome del pool elastico.
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
serverName	path	True	string	Nome del server.
subscriptionId	path	True	string	ID sottoscrizione che identifica una sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare per la richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	DatabaseListResult	È stato recuperato correttamente un elenco di database in un pool elastico.
Other Status Codes		Risposte agli errori: ** 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati. 404 CannotFindObject - Impossibile trovare l'oggetto perché non esiste o non si dispone delle autorizzazioni 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati. 404 ServerNotInSubscription: il server specificato non esiste nella sottoscrizione specificata. 429 SubscriptionTooManyCreateUpdateRequests - Richieste oltre le richieste massime che possono essere elaborate dalle risorse disponibili. 429 SubscriptionTooManyRequests - Richieste oltre le richieste massime che possono essere elaborate dalle risorse disponibili. 503 TooManyRequests : richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 504 RequestTimeout : la richiesta di servizio ha superato il timeout consentito.

Esempio

Gets a list of databases in an elastic pool.

Esempio di richiesta

HTTP

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

Java

/**
 * 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", com.azure.core.util.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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
BackupStorageRedundancy	Tipo di account di archiviazione usato per archiviare i backup per questo database.
CatalogCollationType	Regole di confronto del catalogo dei metadati.
CreateMode	Specifica la modalità di creazione del database. Impostazione predefinita: creazione regolare del database. Copia: crea un database come copia di un database esistente. sourceDatabaseId deve essere specificato come ID risorsa del database di origine. Secondario: crea un database come replica secondaria di un database esistente. sourceDatabaseId deve essere specificato come ID risorsa del database primario esistente. PointInTimeRestore: crea un database ripristinando un backup temporizzato di un database esistente. sourceDatabaseId deve essere specificato come ID risorsa del database esistente e deve essere specificato restorePointInTime. Ripristino: crea un database ripristinando un backup con replica geografica. sourceDatabaseId deve essere specificato come ID risorsa di database recuperabile da ripristinare. Ripristino: crea un database ripristinando un backup di un database eliminato. sourceDatabaseId deve essere specificato. Se sourceDatabaseId è l'ID risorsa originale del database, è necessario specificare sourceDatabaseDeletionDate. In caso contrario, sourceDatabaseId deve essere l'ID risorsa del database eliminata ripristinabile e sourceDatabaseDeletionDate viene ignorato. restorePointInTime può essere specificato anche per ripristinare da un momento precedente. RestoreLongTermRetentionBackup: crea un database ripristinando da un insieme di credenziali di conservazione a lungo termine. recoveryServicesRecoveryPointResourceId deve essere specificato come ID risorsa del punto di ripristino. Copy, Secondary e RestoreLongTermRetentionBackup non sono supportati per l'edizione DataWarehouse.
Database	Una risorsa di database.
DatabaseIdentity	Configurazione dell'identità di Azure Active Directory per una risorsa.
DatabaseIdentityType	Tipo di identità
DatabaseLicenseType	Tipo di licenza da applicare per questo database. LicenseIncludedse è necessaria una licenza o BasePrice se si dispone di una licenza e si è idonei per il Vantaggio Azure Hybrid.
DatabaseListResult	Elenco di database.
DatabaseReadScale	Stato del routing di sola lettura. Se abilitata, le connessioni con finalità dell'applicazione impostate su readonly nella propria stringa di connessione possono essere indirizzate a una replica secondaria di lettura nella stessa area. Non applicabile a un database Hyperscale all'interno di un pool elastico.
DatabaseStatus	Stato del database.
DatabaseUserIdentity	Configurazione delle identità di Azure Active Directory per una risorsa.
SampleName	Nome dello schema di esempio da applicare durante la creazione di questo database.
SecondaryType	Tipo secondario del database se è secondario. I valori validi sono Geo e Named.
Sku	SKU della risorsa ARM.

BackupStorageRedundancy

Tipo di account di archiviazione usato per archiviare i backup per questo database.

Nome	Tipo	Descrizione
Geo	string
GeoZone	string
Local	string
Zone	string

CatalogCollationType

Regole di confronto del catalogo dei metadati.

Nome	Tipo	Descrizione
DATABASE_DEFAULT	string
SQL_Latin1_General_CP1_CI_AS	string

CreateMode

Specifica la modalità di creazione del database.

Impostazione predefinita: creazione regolare del database.

Copia: crea un database come copia di un database esistente. sourceDatabaseId deve essere specificato come ID risorsa del database di origine.

Secondario: crea un database come replica secondaria di un database esistente. sourceDatabaseId deve essere specificato come ID risorsa del database primario esistente.

PointInTimeRestore: crea un database ripristinando un backup temporizzato di un database esistente. sourceDatabaseId deve essere specificato come ID risorsa del database esistente e deve essere specificato restorePointInTime.

Ripristino: crea un database ripristinando un backup con replica geografica. sourceDatabaseId deve essere specificato come ID risorsa di database recuperabile da ripristinare.

Ripristino: crea un database ripristinando un backup di un database eliminato. sourceDatabaseId deve essere specificato. Se sourceDatabaseId è l'ID risorsa originale del database, è necessario specificare sourceDatabaseDeletionDate. In caso contrario, sourceDatabaseId deve essere l'ID risorsa del database eliminata ripristinabile e sourceDatabaseDeletionDate viene ignorato. restorePointInTime può essere specificato anche per ripristinare da un momento precedente.

RestoreLongTermRetentionBackup: crea un database ripristinando da un insieme di credenziali di conservazione a lungo termine. recoveryServicesRecoveryPointResourceId deve essere specificato come ID risorsa del punto di ripristino.

Copy, Secondary e RestoreLongTermRetentionBackup non sono supportati per l'edizione DataWarehouse.

Nome	Tipo	Descrizione
Copy	string
Default	string
OnlineSecondary	string
PointInTimeRestore	string
Recovery	string
Restore	string
RestoreExternalBackup	string
RestoreExternalBackupSecondary	string
RestoreLongTermRetentionBackup	string
Secondary	string

Database

Una risorsa di database.

Nome	Tipo	Descrizione
id	string	ID risorsa.
identity	DatabaseIdentity	Identità di Azure Active Directory del database.
kind	string	Tipo di database. Si tratta di metadati usati per l'esperienza di portale di Azure.
location	string	Percorso della risorsa.
managedBy	string	Risorsa che gestisce il database.
name	string	Nome risorsa.
properties.autoPauseDelay	integer	Tempo in minuti dopo il quale il database viene sospeso automaticamente. Il valore -1 indica che la sospensione automatica è disabilitata
properties.catalogCollation	CatalogCollationType	Regole di confronto del catalogo dei metadati.
properties.collation	string	Regole di confronto del database.
properties.createMode	CreateMode	Specifica la modalità di creazione del database. Impostazione predefinita: creazione regolare del database. Copia: crea un database come copia di un database esistente. sourceDatabaseId deve essere specificato come ID risorsa del database di origine. Secondario: crea un database come replica secondaria di un database esistente. sourceDatabaseId deve essere specificato come ID risorsa del database primario esistente. PointInTimeRestore: crea un database ripristinando un backup temporizzato di un database esistente. sourceDatabaseId deve essere specificato come ID risorsa del database esistente e deve essere specificato restorePointInTime. Ripristino: crea un database ripristinando un backup con replica geografica. sourceDatabaseId deve essere specificato come ID risorsa di database ripristinabile da ripristinare. Ripristino: crea un database ripristinando un backup di un database eliminato. sourceDatabaseId deve essere specificato. Se sourceDatabaseId è l'ID risorsa originale del database, è necessario specificare sourceDatabaseDeletionDate. In caso contrario, sourceDatabaseId deve essere l'ID risorsa del database eliminato ripristinabile e sourceDatabaseDeletionDate viene ignorato. è anche possibile specificare restorePointInTime per eseguire il ripristino da un momento precedente. RestoreLongTermRetentionBackup: crea un database ripristinando da un insieme di credenziali di conservazione a lungo termine. recoveryServicesRecoveryPointResourceId deve essere specificato come ID risorsa del punto di ripristino. L'edizione Copy, Secondary e RestoreLongTermRetentionBackup non è supportata per l'edizione DataWarehouse.
properties.creationDate	string	Data di creazione del database (formato ISO8601).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Tipo di account di archiviazione usato per archiviare i backup per questo database.
properties.currentServiceObjectiveName	string	Nome dell'obiettivo del livello di servizio corrente del database.
properties.currentSku	Sku	Nome e livello dello SKU.
properties.databaseId	string	ID del database.
properties.defaultSecondaryLocation	string	Area secondaria predefinita per questo database.
properties.earliestRestoreDate	string	Registra la data e l'ora di inizio meno recente disponibili per il database (ISO8601 formato).
properties.elasticPoolId	string	Identificatore di risorsa del pool elastico contenente il database.
properties.failoverGroupId	string	Identificatore di risorsa del gruppo di failover a cui appartiene il database.
properties.federatedClientId	string	ID client usato per lo scenario di cmk tra tenant per database
properties.highAvailabilityReplicaCount	integer	Numero di repliche secondarie associate al database utilizzato per garantire la disponibilità elevata. Non applicabile a un database Hyperscale all'interno di un pool elastico.
properties.isInfraEncryptionEnabled	boolean	La crittografia dell'infrastruttura è abilitata per questo database.
properties.isLedgerOn	boolean	Indica se il database è un database libro mastro, ovvero tutte le tabelle del database sono tabelle mastro. Nota: il valore di questa proprietà non può essere modificato dopo la creazione del database.
properties.licenseType	DatabaseLicenseType	Tipo di licenza da applicare per questo database. LicenseIncludedse è necessaria una licenza o BasePrice se si dispone di una licenza e si è idonei per il Vantaggio Azure Hybrid.
properties.longTermRetentionBackupResourceId	string	Identificatore della risorsa del backup di conservazione a lungo termine associato all'operazione di creazione del database.
properties.maintenanceConfigurationId	string	ID di configurazione della manutenzione assegnato al database. Questa configurazione definisce il periodo in cui si verificheranno gli aggiornamenti di manutenzione.
properties.maxLogSizeBytes	integer	Dimensioni massime del log per questo database.
properties.maxSizeBytes	integer	Dimensione massima del database espressa in byte.
properties.minCapacity	number	Capacità minima allocata dal database, se non sospesa
properties.pausedDate	string	Data in cui il database è stato sospeso dalla configurazione o dall'azione dell'utente(formato ISO8601). Null se il database è pronto.
properties.readScale	DatabaseReadScale	Stato del routing di sola lettura. Se abilitata, le connessioni con finalità dell'applicazione impostate su readonly nel stringa di connessione possono essere instradate a una replica secondaria di sola lettura nella stessa area. Non applicabile a un database Hyperscale all'interno di un pool elastico.
properties.recoverableDatabaseId	string	Identificatore della risorsa del database ripristinabile associato all'operazione di creazione del database.
properties.recoveryServicesRecoveryPointId	string	Identificatore della risorsa del punto di ripristino associato all'operazione di creazione del database.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Tipo di account di archiviazione da usare per archiviare i backup per questo database.
properties.requestedServiceObjectiveName	string	Nome dell'obiettivo del livello di servizio richiesto del database.
properties.restorableDroppedDatabaseId	string	Identificatore della risorsa del database eliminato ripristinabile associato all'operazione di creazione del database.
properties.restorePointInTime	string	Specifica il punto nel tempo (ISO8601 formato) del database di origine che verrà ripristinato per creare il nuovo database.
properties.resumedDate	string	Data in cui il database è stato ripreso dall'azione dell'utente o dall'account di accesso al database (formato ISO8601). Null se il database è sospeso.
properties.sampleName	SampleName	Nome dello schema di esempio da applicare durante la creazione di questo database.
properties.secondaryType	SecondaryType	Tipo secondario del database se è secondario. I valori validi sono Geo e Named.
properties.sourceDatabaseDeletionDate	string	Specifica l'ora di eliminazione del database.
properties.sourceDatabaseId	string	Identificatore della risorsa del database di origine associato all'operazione di creazione del database.
properties.sourceResourceId	string	Identificatore della risorsa dell'origine associata all'operazione di creazione del database. Questa proprietà è supportata solo per l'edizione DataWarehouse e consente il ripristino tra sottoscrizioni. Quando si specifica sourceResourceId, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId e sourceDatabaseDeletionDate non devono essere specificati e CreateMode deve essere PointInTimeRestore, Restore o Recover. Quando createMode è PointInTimeRestore, sourceResourceId deve essere l'ID risorsa del database esistente o del pool SQL esistente e deve essere specificato restorePointInTime. Quando createMode è Restore, sourceResourceId deve essere l'ID risorsa del database eliminato ripristinabile o il pool SQL eliminato ripristinabile. Quando createMode è Recover, sourceResourceId deve essere l'ID risorsa del database recuperabile o il pool SQL ripristinabile. Quando la sottoscrizione di origine appartiene a un tenant diverso dalla sottoscrizione di destinazione, l'intestazione "x-ms-authorization-auxiliary" deve contenere token di autenticazione per il tenant di origine. Per altre informazioni sull'intestazione "x-ms-authorization-ausiliaria", vedere https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status	DatabaseStatus	Stato del database.
properties.zoneRedundant	boolean	Indipendentemente dal fatto che il database sia con ridondanza della zona, ovvero le repliche di questo database verranno distribuite in più zone di disponibilità.
sku	Sku	SKU del database. L'elenco degli SKU può variare in base all'area geografica e all'offerta di supporto. Per determinare gli SKU (inclusi il nome dello SKU, il livello/edizione, la famiglia e la capacità) disponibili per la sottoscrizione in un'area di Azure, usare l'API Capabilities_ListByLocation REST o uno dei comandi seguenti: az sql db list-editions -l <location> -o table Get-AzSqlServerServiceObjective -Location <location>
tags	object	Tag delle risorse.
type	string	Tipo di risorsa.

DatabaseIdentity

Configurazione dell'identità di Azure Active Directory per una risorsa.

Nome	Tipo	Descrizione
tenantId	string	ID tenant di Azure Active Directory.
type	DatabaseIdentityType	Tipo di identità
userAssignedIdentities	<string,  DatabaseUserIdentity>	ID risorsa delle identità assegnate dall'utente da usare

DatabaseIdentityType

Tipo di identità

Nome	Tipo	Descrizione
None	string
UserAssigned	string

DatabaseLicenseType

Tipo di licenza da applicare per questo database. LicenseIncludedse è necessaria una licenza o BasePrice se si dispone di una licenza e si è idonei per il Vantaggio Azure Hybrid.

Nome	Tipo	Descrizione
BasePrice	string
LicenseIncluded	string

DatabaseListResult

Elenco di database.

Nome	Tipo	Descrizione
nextLink	string	Collegamento per recuperare la pagina successiva dei risultati.
value	Database[]	Matrice di risultati.

DatabaseReadScale

Stato del routing di sola lettura. Se abilitata, le connessioni con finalità dell'applicazione impostate su readonly nella propria stringa di connessione possono essere indirizzate a una replica secondaria di lettura nella stessa area. Non applicabile a un database Hyperscale all'interno di un pool elastico.

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

DatabaseStatus

Stato del database.

Nome	Tipo	Descrizione
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

Configurazione delle identità di Azure Active Directory per una risorsa.

Nome	Tipo	Descrizione
clientId	string	ID client di Azure Active Directory.
principalId	string	ID entità di Azure Active Directory.

SampleName

Nome dello schema di esempio da applicare durante la creazione di questo database.

Nome	Tipo	Descrizione
AdventureWorksLT	string
WideWorldImportersFull	string
WideWorldImportersStd	string

SecondaryType

Tipo secondario del database se è secondario. I valori validi sono Geo e Named.

Nome	Tipo	Descrizione
Geo	string
Named	string

Sku

SKU della risorsa ARM.

Nome	Tipo	Descrizione
capacity	integer	Capacità dello SKU specifico.
family	string	Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, può essere acquisito qui.
name	string	Nome dello SKU, in genere una lettera + codice numerico, ad esempio P3.
size	string	Dimensioni dello SKU specifico
tier	string	Livello o edizione dello SKU specifico, ad esempio Basic, Premium.