Delen via


Databases - List By Elastic Pool

Hiermee haalt u een lijst met databases in een elastische pool op.

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

URI-parameters

Name In Vereist Type Description
elasticPoolName
path True

string

De naam van de elastische pool.

resourceGroupName
path True

string

De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.

serverName
path True

string

De naam van de server.

subscriptionId
path True

string

De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.

api-version
query True

string

De API-versie die moet worden gebruikt voor de aanvraag.

Antwoorden

Name Type Description
200 OK

DatabaseListResult

Een lijst met databases in een elastische pool is opgehaald.

Other Status Codes

Foutreacties: ***

  • 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden

  • 404 ServerNotInSubscriptionResourceGroup : de opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement.

  • 404 CannotFindObject - Kan het object niet vinden omdat het niet bestaat of omdat u geen machtigingen hebt

  • 404 ServerNotInSubscriptionResourceGroup : de opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement.

  • 404 ServerNotInSubscription : de opgegeven server bestaat niet in het opgegeven abonnement.

  • 429 SubscriptionTooManyCreateUpdateRequests - Aanvragen die verder gaan dan het maximumaantal aanvragen dat kan worden verwerkt door beschikbare resources.

  • 429 SubscriptionTooManyRequests - Aanvragen die verder gaan dan het maximumaantal aanvragen dat kan worden verwerkt door beschikbare resources.

  • 503 TooManyRequests: aanvragen die verder gaan dan het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources.

  • 504 RequestTimeout - Serviceaanvraag heeft de toegestane time-out overschreden.

Voorbeelden

Gets a list of databases in an elastic pool.

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
BackupStorageRedundancy

Het opslagaccounttype dat wordt gebruikt voor het opslaan van back-ups voor deze database.

CatalogCollationType

Sortering van de metagegevenscatalogus.

CreateMode

Hiermee geeft u de modus voor het maken van de database op.

Standaardinstelling: regelmatig database maken.

Kopiëren: hiermee maakt u een database als een kopie van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de brondatabase.

Secundair: hiermee maakt u een database als een secundaire replica van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande primaire database.

PointInTimeRestore: hiermee maakt u een database door een back-up naar een bepaald tijdstip van een bestaande database te herstellen. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande database en restorePointInTime moet worden opgegeven.

Herstel: hiermee maakt u een database door een geo-gerepliceerde back-up te herstellen. sourceDatabaseId moet worden opgegeven als de herstelbare databaseresource-id om te herstellen.

Herstellen: hiermee maakt u een database door een back-up van een verwijderde database te herstellen. sourceDatabaseId moet worden opgegeven. Als sourceDatabaseId de oorspronkelijke resource-id van de database is, moet sourceDatabaseDeletionDate worden opgegeven. Anders moet sourceDatabaseId de herstelbare verwijderde databaseresource-id zijn en moet sourceDatabaseDeletionDate worden genegeerd. restorePointInTime kan ook worden opgegeven om te herstellen vanaf een eerder tijdstip.

RestoreLongTermRetentionBackup: hiermee maakt u een database door te herstellen vanuit een langetermijnretentiekluis. recoveryServicesRecoveryPointResourceId moet worden opgegeven als de resource-id van het herstelpunt.

Copy, Secondary en RestoreLongTermRetentionBackup worden niet ondersteund voor de DataWarehouse-editie.

Database

Een databaseresource.

DatabaseIdentity

Azure Active Directory-identiteitsconfiguratie voor een resource.

DatabaseIdentityType

Het identiteitstype

DatabaseLicenseType

Het licentietype dat moet worden toegepast op deze database. LicenseIncludedals u een licentie nodig hebt of BasePrice als u een licentie hebt en in aanmerking komt voor de Azure Hybrid Benefit.

DatabaseListResult

Een lijst met databases.

DatabaseReadScale

De status van alleen-lezenroutering. Als deze optie is ingeschakeld, kunnen verbindingen waarvoor de toepassingsintentie is ingesteld op alleen-lezen in hun verbindingsreeks, worden doorgestuurd naar een secundaire replica met alleen-lezentoegang in dezelfde regio. Niet van toepassing op een Hyperscale-database in een elastische pool.

DatabaseStatus

De status van de database.

DatabaseUserIdentity

Azure Active Directory-identiteitsconfiguratie voor een resource.

SampleName

De naam van het voorbeeldschema dat moet worden toegepast bij het maken van deze database.

SecondaryType

