Databases - List By Elastic Pool

Referens

Service:: SQL Database

API Version:: 2021-11-01

Hämtar en lista över databaser i en elastisk pool.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
elasticPoolName	path	True	string	Namnet på den elastiska poolen.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Prenumerations-ID:t som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Svar

Name	Typ	Description
200 OK	DatabaseListResult	En lista över databaser i en elastisk pool har hämtats.
Other Status Codes		Felsvar: *** 404 SubscriptionDoesNotHaveServer – den begärda servern hittades inte 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen. 404 CannotFindObject – Det går inte att hitta objektet eftersom det inte finns eller så har du inte behörighet 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen. 404 ServerNotInSubscription – Den angivna servern finns inte i den angivna prenumerationen. 429 SubscriptionTooManyCreateUpdateRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 429 SubscriptionTooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 504 RequestTimeout – Tjänstbegäran överskred den tillåtna tidsgränsen.

Name

Typ

Description

200 OK

DatabaseListResult

En lista över databaser i en elastisk pool har hämtats.

Other Status Codes

Felsvar: ***

404 SubscriptionDoesNotHaveServer – den begärda servern hittades inte
404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.
404 CannotFindObject – Det går inte att hitta objektet eftersom det inte finns eller så har du inte behörighet
404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.
404 ServerNotInSubscription – Den angivna servern finns inte i den angivna prenumerationen.
429 SubscriptionTooManyCreateUpdateRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.
429 SubscriptionTooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.
503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.
504 RequestTimeout – Tjänstbegäran överskred den tillåtna tidsgränsen.

Exempel

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

Definitioner

Name	Description
BackupStorageRedundancy	Lagringskontotypen som används för att lagra säkerhetskopior för den här databasen.
CatalogCollationType	Sortering av metadatakatalogen.
CreateMode	Anger läget för att skapa databasen. Standard: vanlig databasskapande. Kopiera: skapar en databas som en kopia av en befintlig databas. sourceDatabaseId måste anges som resurs-ID för källdatabasen. Sekundär: skapar en databas som en sekundär replik av en befintlig databas. sourceDatabaseId måste anges som resurs-ID för den befintliga primära databasen. PointInTimeRestore: Skapar en databas genom att återställa en tidpunktssäkerhetskopia av en befintlig databas. sourceDatabaseId måste anges som resurs-ID för den befintliga databasen och restorePointInTime måste anges. Återställning: Skapar en databas genom att återställa en geo-replikerad säkerhetskopia. sourceDatabaseId måste anges som det återställningsbara databasresurs-ID:t som ska återställas. Återställ: Skapar en databas genom att återställa en säkerhetskopia av en borttagen databas. sourceDatabaseId måste anges. Om sourceDatabaseId är databasens ursprungliga resurs-ID måste källanDatabaseDeletionDate anges. Annars måste sourceDatabaseId vara det återställningsbara borttagna databasresurs-ID:t och sourceDatabaseDeletionDate ignoreras. restorePointInTime kan också anges för återställning från en tidigare tidpunkt. RestoreLongTermRetentionBackup: Skapar en databas genom att återställa från ett långsiktigt kvarhållningsvalv. recoveryServicesRecoveryPointResourceId måste anges som resurs-ID för återställningspunkten. Copy, Secondary och RestoreLongTermRetentionBackup stöds inte för DataWarehouse Edition.
Database	En databasresurs.
DatabaseIdentity	Azure Active Directory-identitetskonfiguration för en resurs.
DatabaseIdentityType	Identitetstypen
DatabaseLicenseType	Den licenstyp som ska tillämpas för den här databasen. `LicenseIncluded`om du behöver en licens eller `BasePrice` om du har en licens och är berättigad till Azure Hybrid-förmån.
DatabaseListResult	En lista över databaser.
DatabaseReadScale	Tillståndet för skrivskyddad routning. Om aktiverad kan anslutningar som har program avsikt inställd på readonly i sina anslutningssträng dirigeras till en skrivskyddad sekundär replik i samma region. Gäller inte för en Hyperskala-databas i en elastisk pool.
DatabaseStatus	Databasens status.
DatabaseUserIdentity	Azure Active Directory-identitetskonfiguration för en resurs.
SampleName	Namnet på exempelschemat som ska tillämpas när du skapar den här databasen.
SecondaryType	Den sekundära typen av databas om den är sekundär. Giltiga värden är Geo och Named.
Sku	En ARM-resurs-SKU.

