Databases - List By Server

Referentie

Service:: SQL Database

API-versie:: 2021-11-01

Hiermee haalt u een lijst met databases op.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
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.
$skipToken	query		string

Antwoorden

Name	Type	Description
200 OK	DatabaseListResult	De lijst met databases is opgehaald.
Other Status Codes		Foutreacties: *** 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden 404 ServerNotInSubscriptionResourceGroup - Opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement.

Name

Type

Description

200 OK

DatabaseListResult

De lijst met databases is opgehaald.

Other Status Codes

Foutreacties: ***

404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden
404 ServerNotInSubscriptionResourceGroup - Opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement.

Voorbeelden

Gets a list of databases.

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


/**
 * Samples for Databases ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListVCoreDatabasesByServer.json
     */
    /**
     * Sample code: Gets a list of databases.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsAListOfDatabases(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabases().listByServer("Default-SQL-SouthEastAsia", "testsvr",
            null, 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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
BackupStorageRedundancy	Het type opslagaccount 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. Standaard: het maken van een gewone database. Kopiëren: maakt een database als een kopie van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de brondatabase. Secundair: maakt 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 restorable verwijderde databaseresource-id zijn en sourceDatabaseDeletionDate wordt genegeerd. restorePointInTime kan ook worden opgegeven om te herstellen vanaf een eerder tijdstip. RestoreLongTermRetentionBackup: Hiermee maakt u een database door een langetermijnretentiekluis te herstellen. recoveryServicesRecoveryPointResourceId moet worden opgegeven als de resource-id van het herstelpunt. Kopiëren, Secundair 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. `LicenseIncluded` als u een licentie nodig hebt of `BasePrice` als u een licentie hebt en in aanmerking komt voor Azure Hybrid Benefit.
DatabaseListResult	Een lijst met databases.
DatabaseReadScale	De status van alleen-lezenroutering. Als deze optie is ingeschakeld, kunnen verbindingen met een toepassingsintentie die zijn ingesteld op alleen-lezen in de verbindingsreeks, worden doorgestuurd naar een alleen-lezen secundaire replica 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 Benoemd.
Sku	Een ARM-resource-SKU.

BackupStorageRedundancy

Inventarisatie

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

Waarde	Description
Geo
GeoZone
Local
Zone

CatalogCollationType

Inventarisatie

Sortering van de metagegevenscatalogus.

Waarde	Description
DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS

CreateMode

Inventarisatie

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

Standaard: het maken van een gewone database.

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

Secundair: maakt 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 restorable verwijderde databaseresource-id zijn en sourceDatabaseDeletionDate wordt genegeerd. restorePointInTime kan ook worden opgegeven om te herstellen vanaf een eerder tijdstip.

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

Kopiëren, Secundair en RestoreLongTermRetentionBackup worden niet ondersteund voor de DataWarehouse-editie.

Waarde	Description
Copy
Default
OnlineSecondary
PointInTimeRestore
Recovery
Restore
RestoreExternalBackup
RestoreExternalBackupSecondary
RestoreLongTermRetentionBackup
Secondary

Database

Object

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 (int32)	Tijd in minuten waarna de database automatisch wordt onderbroken. Een waarde van -1 betekent dat automatische pauze 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. Standaard: het maken van een gewone database. Kopiëren: maakt een database als een kopie van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de brondatabase. Secundair: maakt 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 restorable verwijderde databaseresource-id zijn en sourceDatabaseDeletionDate wordt genegeerd. restorePointInTime kan ook worden opgegeven om te herstellen vanaf een eerder tijdstip. RestoreLongTermRetentionBackup: Hiermee maakt u een database door een langetermijnretentiekluis te herstellen. recoveryServicesRecoveryPointResourceId moet worden opgegeven als de resource-id van het herstelpunt. Kopiëren, Secundair en RestoreLongTermRetentionBackup worden niet ondersteund voor de DataWarehouse-editie.
properties.creationDate	string (date-time)	De aanmaakdatum van de database (ISO8601-indeling).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Het type opslagaccount dat wordt gebruikt voor het opslaan van back-ups voor deze database.
properties.currentServiceObjectiveName	string	De naam van de huidige serviceniveaudoelstelling van de database.
properties.currentSku	Sku	De naam en laag van de SKU.
properties.databaseId	string (uuid)	De id van de database.
properties.defaultSecondaryLocation	string	De standaard secundaire regio voor deze database.
properties.earliestRestoreDate	string (date-time)	Hiermee wordt de vroegste begindatum en -tijd vastgelegd die beschikbaar zijn voor deze database (ISO8601-indeling).
properties.elasticPoolId	string (arm-id)	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 (uuid)	De client-id die wordt gebruikt voor cmk-scenario voor meerdere tenants per database
properties.highAvailabilityReplicaCount	integer (int32)	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 in een elastische pool.
properties.isInfraEncryptionEnabled	boolean	Infra-versleuteling is ingeschakeld voor deze database.
properties.isLedgerOn	boolean	Of deze database nu 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 toegepast op deze database. `LicenseIncluded` als u een licentie nodig hebt of `BasePrice` als u een licentie hebt en in aanmerking komt voor Azure Hybrid Benefit.
properties.longTermRetentionBackupResourceId	string (arm-id)	De resource-id van de back-up voor langetermijnretentie die is gekoppeld aan het maken van deze database.
properties.maintenanceConfigurationId	string	Onderhoudsconfiguratie-id die is toegewezen aan de database. Met deze configuratie wordt de periode gedefinieerd waarop de onderhoudsupdates plaatsvinden.
properties.maxLogSizeBytes	integer (int64)	De maximale logboekgrootte voor deze database.
properties.maxSizeBytes	integer (int64)	De maximale grootte van de database uitgedrukt in bytes.
properties.minCapacity	number (double)	Minimale capaciteit die de database altijd heeft toegewezen, indien niet onderbroken
properties.pausedDate	string (date-time)	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 met een toepassingsintentie die zijn ingesteld op alleen-lezen in de verbindingsreeks, worden doorgestuurd naar een alleen-lezen secundaire replica in dezelfde regio. Niet van toepassing op een Hyperscale-database in een elastische pool.
properties.recoverableDatabaseId	string (arm-id)	De resource-id van de herstelbare database die is gekoppeld aan het maken van deze database.
properties.recoveryServicesRecoveryPointId	string (arm-id)	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 (arm-id)	De resource-id van de terug te zetten database die is gekoppeld aan het maken van deze database.
properties.restorePointInTime	string (date-time)	Hiermee geeft u het tijdstip (ISO8601-indeling) van de brondatabase op die wordt hersteld om de nieuwe database te maken.
properties.resumedDate	string (date-time)	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 Benoemd.
properties.sourceDatabaseDeletionDate	string (date-time)	Hiermee geeft u het tijdstip op waarop de database is verwijderd.
properties.sourceDatabaseId	string (arm-id)	De resource-id van de brondatabase die is gekoppeld aan het maken van deze database.
properties.sourceResourceId	string (arm-id)	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 kan worden hersteld tussen abonnementen. Wanneer sourceResourceId is opgegeven, moet 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 is Restore, moet sourceResourceId de resource-id zijn van een verwijderde database of een verwijderde SQL-pool die kan worden teruggezet. Wanneer createMode is Recover, moet sourceResourceId de resource-id van de herstelbare database of herstelbare SQL-pool zijn. 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 https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant voor meer informatie over de header 'x-ms-authorization-auxiliary'.
properties.status	DatabaseStatus	De status van de database.
properties.zoneRedundant	boolean	Of deze database nu zone-redundant is, 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 variëren per regio en ondersteuningsaanbieding. Gebruik de `Capabilities_ListByLocation` REST API of een van de volgende opdrachten om 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

Object

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name	Type	Description
tenantId	string (uuid)	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

Inventarisatie

Het identiteitstype

Waarde	Description
None
UserAssigned

DatabaseLicenseType

Inventarisatie

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

Waarde	Description
BasePrice
LicenseIncluded

DatabaseListResult

Object

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

Inventarisatie

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

Waarde	Description
Disabled
Enabled

DatabaseStatus

Inventarisatie

De status van de database.

Waarde	Description
AutoClosed
Copying
Creating
Disabled
EmergencyMode
Inaccessible
Offline
OfflineChangingDwPerformanceTiers
OfflineSecondary
Online
OnlineChangingDwPerformanceTiers
Paused
Pausing
Recovering
RecoveryPending
Restoring
Resuming
Scaling
Shutdown
Standby
Starting
Stopped
Stopping
Suspect

DatabaseUserIdentity

Object

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name	Type	Description
clientId	string (uuid)	De Azure Active Directory-client-id.
principalId	string (uuid)	De principal-id van Azure Active Directory.

SampleName

Inventarisatie

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

Waarde	Description
AdventureWorksLT
WideWorldImportersFull
WideWorldImportersStd

SecondaryType

Inventarisatie

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

Waarde	Description
Geo
Named

Sku

Object

Een ARM-resource-SKU.

Name	Type	Description
capacity	integer (int32)	Capaciteit van de specifieke SKU.
family	string	Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan die 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.

Delen via

Databases - List By Server

URI-parameters

Antwoorden

Voorbeelden

Gets a list of databases.

Voorbeeldaanvraag

Voorbeeldrespons

Definities

BackupStorageRedundancy

CatalogCollationType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseLicenseType

DatabaseListResult

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

SampleName

SecondaryType

Sku

Aanvullende resources