Databases - List By Server

Ruft eine Liste der Datenbanken ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

serverName
path True

string

Name des Servers

subscriptionId
path True

string

Abonnement-ID für ein Azure-Abonnement.

api-version
query True

string

API-Version, die für die Anforderung verwendet werden soll.

$skipToken
query

string

Antworten

Name Typ Beschreibung
200 OK

DatabaseListResult

Die Liste der Datenbanken wurde erfolgreich abgerufen.

Other Status Codes

Fehlerantworten: ***

  • 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden

  • 404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.

Beispiele

Gets a list of databases.

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases?api-version=2021-11-01

Sample Response

{
  "value": [
    {
      "sku": {
        "name": "BC_Gen4",
        "tier": "BusinessCritical",
        "capacity": 2
      },
      "kind": "v12.0,user,vcore",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "status": "Online",
        "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
        "creationDate": "2017-06-07T04:41:33.937Z",
        "currentServiceObjectiveName": "BC_Gen4_2",
        "requestedServiceObjectiveName": "BC_Gen4_2",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
        "licenseType": "LicenseIncluded",
        "maxLogSizeBytes": 104857600,
        "isInfraEncryptionEnabled": false,
        "zoneRedundant": false,
        "readScale": "Enabled",
        "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
        "currentSku": {
          "name": "BC_Gen4",
          "tier": "BusinessCritical",
          "capacity": 2
        },
        "currentBackupStorageRedundancy": "Zone",
        "requestedBackupStorageRedundancy": "Zone",
        "isLedgerOn": false
      },
      "location": "southeastasia",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
      "name": "testdb",
      "type": "Microsoft.Sql/servers/databases"
    },
    {
      "sku": {
        "name": "System0",
        "tier": "System",
        "capacity": 0
      },
      "kind": "v12.0,system",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 32212254720,
        "status": "Online",
        "databaseId": "e6be351f-2cc9-4604-9e52-b0b28b2710b0",
        "creationDate": "2017-06-07T04:23:42.537Z",
        "currentServiceObjectiveName": "System0",
        "requestedServiceObjectiveName": "System0",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
        "isInfraEncryptionEnabled": false,
        "zoneRedundant": false,
        "readScale": "Disabled",
        "currentSku": {
          "name": "System0",
          "tier": "System",
          "capacity": 0
        },
        "currentBackupStorageRedundancy": "Local",
        "requestedBackupStorageRedundancy": "Local",
        "isLedgerOn": false
      },
      "location": "southeastasia",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/master",
      "name": "master",
      "type": "Microsoft.Sql/servers/databases"
    }
  ]
}

Definitionen

Name Beschreibung
BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese Datenbank verwendet wird.

CatalogCollationType

Sortierung des Metadatenkatalogs.

CreateMode

Gibt den Modus der Datenbankerstellung an.

Standard: Reguläre Datenbankerstellung.

Kopieren: Erstellt eine Datenbank als Kopie einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der Quelldatenbank angegeben werden.

Sekundär: Erstellt eine Datenbank als sekundäres Replikat einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der vorhandenen primären Datenbank angegeben werden.

PointInTimeRestore: Erstellt eine Datenbank, indem eine Zeitpunktsicherung einer vorhandenen Datenbank wiederhergestellt wird. sourceDatabaseId muss als Ressourcen-ID der vorhandenen Datenbank angegeben werden, und restorePointInTime muss angegeben werden.

Wiederherstellung: Erstellt eine Datenbank, indem eine georeplizierte Sicherung wiederhergestellt wird. sourceDatabaseId muss als wiederherzustellende Datenbankressourcen-ID angegeben werden.

Wiederherstellen: Erstellt eine Datenbank, indem eine Sicherung einer gelöschten Datenbank wiederhergestellt wird. sourceDatabaseId muss angegeben werden. Wenn sourceDatabaseId die ursprüngliche Ressourcen-ID der Datenbank ist, muss sourceDatabaseDeletionDate angegeben werden. Andernfalls muss sourceDatabaseId die wiederherstellbare gelöschte Datenbankressourcen-ID sein, und sourceDatabaseDeletionDate wird ignoriert. restorePointInTime kann auch für die Wiederherstellung von einem früheren Zeitpunkt angegeben werden.