Het secundaire type van de database als het een secundaire database is. Geldige waarden zijn Geo en Named.

Sku

Een ARM-resource-SKU.

BackupStorageRedundancy

Het opslagaccounttype dat wordt gebruikt voor het opslaan van back-ups voor deze database.

Name Type Description
Geo

string

GeoZone

string

Local

string

Zone

string

CatalogCollationType

Sortering van de metagegevenscatalogus.

Name Type Description
DATABASE_DEFAULT

string

SQL_Latin1_General_CP1_CI_AS

string

CreateMode

Hiermee geeft u de modus voor het maken van de database op.

Standaardinstelling: regelmatig database maken.

Kopiëren: hiermee maakt u een database als een kopie van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de brondatabase.

Secundair: hiermee maakt u een database als een secundaire replica van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande primaire database.

PointInTimeRestore: hiermee maakt u een database door een back-up naar een bepaald tijdstip van een bestaande database te herstellen. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande database en restorePointInTime moet worden opgegeven.

Herstel: hiermee maakt u een database door een geo-gerepliceerde back-up te herstellen. sourceDatabaseId moet worden opgegeven als de herstelbare databaseresource-id om te herstellen.

Herstellen: hiermee maakt u een database door een back-up van een verwijderde database te herstellen. sourceDatabaseId moet worden opgegeven. Als sourceDatabaseId de oorspronkelijke resource-id van de database is, moet sourceDatabaseDeletionDate worden opgegeven. Anders moet sourceDatabaseId de herstelbare verwijderde databaseresource-id zijn en moet sourceDatabaseDeletionDate worden genegeerd. restorePointInTime kan ook worden opgegeven om te herstellen vanaf een eerder tijdstip.

RestoreLongTermRetentionBackup: hiermee maakt u een database door te herstellen vanuit een langetermijnretentiekluis. recoveryServicesRecoveryPointResourceId moet worden opgegeven als de resource-id van het herstelpunt.

Copy, Secondary en RestoreLongTermRetentionBackup worden niet ondersteund voor de DataWarehouse-editie.

Name Type Description
Copy

string

Default

string

OnlineSecondary

string

PointInTimeRestore

string

Recovery

string

Restore

string

RestoreExternalBackup

string

RestoreExternalBackupSecondary

string

RestoreLongTermRetentionBackup

string

Secondary

string

Database

Een databaseresource.

Name Type Description
id

string

Resource-id.

identity

DatabaseIdentity

De Azure Active Directory-identiteit van de database.

kind

string

Soort database. Dit zijn metagegevens die worden gebruikt voor de Azure Portal ervaring.

location

string

Resourcelocatie.

managedBy

string

Resource die de database beheert.

name

string

Resourcenaam.

properties.autoPauseDelay

integer

Tijd in minuten waarna de database automatisch wordt onderbroken. De waarde -1 betekent dat automatisch onderbreken is uitgeschakeld

properties.catalogCollation

CatalogCollationType

Sortering van de metagegevenscatalogus.

properties.collation

string

De sortering van de database.

properties.createMode

CreateMode

Hiermee geeft u de modus voor het maken van de database op.

Standaardinstelling: regelmatig database maken.

Kopiëren: hiermee maakt u een database als een kopie van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de brondatabase.

Secundair: hiermee maakt u een database als een secundaire replica van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande primaire database.

PointInTimeRestore: hiermee maakt u een database door een back-up naar een bepaald tijdstip van een bestaande database te herstellen. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande database en restorePointInTime moet worden opgegeven.

Herstel: Hiermee maakt u een database door een geo-gerepliceerde back-up te herstellen. sourceDatabaseId moet worden opgegeven als de herstelbare databaseresource-id om te herstellen.

Herstellen: hiermee maakt u een database door een back-up van een verwijderde database te herstellen. sourceDatabaseId moet worden opgegeven. Als sourceDatabaseId de oorspronkelijke resource-id van de database is, moet sourceDatabaseDeletionDate worden opgegeven. Anders moet sourceDatabaseId de herstelbare verwijderde databaseresource-id zijn en wordt sourceDatabaseDeletionDate genegeerd. restorePointInTime kan ook worden opgegeven om te herstellen vanaf een eerder tijdstip.

RestoreLongTermRetentionBackup: hiermee maakt u een database door te herstellen vanuit een kluis voor langetermijnretentie. recoveryServicesRecoveryPointResourceId moet worden opgegeven als de resource-id van het herstelpunt.

