Databases - List By Elastic Pool

Získá seznam databází v elastickém fondu.

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

Parametry identifikátoru URI

Name In Required Type Description
elasticPoolName
path True
  • string

Název elastického fondu.

resourceGroupName
path True
  • string

Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API azure Resource Manager nebo portálu.

serverName
path True
  • string

Název serveru.

subscriptionId
path True
  • string

ID předplatného, které identifikuje předplatné Azure.

api-version
query True
  • string

Verze rozhraní API, která se má použít pro požadavek.

Odpovědi

Name Type Description
200 OK

Úspěšně se načetl seznam databází v elastickém fondu.

Other Status Codes

Chybové odpovědi: ***

  • 404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen.

  • 404 ServerNotInSubscriptionResourceGroup – Zadaný server neexistuje v zadané skupině prostředků a předplatném.

  • 404 CannotFindObject – Nelze najít objekt, protože neexistuje nebo nemáte oprávnění.

  • 404 ServerNotInSubscriptionResourceGroup – Zadaný server neexistuje v zadané skupině prostředků a předplatném.

  • 404 ServerNotInSubscription – Zadaný server v zadaném předplatném neexistuje.

  • 429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

  • 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

  • 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

  • 504 RequestTimeout – Žádost o službu překročila povolený časový limit.

Příklady

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

Definice

BackupStorageRedundancy

Typ účtu úložiště použitý k ukládání záloh pro tuto databázi.

CatalogCollationType

Kolace katalogu metadat

CreateMode

Určuje režim vytváření databáze.

Výchozí nastavení: pravidelné vytváření databáze.

Kopírování: Vytvoří databázi jako kopii existující databáze. sourceDatabaseId musí být zadán jako ID prostředku zdrojové databáze.

Sekundární: Vytvoří databázi jako sekundární repliku existující databáze. sourceDatabaseId musí být zadán jako ID prostředku existující primární databáze.

PointInTimeRestore: Vytvoří databázi obnovením zálohy existující databáze k určitému bodu v čase. sourceDatabaseId musí být zadán jako ID prostředku existující databáze a musí být zadán restorePointInTime.

Obnovení: Vytvoří databázi obnovením geograficky replikované zálohy. sourceDatabaseId musí být zadán jako id obnovitelného databázového prostředku k obnovení.

Obnovení: Vytvoří databázi obnovením zálohy odstraněné databáze. sourceDatabaseId musí být zadán. Pokud je id původního prostředku databáze sourceDatabaseId, je nutné zadat zdrojDatabaseDeletionDate. Jinak sourceDatabaseId musí být ID obnovovatelného vyřazeného prostředku databáze a sourceDatabaseDeletionDate se ignoruje. restorePointInTime může být také zadán k obnovení z dřívějšího bodu v čase.

RestoreLongTermRetentionBackup: Vytvoří databázi obnovením z dlouhodobého trezoru uchovávání informací. recoveryServicesRecoveryPointResourceId musí být zadán jako ID prostředku bodu obnovení.

Pro edici DataWarehouse se nepodporuje kopírování, sekundární a restoreLongTermRetentionBackup.

Database

Databázový prostředek.

DatabaseIdentity

Konfigurace identity Azure Active Directory pro prostředek

DatabaseIdentityType

Typ identity

DatabaseLicenseType

Typ licence, který se má použít pro tuto databázi. LicenseIncludedpokud potřebujete licenci nebo BasePrice máte licenci a máte nárok na Zvýhodněné hybridní využití Azure.

DatabaseListResult

Seznam databází.

DatabaseReadScale

Stav směrování jen pro čtení. Pokud je tato možnost povolená, připojení s záměrem aplikace nastavená na čtení v připojovacím řetězci se můžou směrovat do sekundární repliky jen pro čtení ve stejné oblasti. Nevztahuje se na databázi Hyperscale v rámci elastického fondu.

DatabaseStatus

Stav databáze.

DatabaseUserIdentity

Konfigurace identity Azure Active Directory pro prostředek

SampleName

Název ukázkového schématu, které se má použít při vytváření této databáze.

SecondaryType

Sekundární typ databáze, pokud je sekundární. Platné hodnoty jsou geografické a pojmenované.

Sku