BackupStorageRedundancy

Lagringskontotypen som används för att lagra säkerhetskopior för den här databasen.

Name	Typ	Description
Geo	string
GeoZone	string
Local	string
Zone	string

CatalogCollationType

Sortering av metadatakatalogen.

Name	Typ	Description
DATABASE_DEFAULT	string
SQL_Latin1_General_CP1_CI_AS	string

CreateMode

Anger läget för att skapa databasen.

Standard: vanlig databasskapande.

Kopiera: skapar en databas som en kopia av en befintlig databas. sourceDatabaseId måste anges som resurs-ID för källdatabasen.

Sekundär: skapar en databas som en sekundär replik av en befintlig databas. sourceDatabaseId måste anges som resurs-ID för den befintliga primära databasen.

PointInTimeRestore: Skapar en databas genom att återställa en tidpunktssäkerhetskopia av en befintlig databas. sourceDatabaseId måste anges som resurs-ID för den befintliga databasen och restorePointInTime måste anges.

Återställning: Skapar en databas genom att återställa en geo-replikerad säkerhetskopia. sourceDatabaseId måste anges som det återställningsbara databasresurs-ID:t som ska återställas.

Återställ: Skapar en databas genom att återställa en säkerhetskopia av en borttagen databas. sourceDatabaseId måste anges. Om sourceDatabaseId är databasens ursprungliga resurs-ID måste källanDatabaseDeletionDate anges. Annars måste sourceDatabaseId vara det återställningsbara borttagna databasresurs-ID:t och sourceDatabaseDeletionDate ignoreras. restorePointInTime kan också anges för återställning från en tidigare tidpunkt.

RestoreLongTermRetentionBackup: Skapar en databas genom att återställa från ett långsiktigt kvarhållningsvalv. recoveryServicesRecoveryPointResourceId måste anges som resurs-ID för återställningspunkten.

Copy, Secondary och RestoreLongTermRetentionBackup stöds inte för DataWarehouse Edition.

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

Database

En databasresurs.