Copy, Secondary en RestoreLongTermRetentionBackup worden niet ondersteund voor de DataWarehouse-editie.

properties.creationDate

string

De aanmaakdatum van de database (ISO8601 indeling).

properties.currentBackupStorageRedundancy

BackupStorageRedundancy

Het opslagaccounttype dat wordt gebruikt voor het opslaan van back-ups voor deze database.

properties.currentServiceObjectiveName

string

De huidige naam van de serviceniveaudoelstelling van de database.

properties.currentSku

Sku

De naam en laag van de SKU.

properties.databaseId

string

De id van de database.

properties.defaultSecondaryLocation

string

De standaard secundaire regio voor deze database.

properties.earliestRestoreDate

string

Hiermee wordt de vroegste begindatum en tijd vastgelegd waarop herstel beschikbaar is voor deze database (ISO8601 indeling).

properties.elasticPoolId

string

De resource-id van de elastische pool die deze database bevat.

properties.failoverGroupId

string

Resource-id van failovergroep waartoe deze database behoort.

properties.federatedClientId

string

De client-id die wordt gebruikt voor CMK-scenario voor meerdere tenants per database

properties.highAvailabilityReplicaCount

integer

Het aantal secundaire replica's dat is gekoppeld aan de database die wordt gebruikt om hoge beschikbaarheid te bieden. Niet van toepassing op een Hyperscale-database binnen een elastische pool.

properties.isInfraEncryptionEnabled

boolean

Infra-versleuteling is ingeschakeld voor deze database.

properties.isLedgerOn

boolean

Of deze database al dan niet een grootboekdatabase is, wat betekent dat alle tabellen in de database grootboektabellen zijn. Opmerking: de waarde van deze eigenschap kan niet worden gewijzigd nadat de database is gemaakt.

properties.licenseType

DatabaseLicenseType

Het licentietype dat moet worden aangevraagd voor deze database. LicenseIncludedals u een licentie nodig hebt of BasePrice als u een licentie hebt en in aanmerking komt voor de Azure Hybrid Benefit.

properties.longTermRetentionBackupResourceId

string

De resource-id van de langetermijnretentieback-up die is gekoppeld aan de maakbewerking van deze database.

properties.maintenanceConfigurationId

string

Onderhoudsconfiguratie-id die is toegewezen aan de database. Deze configuratie definieert de periode waarin de onderhoudsupdates worden uitgevoerd.

properties.maxLogSizeBytes

integer

De maximale logboekgrootte voor deze database.

properties.maxSizeBytes

integer

De maximale grootte van de database, uitgedrukt in bytes.

properties.minCapacity

number

Minimale capaciteit die de database altijd heeft toegewezen, indien niet onderbroken

properties.pausedDate

string

De datum waarop de database is onderbroken door gebruikersconfiguratie of actie (ISO8601 indeling). Null als de database gereed is.

properties.readScale

DatabaseReadScale

De status van alleen-lezenroutering. Als deze optie is ingeschakeld, kunnen verbindingen waarvoor de toepassingsintentie is ingesteld op alleen-lezen in hun verbindingsreeks, worden doorgestuurd naar een alleen-lezen secundaire replica in dezelfde regio. Niet van toepassing op een Hyperscale-database binnen een elastische pool.

properties.recoverableDatabaseId

string

De resource-id van de herstelbare database die is gekoppeld aan de maakbewerking van deze database.

properties.recoveryServicesRecoveryPointId

string

De resource-id van het herstelpunt dat is gekoppeld aan het maken van deze database.

properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

Het type opslagaccount dat moet worden gebruikt voor het opslaan van back-ups voor deze database.

properties.requestedServiceObjectiveName

string

De aangevraagde serviceniveaudoelstellingnaam van de database.

properties.restorableDroppedDatabaseId

string

De resource-id van de herstelbare verwijderde database die is gekoppeld aan de maakbewerking van deze database.

properties.restorePointInTime

string

Hiermee geeft u het tijdstip (ISO8601 indeling) op van de brondatabase die wordt hersteld om de nieuwe database te maken.

properties.resumedDate

string

De datum waarop de database is hervat door gebruikersactie of databaseaanmelding (ISO8601 indeling). Null als de database is onderbroken.

properties.sampleName

SampleName

De naam van het voorbeeldschema dat moet worden toegepast bij het maken van deze database.

properties.secondaryType

SecondaryType

Het secundaire type van de database als het een secundaire database is. Geldige waarden zijn Geo en Named.