Skladová položka prostředku ARM.

BackupStorageRedundancy

Typ účtu úložiště použitý k ukládání záloh pro tuto databázi.

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

CatalogCollationType

Kolace katalogu metadat

Name Type Description
DATABASE_DEFAULT
  • string
SQL_Latin1_General_CP1_CI_AS
  • string

CreateMode

Určuje režim vytváření databáze.

Výchozí nastavení: pravidelné vytváření databáze.

Kopírování: Vytvoří databázi jako kopii existující databáze. sourceDatabaseId musí být zadán jako ID prostředku zdrojové databáze.

Sekundární: Vytvoří databázi jako sekundární repliku existující databáze. sourceDatabaseId musí být zadán jako ID prostředku existující primární databáze.

PointInTimeRestore: Vytvoří databázi obnovením zálohy existující databáze k určitému bodu v čase. sourceDatabaseId musí být zadán jako ID prostředku existující databáze a musí být zadán restorePointInTime.

Obnovení: Vytvoří databázi obnovením geograficky replikované zálohy. sourceDatabaseId musí být zadán jako id obnovitelného databázového prostředku k obnovení.

Obnovení: Vytvoří databázi obnovením zálohy odstraněné databáze. sourceDatabaseId musí být zadán. Pokud je id původního prostředku databáze sourceDatabaseId, je nutné zadat zdrojDatabaseDeletionDate. Jinak sourceDatabaseId musí být ID obnovovatelného vyřazeného prostředku databáze a sourceDatabaseDeletionDate se ignoruje. restorePointInTime může být také zadán k obnovení z dřívějšího bodu v čase.

RestoreLongTermRetentionBackup: Vytvoří databázi obnovením z dlouhodobého trezoru uchovávání informací. recoveryServicesRecoveryPointResourceId musí být zadán jako ID prostředku bodu obnovení.

Pro edici DataWarehouse se nepodporuje kopírování, sekundární a restoreLongTermRetentionBackup.

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

Database

Databázový prostředek.

Name Type Description
id
  • string

ID prostředku.

identity

Identita azure Active Directory databáze.

kind
  • string

Druh databáze. Toto jsou metadata používaná pro Azure Portal prostředí.

location
  • string

Umístění prostředku

managedBy
  • string

Prostředek, který spravuje databázi.

name
  • string

Název prostředku.

properties.autoPauseDelay
  • integer

Doba v minutách, po které se databáze automaticky pozastaví. Hodnota -1 znamená, že automatické pozastavení je zakázané.

properties.catalogCollation

Kolace katalogu metadat.

properties.collation
  • string

Kolace databáze.

properties.createMode

Určuje režim vytváření databáze.

Výchozí nastavení: pravidelné vytváření databáze.

Kopírování: Vytvoří databázi jako kopii existující databáze. sourceDatabaseId musí být zadán jako ID prostředku zdrojové databáze.

Sekundární: Vytvoří databázi jako sekundární repliku existující databáze. sourceDatabaseId musí být zadán jako ID prostředku existující primární databáze.

PointInTimeRestore: Vytvoří databázi obnovením zálohy existující databáze k určitému bodu v čase. sourceDatabaseId musí být zadán jako ID prostředku existující databáze a musí být zadán restorePointInTime.

Obnovení: Vytvoří databázi obnovením geograficky replikované zálohy. sourceDatabaseId musí být zadán jako id obnovitelného databázového prostředku k obnovení.

Obnovení: Vytvoří databázi obnovením zálohy odstraněné databáze. sourceDatabaseId musí být zadán. Pokud sourceDatabaseId je původní ID prostředku databáze, musí být zadán sourceDatabaseDeletionDate. V opačném případě musí být id obnovovatelného vyřazeného prostředku databáze a sourceDatabaseDeletionDate ignorován. restorePointInTime může být také zadán k obnovení z dřívějšího bodu v čase.

RestoreLongTermRetentionBackup: Vytvoří databázi obnovením z dlouhodobého trezoru uchovávání informací. recoveryServicesRecoveryPointResourceId musí být zadán jako ID prostředku bodu obnovení.

Edice DataWarehouse nepodporuje kopírování, sekundární a restoreLongTermRetentionBackup.

properties.creationDate
  • string