Name	Typ	Description
id	string	Resurs-ID.
identity	DatabaseIdentity	Azure Active Directory-identiteten för databasen.
kind	string	Typ av databas. Det här är metadata som används för Azure Portal upplevelse.
location	string	Resursplats.
managedBy	string	Resurs som hanterar databasen.
name	string	Resursnamn.
properties.autoPauseDelay	integer	Tid i minuter efter vilken databasen pausas automatiskt. Värdet -1 innebär att automatisk paus är inaktiverat
properties.catalogCollation	CatalogCollationType	Sortering av metadatakatalogen.
properties.collation	string	Sortering av databasen.
properties.createMode	CreateMode	Anger läget för att skapa databasen. Standard: vanlig databasskapande. Kopiera: skapar en databas som en kopia av en befintlig databas. sourceDatabaseId måste anges som resurs-ID för källdatabasen. Sekundär: skapar en databas som en sekundär replik av en befintlig databas. sourceDatabaseId måste anges som resurs-ID för den befintliga primära databasen. PointInTimeRestore: Skapar en databas genom att återställa en tidpunktssäkerhetskopia av en befintlig databas. sourceDatabaseId måste anges som resurs-ID för den befintliga databasen och restorePointInTime måste anges. Återställning: Skapar en databas genom att återställa en geo-replikerad säkerhetskopia. sourceDatabaseId måste anges som det återställningsbara databasresurs-ID:t som ska återställas. Återställ: Skapar en databas genom att återställa en säkerhetskopia av en borttagen databas. sourceDatabaseId måste anges. Om sourceDatabaseId är databasens ursprungliga resurs-ID måste källanDatabaseDeletionDate anges. Annars måste sourceDatabaseId vara det återställningsbara borttagna databasresurs-ID:t och sourceDatabaseDeletionDate ignoreras. restorePointInTime kan också anges för återställning från en tidigare tidpunkt. RestoreLongTermRetentionBackup: Skapar en databas genom att återställa från ett långsiktigt kvarhållningsvalv. recoveryServicesRecoveryPointResourceId måste anges som resurs-ID för återställningspunkten. Copy, Secondary och RestoreLongTermRetentionBackup stöds inte för DataWarehouse Edition.
properties.creationDate	string	Databasens skapandedatum (ISO8601 format).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Lagringskontotypen som används för att lagra säkerhetskopior för den här databasen.
properties.currentServiceObjectiveName	string	Databasens aktuella målnamn på tjänstnivå.
properties.currentSku	Sku	SKU:ns namn och nivå.
properties.databaseId	string	Databasens ID.
properties.defaultSecondaryLocation	string	Den sekundära standardregionen för den här databasen.
properties.earliestRestoreDate	string	Detta registrerar det tidigaste startdatum och den tid som återställningen är tillgänglig för den här databasen (ISO8601 format).
properties.elasticPoolId	string	Resursidentifieraren för den elastiska pool som innehåller den här databasen.
properties.failoverGroupId	string	Resursidentifierare för redundansgrupp som den här databasen tillhör.
properties.federatedClientId	string	Klient-ID:t som används för cmk-scenario mellan klientorganisationer per databas
properties.highAvailabilityReplicaCount	integer	Antalet sekundära repliker som är associerade med databasen som används för att ge hög tillgänglighet. Gäller inte för en Hyperskala-databas i en elastisk pool.
properties.isInfraEncryptionEnabled	boolean	Infrakryptering är aktiverat för den här databasen.
properties.isLedgerOn	boolean	Om den här databasen är en transaktionsregisterdatabas, vilket innebär att alla tabeller i databasen är transaktionsregistertabeller. Obs! Det går inte att ändra värdet för den här egenskapen när databasen har skapats.
properties.licenseType	DatabaseLicenseType	Den licenstyp som ska tillämpas för den här databasen. `LicenseIncluded`om du behöver en licens eller `BasePrice` om du har en licens och är berättigad till Azure Hybrid-förmån.
properties.longTermRetentionBackupResourceId	string	Resursidentifieraren för den långsiktiga kvarhållningssäkerhetskopian som är associerad med att skapa den här databasen.
properties.maintenanceConfigurationId	string	Underhållskonfigurations-ID som tilldelats databasen. Den här konfigurationen definierar den period då underhållsuppdateringarna ska ske.
properties.maxLogSizeBytes	integer	Den maximala loggstorleken för den här databasen.
properties.maxSizeBytes	integer	Den maximala storleken på databasen uttryckt i byte.
properties.minCapacity	number	Minimal kapacitet som databasen alltid har allokerat, om den inte har pausats
properties.pausedDate	string	Det datum då databasen pausades av användarkonfiguration eller åtgärd (ISO8601 format). Null om databasen är klar.
properties.readScale	DatabaseReadScale	Tillståndet för skrivskyddad routning. Om aktiverad kan anslutningar som har program avsikt inställd på readonly i sina anslutningssträng dirigeras till en skrivskyddad sekundär replik i samma region. Gäller inte för en Hyperskala-databas i en elastisk pool.
properties.recoverableDatabaseId	string	Resursidentifieraren för den återställningsbara databas som är associerad med skapandeåtgärden för den här databasen.
properties.recoveryServicesRecoveryPointId	string	Resursidentifieraren för återställningspunkten som är associerad med den här databasens skapandeåtgärd.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Lagringskontotypen som ska användas för att lagra säkerhetskopior för den här databasen.
properties.requestedServiceObjectiveName	string	Det begärda servicenivåmålnamnet för databasen.
properties.restorableDroppedDatabaseId	string	Resursidentifieraren för den återställningsbara borttagna databasen som är associerad med skapandeåtgärden för den här databasen.
properties.restorePointInTime	string	Anger tidpunkten (ISO8601 format) för källdatabasen som ska återställas för att skapa den nya databasen.
properties.resumedDate	string	Det datum då databasen återupptogs av användaråtgärd eller databasinloggning (ISO8601 format). Null om databasen har pausats.
properties.sampleName	SampleName	Namnet på exempelschemat som ska tillämpas när du skapar den här databasen.
properties.secondaryType	SecondaryType	Den sekundära typen av databas om den är sekundär. Giltiga värden är Geo och Named.
properties.sourceDatabaseDeletionDate	string	Anger den tid då databasen togs bort.
properties.sourceDatabaseId	string	Resursidentifieraren för källdatabasen som är associerad med skapandeåtgärden för den här databasen.
properties.sourceResourceId	string	Resursidentifieraren för källan som är associerad med den här databasens skapandeåtgärd. Den här egenskapen stöds endast för DataWarehouse Edition och gör det möjligt att återställa mellan prenumerationer. När sourceResourceId har angetts får sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId och sourceDatabaseDeletionDate inte anges och CreateMode måste vara PointInTimeRestore, Restore eller Recover. När createMode är PointInTimeRestore måste sourceResourceId vara resurs-ID för den befintliga databasen eller den befintliga sql-poolen och restorePointInTime måste anges. När createMode är Restore måste sourceResourceId vara resurs-ID för återställningsbar borttagen databas eller återställningsbar borttagen SQL-pool. När createMode är Återställ måste sourceResourceId vara resurs-ID för återställningsbar databas eller återställningsbar SQL-pool. När källprenumerationen tillhör en annan klientorganisation än målprenumerationen måste rubriken "x-ms-authorization-auxiliary" innehålla autentiseringstoken för källklientorganisationen. Mer information om rubriken "x-ms-authorization-auxiliary" finns i https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status	DatabaseStatus	Databasens status.
properties.zoneRedundant	boolean	Om den här databasen är zonredundant eller inte, vilket innebär att replikerna i den här databasen sprids över flera tillgänglighetszoner.
sku	Sku	Databas-SKU:n. Listan över SKU:er kan variera beroende på region och supporterbjudande. Om du vill fastställa vilka SKU:er (inklusive SKU-namn, nivå/utgåva, familj och kapacitet) som är tillgängliga för din prenumeration i en Azure-region använder du REST-API:et `Capabilities_ListByLocation` eller något av följande kommandon: `az sql db list-editions -l <location> -o table` `Get-AzSqlServerServiceObjective -Location <location>`
tags	object	Resurstaggar.
type	string	Resurstyp.