properties.sourceDatabaseDeletionDate

string

Hiermee geeft u de tijd op waarop de database is verwijderd.

properties.sourceDatabaseId

string

De resource-id van de brondatabase die is gekoppeld aan het maken van deze database.

properties.sourceResourceId

string

De resource-id van de bron die is gekoppeld aan de maakbewerking van deze database.

Deze eigenschap wordt alleen ondersteund voor de DataWarehouse-editie en maakt het mogelijk om verschillende abonnementen te herstellen.

Wanneer sourceResourceId is opgegeven, moeten sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId en sourceDatabaseDeletionDate niet worden opgegeven en moet CreateMode PointInTimeRestore, Restore of Recover zijn.

Wanneer createMode PointInTimeRestore is, moet sourceResourceId de resource-id van de bestaande database of bestaande SQL-pool zijn en moet restorePointInTime worden opgegeven.

Wanneer createMode Herstellen is, moet sourceResourceId de resource-id zijn van herstelbare verwijderde database of herstelbare verwijderde SQL-pool.

Wanneer createMode Herstellen is, moet sourceResourceId de resource-id zijn van de herstelbare database of herstelbare SQL-pool.

Wanneer het bronabonnement deel uitmaakt van een andere tenant dan het doelabonnement, moet de header x-ms-authorization-auxiliary verificatietoken voor de brontenant bevatten. Zie voor meer informatie over de header x-ms-authorization-auxiliary https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

properties.status

DatabaseStatus

De status van de database.

properties.zoneRedundant

boolean

Of deze database zoneredundant is of niet, wat betekent dat de replica's van deze database worden verdeeld over meerdere beschikbaarheidszones.

sku

Sku

De database-SKU.

De lijst met SKU's kan verschillen per regio en ondersteuningsaanbieding. Gebruik Capabilities_ListByLocation de REST API of een van de volgende opdrachten om de SKU's (inclusief de SKU-naam, laag/editie, familie en capaciteit) te bepalen die beschikbaar zijn voor uw abonnement in een Azure-regio:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
tags

object

Resourcetags.

type

string

Resourcetype.

DatabaseIdentity

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name Type Description
tenantId

string

De tenant-id van Azure Active Directory.

type

DatabaseIdentityType

Het identiteitstype

userAssignedIdentities

<string,  DatabaseUserIdentity>

De resource-id's van de door de gebruiker toegewezen identiteiten die moeten worden gebruikt

DatabaseIdentityType

Het identiteitstype

Name Type Description
None

string

UserAssigned

string

DatabaseLicenseType

Het licentietype dat moet worden toegepast op deze database. LicenseIncludedals u een licentie nodig hebt of BasePrice als u een licentie hebt en in aanmerking komt voor de Azure Hybrid Benefit.

Name Type Description
BasePrice

string

LicenseIncluded

string

DatabaseListResult

Een lijst met databases.

Name Type Description
nextLink

string

Koppeling om de volgende pagina met resultaten op te halen.

value

Database[]

Matrix met resultaten.

DatabaseReadScale

De status van alleen-lezenroutering. Als deze optie is ingeschakeld, kunnen verbindingen waarvoor de toepassingsintentie is ingesteld op alleen-lezen in hun verbindingsreeks, worden doorgestuurd naar een secundaire replica met alleen-lezentoegang in dezelfde regio. Niet van toepassing op een Hyperscale-database in een elastische pool.

Name Type Description
Disabled

string

Enabled

string

DatabaseStatus

De status van de database.

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

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name Type Description
clientId

string

De Azure Active Directory-client-id.

principalId

string

De principal-id van Azure Active Directory.

SampleName

De naam van het voorbeeldschema dat moet worden toegepast bij het maken van deze database.

Name Type Description
AdventureWorksLT

string

WideWorldImportersFull

string

WideWorldImportersStd

string

SecondaryType

Het secundaire type van de database als het een secundaire database is. Geldige waarden zijn Geo en Named.

Name Type Description
Geo

string

Named

string

Sku

Een ARM-resource-SKU.

Name Type Description
capacity

integer

Capaciteit van de specifieke SKU.

family

string

Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan dat hier worden vastgelegd.

name

string

De naam van de SKU, meestal een letter + cijfercode, bijvoorbeeld P3.

size

string

Grootte van de specifieke SKU

tier

string

De laag of editie van de specifieke SKU, bijvoorbeeld Basic, Premium.