Datum vytvoření databáze (formát ISO8601).

properties.currentBackupStorageRedundancy

Typ účtu úložiště použitý k ukládání záloh pro tuto databázi.

properties.currentServiceObjectiveName
  • string

Aktuální název cíle na úrovni služby databáze.

properties.currentSku

Název a úroveň skladové položky.

properties.databaseId
  • string

ID databáze.

properties.defaultSecondaryLocation
  • string

Výchozí sekundární oblast pro tuto databázi.

properties.earliestRestoreDate
  • string

Zaznamenává nejstarší počáteční datum a čas, které je pro tuto databázi k dispozici (formát ISO8601).

properties.elasticPoolId
  • string

Identifikátor prostředku elastického fondu obsahujícího tuto databázi.

properties.failoverGroupId
  • string

Identifikátor prostředku skupiny převzetí služeb při selhání, do kterého tato databáze patří.

properties.federatedClientId
  • string

ID klienta používané pro scénář klíče cmk databáze mezi tenanty

properties.highAvailabilityReplicaCount
  • integer

Počet sekundárních replik přidružených k databázi, která se používá k zajištění vysoké dostupnosti. Nevztahuje se na databázi Hyperscale v rámci elastického fondu.

properties.isInfraEncryptionEnabled
  • boolean

Pro tuto databázi je povolené šifrování infrastruktury.

properties.isLedgerOn
  • boolean

Bez ohledu na to, zda je tato databáze databází registru, což znamená, že všechny tabulky v databázi jsou tabulky registru. Poznámka: Hodnotu této vlastnosti nelze po vytvoření databáze změnit.

properties.licenseType

Typ licence, který se má použít pro tuto databázi. LicenseIncludedpokud potřebujete licenci nebo BasePrice pokud máte licenci a máte nárok na Zvýhodněné hybridní využití Azure.

properties.longTermRetentionBackupResourceId
  • string

Identifikátor prostředku dlouhodobé zálohy uchovávání přidružené k operaci vytvoření této databáze.

properties.maintenanceConfigurationId
  • string

ID konfigurace údržby přiřazené k databázi. Tato konfigurace definuje dobu, kdy dojde k aktualizacím údržby.

properties.maxLogSizeBytes
  • integer

Maximální velikost protokolu pro tuto databázi.

properties.maxSizeBytes
  • integer

Maximální velikost databáze vyjádřená v bajtech.

properties.minCapacity
  • number

Minimální kapacita, kterou databáze bude mít vždy přidělenou, pokud není pozastavena

properties.pausedDate
  • string

Datum pozastavení databáze konfigurací nebo akcí uživatele (formát ISO8601). Hodnota Null, pokud je databáze připravená.

properties.readScale

Stav směrování jen pro čtení. Pokud je tato možnost povolená, můžou být připojení, která mají v připojovacím řetězci nastavený záměr aplikace nastavenou na čtení, směrována do sekundární repliky jen pro čtení ve stejné oblasti. Nevztahuje se na databázi Hyperscale v rámci elastického fondu.

properties.recoverableDatabaseId
  • string

Identifikátor prostředku obnovitelné databáze přidružené k operaci vytvoření této databáze.

properties.recoveryServicesRecoveryPointId
  • string

Identifikátor prostředku bodu obnovení přidruženého k operaci vytvoření této databáze.

properties.requestedBackupStorageRedundancy

Typ účtu úložiště, který se má použít k ukládání záloh pro tuto databázi.

properties.requestedServiceObjectiveName
  • string

Požadovaný název cíle na úrovni služby databáze.

properties.restorableDroppedDatabaseId
  • string

Identifikátor prostředku obnovené vyřazené databáze přidružené k operaci vytvoření této databáze.

properties.restorePointInTime
  • string

Určuje bod v čase (formát ISO8601) zdrojové databáze, která se obnoví a vytvoří novou databázi.

properties.resumedDate
  • string

Datum, kdy byla databáze obnovena akcí uživatele nebo přihlášením k databázi (formát ISO8601). Hodnota Null, pokud je databáze pozastavena.

properties.sampleName

Název ukázkového schématu, které se má použít při vytváření této databáze.

properties.secondaryType

Sekundární typ databáze, pokud je sekundární. Platné hodnoty jsou geo a pojmenované.