RestoreLongTermRetentionBackup: Erstellt eine Datenbank durch Wiederherstellen aus einem Langfristigen Aufbewahrungstresor. recoveryServicesRecoveryPointResourceId muss als Ressourcen-ID des Wiederherstellungspunkts angegeben werden.

Copy, Secondary und RestoreLongTermRetentionBackup werden für die DataWarehouse-Edition nicht unterstützt.

Database

Eine Datenbankressource.

DatabaseIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

DatabaseIdentityType

Der Identitätstyp

DatabaseLicenseType

Der Lizenztyp, der für diese Datenbank angewendet werden soll. LicenseIncluded, wenn Sie eine Lizenz benötigen oder BasePrice über eine Lizenz verfügen und für die Azure-Hybridvorteil berechtigt sind.

DatabaseListResult

Eine Datenbankliste.

DatabaseReadScale

Der Status des schreibgeschützten Routings. Wenn diese Option aktiviert ist, können Verbindungen, für die die Anwendungsabsicht in ihrem Verbindungszeichenfolge schreibaktiv festgelegt ist, an ein schreibgeschütztes sekundäres Replikat in derselben Region weitergeleitet werden. Gilt nicht für eine Hyperscale-Datenbank in einem Pool für elastische Datenbanken.

DatabaseStatus

Der Status der Datenbank.

DatabaseUserIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

SampleName

Der Name des Beispielschemas, das beim Erstellen dieser Datenbank angewendet werden soll.

SecondaryType

Der sekundäre Typ der Datenbank, wenn es sich um einen sekundären Typ handelt. Gültige Werte sind Geo und Benannt.

Sku

Eine ARM-Ressourcen-SKU.

BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese Datenbank verwendet wird.

Name Typ Beschreibung
Geo

string

GeoZone

string

Local

string

Zone

string

CatalogCollationType

Sortierung des Metadatenkatalogs.

Name Typ Beschreibung
DATABASE_DEFAULT

string

SQL_Latin1_General_CP1_CI_AS

string

CreateMode

Gibt den Modus der Datenbankerstellung an.

Standard: Reguläre Datenbankerstellung.

Kopieren: Erstellt eine Datenbank als Kopie einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der Quelldatenbank angegeben werden.

Sekundär: Erstellt eine Datenbank als sekundäres Replikat einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der vorhandenen primären Datenbank angegeben werden.

PointInTimeRestore: Erstellt eine Datenbank, indem eine Zeitpunktsicherung einer vorhandenen Datenbank wiederhergestellt wird. sourceDatabaseId muss als Ressourcen-ID der vorhandenen Datenbank angegeben werden, und restorePointInTime muss angegeben werden.

Wiederherstellung: Erstellt eine Datenbank, indem eine georeplizierte Sicherung wiederhergestellt wird. sourceDatabaseId muss als wiederherzustellende Datenbankressourcen-ID angegeben werden.

Wiederherstellen: Erstellt eine Datenbank, indem eine Sicherung einer gelöschten Datenbank wiederhergestellt wird. sourceDatabaseId muss angegeben werden. Wenn sourceDatabaseId die ursprüngliche Ressourcen-ID der Datenbank ist, muss sourceDatabaseDeletionDate angegeben werden. Andernfalls muss sourceDatabaseId die wiederherstellbare gelöschte Datenbankressourcen-ID sein, und sourceDatabaseDeletionDate wird ignoriert. restorePointInTime kann auch für die Wiederherstellung von einem früheren Zeitpunkt angegeben werden.

RestoreLongTermRetentionBackup: Erstellt eine Datenbank durch Wiederherstellen aus einem Langfristigen Aufbewahrungstresor. recoveryServicesRecoveryPointResourceId muss als Ressourcen-ID des Wiederherstellungspunkts angegeben werden.

Copy, Secondary und RestoreLongTermRetentionBackup werden für die DataWarehouse-Edition nicht unterstützt.

Name Typ Beschreibung
Copy

string

Default

string

OnlineSecondary

string

PointInTimeRestore

string

Recovery

string

Restore

string

RestoreExternalBackup

string

RestoreExternalBackupSecondary

string

RestoreLongTermRetentionBackup

string

Secondary

string

Database