DatabaseIdentity

Azure Active Directory-identitetskonfiguration för en resurs.

Name	Typ	Description
tenantId	string	Klient-ID:t för Azure Active Directory.
type	DatabaseIdentityType	Identitetstypen
userAssignedIdentities	<string, DatabaseUserIdentity>	Resurs-ID:n för de användartilldelade identiteter som ska användas

DatabaseIdentityType

Identitetstypen

Name	Typ	Description
None	string
UserAssigned	string

DatabaseLicenseType

Den licenstyp som ska tillämpas för den här databasen. LicenseIncludedom du behöver en licens eller BasePrice om du har en licens och är berättigad till Azure Hybrid-förmån.

Name	Typ	Description
BasePrice	string
LicenseIncluded	string

DatabaseListResult

En lista över databaser.

Name	Typ	Description
nextLink	string	Länka för att hämta nästa sida med resultat.
value	Database[]	Matris med resultat.

DatabaseReadScale

Tillståndet för skrivskyddad routning. Om aktiverad kan anslutningar som har program avsikt inställd på readonly i sina anslutningssträng dirigeras till en skrivskyddad sekundär replik i samma region. Gäller inte för en Hyperskala-databas i en elastisk pool.

Name	Typ	Description
Disabled	string
Enabled	string

DatabaseStatus

Databasens status.

Name	Typ	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

Azure Active Directory-identitetskonfiguration för en resurs.

Name	Typ	Description
clientId	string	Azure Active Directory-klient-ID: t.
principalId	string	Huvud-ID:t för Azure Active Directory.

SampleName

Namnet på exempelschemat som ska tillämpas när du skapar den här databasen.

Name	Typ	Description
AdventureWorksLT	string
WideWorldImportersFull	string
WideWorldImportersStd	string

SecondaryType

Den sekundära typen av databas om den är sekundär. Giltiga värden är Geo och Named.

Name	Typ	Description
Geo	string
Named	string

Sku

En ARM-resurs-SKU.

Name	Typ	Description
capacity	integer	Kapacitet för den specifika SKU:n.
family	string	Om tjänsten har olika generationer av maskinvara, för samma SKU, kan den samlas in här.
name	string	Namnet på SKU:n, vanligtvis en bokstav + nummerkod, t.ex. P3.
size	string	Storleken på den specifika SKU:n
tier	string	Nivån eller utgåvan av den specifika SKU:n, t.ex. Basic, Premium.

Databases - List By Elastic Pool

URI-parametrar

Svar

Exempel

Gets a list of databases in an elastic pool.

Sample Request

Sample Response

Definitioner

BackupStorageRedundancy

CatalogCollationType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseLicenseType

DatabaseListResult

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

SampleName

SecondaryType

Sku

Ytterligare resurser