properties.sourceDatabaseDeletionDate
  • string

Určuje čas odstranění databáze.

properties.sourceDatabaseId
  • string

Identifikátor prostředku zdrojové databáze přidružené k operaci vytvoření této databáze.

properties.sourceResourceId
  • string

Identifikátor prostředku zdroje přidruženého k operaci vytvoření této databáze.

Tato vlastnost je podporována pouze pro edici DataWarehouse a umožňuje obnovení napříč předplatnými.

Pokud je zadán sourceResourceId, sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId a sourceDatabaseDeletionDate nesmí být zadán a CreateMode musí být PointInTimeRestore, Restore nebo Recover.

Pokud je createMode PointInTimeRestore, sourceResourceId musí být ID prostředku existující databáze nebo existujícího fondu SQL a musí být zadán restorePointInTime.

Pokud je createMode Restore, sourceResourceId musí být ID prostředku obnovené vyřazené databáze nebo obnovitelného vyřazeného fondu SQL.

Pokud je createMode Recover, sourceResourceId musí být ID prostředku obnovitelné databáze nebo obnovitelného fondu SQL.

Pokud zdrojové předplatné patří do jiného tenanta než cílového předplatného, musí hlavička x-ms-authorization-auxiliary obsahovat ověřovací token pro zdrojového tenanta. Další podrobnosti o hlavičce x-ms-authorization-auxiliary naleznete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

properties.status

Stav databáze.

properties.zoneRedundant
  • boolean

Bez ohledu na to, jestli je tato databáze zónově redundantní, což znamená, že repliky této databáze budou rozloženy do více zón dostupnosti.

sku

Skladová položka databáze.

Seznam skladových položek se může lišit podle oblasti a nabídky podpory. K určení skladových položek (včetně názvu skladové položky, úrovně/edice, rodiny a kapacity) dostupných pro vaše předplatné v oblasti Azure použijte Capabilities_ListByLocation rozhraní REST API nebo jeden z následujících příkazů:

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

Značky prostředků

type
  • string

Typ prostředku.

DatabaseIdentity

Konfigurace identity Azure Active Directory pro prostředek

Name Type Description
tenantId
  • string

ID tenanta Azure Active Directory

type

Typ identity

userAssignedIdentities

ID prostředků identit přiřazených uživatelem, které se mají použít

DatabaseIdentityType

Typ identity

Name Type Description
None
  • string
UserAssigned
  • string

DatabaseLicenseType

Typ licence, který se má použít pro tuto databázi. LicenseIncludedpokud potřebujete licenci nebo BasePrice máte licenci a máte nárok na Zvýhodněné hybridní využití Azure.

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

DatabaseListResult

Seznam databází.

Name Type Description
nextLink
  • string

Odkaz na načtení další stránky výsledků

value

Pole výsledků.

DatabaseReadScale

Stav směrování jen pro čtení. Pokud je tato možnost povolená, připojení s záměrem aplikace nastavená na čtení v připojovacím řetězci se můžou směrovat do sekundární repliky jen pro čtení ve stejné oblasti. Nevztahuje se na databázi Hyperscale v rámci elastického fondu.

Name Type Description
Disabled
  • string
Enabled
  • string

DatabaseStatus

Stav databáze.

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

Konfigurace identity Azure Active Directory pro prostředek

Name Type Description
clientId
  • string

ID klienta Azure Active Directory

principalId
  • string

ID instančního objektu Azure Active Directory

SampleName

Název ukázkového schématu, které se má použít při vytváření této databáze.

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

SecondaryType

Sekundární typ databáze, pokud je sekundární. Platné hodnoty jsou geografické a pojmenované.

Name Type Description
Geo
  • string
Named
  • string

Sku

Skladová položka prostředku ARM.

Name Type Description
capacity
  • integer

Kapacita konkrétní skladové položky.

family
  • string

Pokud má služba různé generace hardwaru, pro stejnou skladovou položku, můžete ji zde zachytit.

name
  • string

Název skladové položky, obvykle písmeno + číslo, například P3.

size
  • string

Velikost konkrétní skladové položky

tier
  • string

Úroveň nebo edice konkrétní skladové položky, například Basic, Premium.