Eine Datenbankressource.

Name Typ Beschreibung
id

string

Ressourcen-ID

identity

DatabaseIdentity

Die Azure Active Directory-Identität der Datenbank.

kind

string

Art der Datenbank. Dies sind Metadaten, die für die Azure-Portal-Benutzeroberfläche verwendet werden.

location

string

Ressourcenspeicherort

managedBy

string

Ressource, die die Datenbank verwaltet.

name

string

Name der Ressource.

properties.autoPauseDelay

integer

Zeit in Minuten, nach der die Datenbank automatisch angehalten wird. Der Wert -1 bedeutet, dass die automatische Pause deaktiviert ist.

properties.catalogCollation

CatalogCollationType

Sortierung des Metadatenkatalogs.

properties.collation

string

Die Sortierung der Datenbank.

properties.createMode

CreateMode

Gibt den Modus der Datenbankerstellung an.

Standard: Reguläre Datenbankerstellung.

Kopieren: Erstellt eine Datenbank als Kopie einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der Quelldatenbank angegeben werden.

Sekundär: Erstellt eine Datenbank als sekundäres Replikat einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der vorhandenen primären Datenbank angegeben werden.

PointInTimeRestore: Erstellt eine Datenbank, indem eine Zeitpunktsicherung einer vorhandenen Datenbank wiederhergestellt wird. sourceDatabaseId muss als Ressourcen-ID der vorhandenen Datenbank angegeben werden, und restorePointInTime muss angegeben werden.

Wiederherstellung: Erstellt eine Datenbank, indem eine georeplizierte Sicherung wiederhergestellt wird. sourceDatabaseId muss als wiederherzustellende Datenbankressourcen-ID angegeben werden.

Wiederherstellen: Erstellt eine Datenbank, indem eine Sicherung einer gelöschten Datenbank wiederhergestellt wird. sourceDatabaseId muss angegeben werden. Wenn sourceDatabaseId die ursprüngliche Ressourcen-ID der Datenbank ist, muss sourceDatabaseDeletionDate angegeben werden. Andernfalls muss sourceDatabaseId die wiederherstellbare gelöschte Datenbankressourcen-ID sein, und sourceDatabaseDeletionDate wird ignoriert. restorePointInTime kann auch für die Wiederherstellung von einem früheren Zeitpunkt angegeben werden.

RestoreLongTermRetentionBackup: Erstellt eine Datenbank durch Wiederherstellen aus einem Langfristigen Aufbewahrungstresor. recoveryServicesRecoveryPointResourceId muss als Ressourcen-ID des Wiederherstellungspunkts angegeben werden.

Copy, Secondary und RestoreLongTermRetentionBackup werden für die DataWarehouse-Edition nicht unterstützt.

properties.creationDate

string

Das Erstellungsdatum der Datenbank (ISO8601 Format).

properties.currentBackupStorageRedundancy

BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese Datenbank verwendet wird.

properties.currentServiceObjectiveName

string

Der aktuelle Dienstlevelzielname der Datenbank.

properties.currentSku

Sku

Der Name und die Ebene der SKU.

properties.databaseId

string

Die ID der Datenbank.

properties.defaultSecondaryLocation

string

Die sekundäre Standardregion für diese Datenbank.

properties.earliestRestoreDate

string

Dadurch werden das früheste Startdatum und die früheste Wiederherstellungszeit für diese Datenbank (ISO8601 Format) aufgezeichnet.

properties.elasticPoolId

string

Der Ressourcenbezeichner des Pools für elastische Datenbanken, der diese Datenbank enthält.

properties.failoverGroupId

string

Failovergruppenressourcenbezeichner, zu dem diese Datenbank gehört.

properties.federatedClientId

string

Client-ID, die für mandantenübergreifendes CMK-Szenario pro Datenbank verwendet wird

properties.highAvailabilityReplicaCount

integer

Die Anzahl der sekundären Replikate, die der Datenbank zugeordnet sind und zur Bereitstellung von Hochverfügbarkeit verwendet werden. Gilt nicht für eine Hyperscale-Datenbank in einem Pool für elastische Datenbanken.

properties.isInfraEncryptionEnabled

boolean

Die Infrastrukturverschlüsselung ist für diese Datenbank aktiviert.

properties.isLedgerOn

boolean

Unabhängig davon, ob es sich bei dieser Datenbank um eine Ledgerdatenbank handelt, was bedeutet, dass alle Tabellen in der Datenbank Ledgertabellen sind. Hinweis: Der Wert dieser Eigenschaft kann nicht geändert werden, nachdem die Datenbank erstellt wurde.

properties.licenseType

DatabaseLicenseType

Der Lizenztyp, der für diese Datenbank angewendet werden soll. LicenseIncluded, wenn Sie eine Lizenz benötigen oder BasePrice über eine Lizenz verfügen und für die Azure-Hybridvorteil berechtigt sind.

properties.longTermRetentionBackupResourceId

string

Der Ressourcenbezeichner der langfristigen Aufbewahrungssicherung, die dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

properties.maintenanceConfigurationId

string

Wartungskonfigurations-ID, die der Datenbank zugewiesen ist. Diese Konfiguration definiert den Zeitraum, in dem die Wartungsupdates durchgeführt werden.

properties.maxLogSizeBytes

integer

Die maximale Protokollgröße für diese Datenbank.

properties.maxSizeBytes

integer

Die maximale Größe der Datenbank, ausgedrückt in Bytes.

properties.minCapacity

number

Minimale Kapazität, die die Datenbank immer zugewiesen hat, wenn sie nicht angehalten wird

properties.pausedDate

string

Das Datum, an dem die Datenbank durch Benutzerkonfiguration oder Aktion (ISO8601 Format) angehalten wurde. NULL, wenn die Datenbank bereit ist.

properties.readScale

DatabaseReadScale

Der Status des schreibgeschützten Routings. Wenn diese Option aktiviert ist, können Verbindungen, für die die Anwendungsabsicht in ihrem Verbindungszeichenfolge schreibaktiv festgelegt ist, an ein schreibgeschütztes sekundäres Replikat in derselben Region weitergeleitet werden. Gilt nicht für eine Hyperscale-Datenbank in einem Pool für elastische Datenbanken.

properties.recoverableDatabaseId

string

Der Ressourcenbezeichner der wiederherstellbaren Datenbank, die dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

properties.recoveryServicesRecoveryPointId

string

Der Ressourcenbezeichner des Wiederherstellungspunkts, der dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese Datenbank verwendet werden soll.

properties.requestedServiceObjectiveName

string

Der angeforderte Service Level Objective Name der Datenbank.

properties.restorableDroppedDatabaseId

string

Der Ressourcenbezeichner der wiederherstellbaren gelöschten Datenbank, die dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

properties.restorePointInTime

string

Gibt den Zeitpunkt (ISO8601 Format) der Quelldatenbank an, die zum Erstellen der neuen Datenbank wiederhergestellt wird.

properties.resumedDate

string

Das Datum, an dem die Datenbank durch Benutzeraktion oder Datenbankanmeldung (ISO8601 Format) fortgesetzt wurde. NULL, wenn die Datenbank angehalten wird.

properties.sampleName

SampleName

Der Name des Beispielschemas, das beim Erstellen dieser Datenbank angewendet werden soll.

properties.secondaryType

SecondaryType

Der sekundäre Typ der Datenbank, wenn es sich um einen sekundären Typ handelt. Gültige Werte sind Geo und Benannt.

properties.sourceDatabaseDeletionDate

string

Gibt den Zeitpunkt an, zu dem die Datenbank gelöscht wurde.

properties.sourceDatabaseId

string

Der Ressourcenbezeichner der Quelldatenbank, die dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

properties.sourceResourceId

string

Der Ressourcenbezeichner der Quelle, die dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

Diese Eigenschaft wird nur für die DataWarehouse-Edition unterstützt und ermöglicht die abonnementübergreifende Wiederherstellung.

Wenn sourceResourceId angegeben wird, dürfen sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId und sourceDatabaseDeletionDate nicht angegeben werden, und CreateMode muss PointInTimeRestore, Restore oder Recover sein.

Wenn createMode PointInTimeRestore ist, muss sourceResourceId die Ressourcen-ID der vorhandenen Datenbank oder des vorhandenen SQL-Pools sein, und restorePointInTime muss angegeben werden.

Wenn createMode restore ist, muss sourceResourceId die Ressourcen-ID der wiederherstellbaren gelöschten Datenbank oder des wiederherstellbaren gelöschten SQL-Pools sein.

Wenn createMode Wiederherstellen ist, muss sourceResourceId die Ressourcen-ID der wiederherstellbaren Datenbank oder des wiederherstellbaren SQL-Pools sein.

Wenn das Quellabonnement zu einem anderen Mandanten als dem Zielabonnement gehört, muss der Header "x-ms-authorization-auxiliary" ein Authentifizierungstoken für den Quellmandanten enthalten. Weitere Informationen zum Header "x-ms-authorization-auxiliary" finden Sie unter https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

properties.status

DatabaseStatus

Der Status der Datenbank.

properties.zoneRedundant

boolean

Unabhängig davon, ob diese Datenbank zonenredundant ist, werden die Replikate dieser Datenbank auf mehrere Verfügbarkeitszonen verteilt.

sku

Sku

Die Datenbank-SKU.

Die Liste der SKUs kann je nach Region und Supportangebot variieren. Verwenden Sie die REST-API oder einen der folgenden Befehle, um die SKUs (einschließlich SKU-Name, Tarif/Edition, Familie und Kapazität) zu ermitteln, die Capabilities_ListByLocation für Ihr Abonnement in einer Azure-Region verfügbar sind:

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

object

Ressourcentags.

type

string

Der Ressourcentyp.

DatabaseIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

Name Typ Beschreibung
tenantId

string

Die Azure Active Directory-Mandanten-ID.

type

DatabaseIdentityType

Der Identitätstyp

userAssignedIdentities

<string,  DatabaseUserIdentity>

Die Ressourcen-ID der zu verwendenden benutzerseitig zugewiesenen Identitäten

DatabaseIdentityType

Der Identitätstyp

Name Typ Beschreibung
None

string

UserAssigned

string

DatabaseLicenseType

Der Lizenztyp, der für diese Datenbank angewendet werden soll. LicenseIncluded, wenn Sie eine Lizenz benötigen oder BasePrice über eine Lizenz verfügen und für die Azure-Hybridvorteil berechtigt sind.

Name Typ Beschreibung
BasePrice

string

LicenseIncluded

string

DatabaseListResult

Eine Datenbankliste.

Name Typ Beschreibung
nextLink

string

Link zum Abrufen der nächsten Ergebnisseite.

value

Database[]

Array von Ergebnissen.

DatabaseReadScale

Der Status des schreibgeschützten Routings. Wenn diese Option aktiviert ist, können Verbindungen, für die die Anwendungsabsicht in ihrem Verbindungszeichenfolge schreibaktiv festgelegt ist, an ein schreibgeschütztes sekundäres Replikat in derselben Region weitergeleitet werden. Gilt nicht für eine Hyperscale-Datenbank in einem Pool für elastische Datenbanken.

Name Typ Beschreibung
Disabled

string

Enabled

string

DatabaseStatus

Der Status der Datenbank.

Name Typ Beschreibung
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-Identitätskonfiguration für eine Ressource.

Name Typ Beschreibung
clientId

string

Die Azure Active Directory-Client-ID.

principalId

string

Die Azure Active Directory-Prinzipal-ID.

SampleName

Der Name des Beispielschemas, das beim Erstellen dieser Datenbank angewendet werden soll.

Name Typ Beschreibung
AdventureWorksLT

string

WideWorldImportersFull

string

WideWorldImportersStd

string

SecondaryType

Der sekundäre Typ der Datenbank, wenn es sich um einen sekundären Typ handelt. Gültige Werte sind Geo und Benannt.

Name Typ Beschreibung
Geo

string

Named

string

Sku

Eine ARM-Ressourcen-SKU.

Name Typ Beschreibung
capacity

integer

Kapazität der jeweiligen SKU.

family

string

Wenn der Dienst über unterschiedliche Hardwaregenerationen für dieselbe SKU verfügt, kann dies hier erfasst werden.

name

string

Der Name der SKU, in der Regel ein Buchstabe + Zahlencode, z. B. P3.

size

string

Größe der jeweiligen SKU

tier

string

Der Tarif oder die Edition der jeweiligen SKU, z. B. Basic, Premium.