Databases - List By Server

Référence

Service:: SQL Database

Version d'API:: 2021-11-01

Obtient une liste de bases de données.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.
$skipToken	query		string

Réponses

Nom	Type	Description
200 OK	DatabaseListResult	La liste des bases de données a été récupérée avec succès.
Other Status Codes		Réponses d’erreur : *** 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.

Nom

Type

Description

200 OK

DatabaseListResult

La liste des bases de données a été récupérée avec succès.

Other Status Codes

Réponses d’erreur : ***

404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable
404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.

Exemples

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
BackupStorageRedundancy	Type de compte de stockage utilisé pour stocker les sauvegardes pour cette base de données.
CatalogCollationType	Classement du catalogue de métadonnées.
CreateMode	Spécifie le mode de création de la base de données. Par défaut : création régulière de base de données. Copier : crée une base de données en tant que copie d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données source. Secondaire : crée une base de données en tant que réplica secondaire d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données primaire existante. PointInTimeRestore : crée une base de données en restaurant une sauvegarde dans le temps d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données existante, et restorePointInTime doit être spécifié. Récupération : crée une base de données en restaurant une sauvegarde géorépliquée. sourceDatabaseId doit être spécifié comme ID de ressource de base de données récupérable à restaurer. Restaurer : crée une base de données en restaurant une sauvegarde d’une base de données supprimée. sourceDatabaseId doit être spécifié. Si sourceDatabaseId est l’ID de ressource d’origine de la base de données, sourceDatabaseDeletionDate doit être spécifié. Sinon, sourceDatabaseId doit être l’ID de ressource de base de données supprimée pouvant être restaurée et sourceDatabaseDeletionDate est ignoré. restorePointInTime peut également être spécifié pour la restauration à partir d’un point antérieur dans le temps. RestoreLongTermRetentionBackup : crée une base de données en restaurant à partir d’un coffre de rétention à long terme. recoveryServicesRecoveryPointResourceId doit être spécifié comme ID de ressource du point de récupération. Copy, Secondary et RestoreLongTermRetentionBackup ne sont pas pris en charge pour l’édition DataWarehouse.
Database	Une ressource de base de données.
DatabaseIdentity	Configuration d’identité Azure Active Directory pour une ressource.
DatabaseIdentityType	Type d’identité
DatabaseLicenseType	Type de licence à appliquer pour cette base de données. `LicenseIncluded`si vous avez besoin d’une licence, ou `BasePrice` si vous disposez d’une licence et que vous êtes éligible pour le Azure Hybrid Benefit.
DatabaseListResult	Liste des bases de données.
DatabaseReadScale	État du routage en lecture seule. Si cette option est activée, les connexions dont l’intention d’application est définie sur readonly dans leur chaîne de connexion peuvent être routées vers un réplica secondaire en lecture seule dans la même région. Non applicable à une base de données Hyperscale au sein d’un pool élastique.
DatabaseStatus	Statut de la base de données.
DatabaseUserIdentity	Configuration de l’identité Azure Active Directory pour une ressource.
SampleName	Nom de l’exemple de schéma à appliquer lors de la création de cette base de données.
SecondaryType	Type secondaire de la base de données s’il s’agit d’une base de données secondaire. Les valeurs valides sont Geo et Named.
Sku	Référence SKU de ressource ARM.

BackupStorageRedundancy

Type de compte de stockage utilisé pour stocker les sauvegardes pour cette base de données.

Nom	Type	Description
Geo	string
GeoZone	string
Local	string
Zone	string

CatalogCollationType

Classement du catalogue de métadonnées.

Nom	Type	Description
DATABASE_DEFAULT	string
SQL_Latin1_General_CP1_CI_AS	string

CreateMode

Spécifie le mode de création de la base de données.

Par défaut : création régulière de base de données.

Copier : crée une base de données en tant que copie d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données source.

Secondaire : crée une base de données en tant que réplica secondaire d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données primaire existante.

PointInTimeRestore : crée une base de données en restaurant une sauvegarde dans le temps d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données existante, et restorePointInTime doit être spécifié.

Récupération : crée une base de données en restaurant une sauvegarde géorépliquée. sourceDatabaseId doit être spécifié comme ID de ressource de base de données récupérable à restaurer.

Restaurer : crée une base de données en restaurant une sauvegarde d’une base de données supprimée. sourceDatabaseId doit être spécifié. Si sourceDatabaseId est l’ID de ressource d’origine de la base de données, sourceDatabaseDeletionDate doit être spécifié. Sinon, sourceDatabaseId doit être l’ID de ressource de base de données supprimée pouvant être restaurée et sourceDatabaseDeletionDate est ignoré. restorePointInTime peut également être spécifié pour la restauration à partir d’un point antérieur dans le temps.

RestoreLongTermRetentionBackup : crée une base de données en restaurant à partir d’un coffre de rétention à long terme. recoveryServicesRecoveryPointResourceId doit être spécifié comme ID de ressource du point de récupération.

Copy, Secondary et RestoreLongTermRetentionBackup ne sont pas pris en charge pour l’édition DataWarehouse.

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

Database

Une ressource de base de données.

Nom	Type	Description
id	string	ID de la ressource
identity	DatabaseIdentity	Identité Azure Active Directory de la base de données.
kind	string	Type de base de données. Il s’agit des métadonnées utilisées pour l’expérience Portail Azure.
location	string	Emplacement de la ressource.
managedBy	string	Ressource qui gère la base de données.
name	string	Nom de la ressource.
properties.autoPauseDelay	integer	Durée en minutes après laquelle la base de données est automatiquement suspendue. La valeur -1 signifie que la pause automatique est désactivée
properties.catalogCollation	CatalogCollationType	Classement du catalogue de métadonnées.
properties.collation	string	Classement de la base de données.
properties.createMode	CreateMode	Spécifie le mode de création de la base de données. Valeur par défaut : création régulière de la base de données. Copier : crée une base de données en tant que copie d’une base de données existante. sourceDatabaseId doit être spécifié en tant qu’ID de ressource de la base de données source. Secondaire : crée une base de données en tant que réplica secondaire d’une base de données existante. sourceDatabaseId doit être spécifié en tant qu’ID de ressource de la base de données primaire existante. PointInTimeRestore : crée une base de données en restaurant une sauvegarde dans le temps d’une base de données existante. sourceDatabaseId doit être spécifié en tant qu’ID de ressource de la base de données existante, et restorePointInTime doit être spécifié. Récupération : crée une base de données en restaurant une sauvegarde géorépliquée. sourceDatabaseId doit être spécifié en tant qu’ID de ressource de base de données récupérable à restaurer. Restaurer : crée une base de données en restaurant une sauvegarde d’une base de données supprimée. sourceDatabaseId doit être spécifié. Si sourceDatabaseId est l’ID de ressource d’origine de la base de données, sourceDatabaseDeletionDate doit être spécifié. Sinon, sourceDatabaseId doit être l’ID de ressource de base de données supprimée restaurable et sourceDatabaseDeletionDate est ignoré. restorePointInTime peut également être spécifié pour effectuer une restauration à partir d’un point antérieur dans le temps. RestoreLongTermRetentionBackup : crée une base de données en restaurant à partir d’un coffre de rétention à long terme. recoveryServicesRecoveryPointResourceId doit être spécifié comme ID de ressource du point de récupération. Copy, Secondary et RestoreLongTermRetentionBackup ne sont pas pris en charge pour l’édition DataWarehouse.
properties.creationDate	string	Date de création de la base de données (format ISO8601).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Type de compte de stockage utilisé pour stocker les sauvegardes de cette base de données.
properties.currentServiceObjectiveName	string	Nom actuel de l’objectif de niveau de service de la base de données.
properties.currentSku	Sku	Nom et niveau de la référence SKU.
properties.databaseId	string	ID de la base de données.
properties.defaultSecondaryLocation	string	Région secondaire par défaut pour cette base de données.
properties.earliestRestoreDate	string	Cela enregistre la date et l’heure de début les plus anciennes disponibles pour cette base de données (format ISO8601).
properties.elasticPoolId	string	Identificateur de ressource du pool élastique contenant cette base de données.
properties.failoverGroupId	string	Identificateur de ressource de groupe de basculement auquel appartient cette base de données.
properties.federatedClientId	string	ID client utilisé pour le scénario de clé CMK interlocataire par base de données
properties.highAvailabilityReplicaCount	integer	Nombre de réplicas secondaires associés à la base de données qui sont utilisés pour fournir une haute disponibilité. Non applicable à une base de données Hyperscale au sein d’un pool élastique.
properties.isInfraEncryptionEnabled	boolean	Le chiffrement infra est activé pour cette base de données.
properties.isLedgerOn	boolean	Indique si cette base de données est une base de données de registre, ce qui signifie que toutes les tables de la base de données sont des tables de registre. Remarque : la valeur de cette propriété ne peut pas être modifiée une fois la base de données créée.
properties.licenseType	DatabaseLicenseType	Type de licence à appliquer pour cette base de données. `LicenseIncluded`si vous avez besoin d’une licence, ou `BasePrice` si vous disposez d’une licence et que vous êtes éligible à la Azure Hybrid Benefit.
properties.longTermRetentionBackupResourceId	string	Identificateur de ressource de la sauvegarde de rétention à long terme associée à l’opération de création de cette base de données.
properties.maintenanceConfigurationId	string	ID de configuration de maintenance affecté à la base de données. Cette configuration définit la période pendant laquelle les mises à jour de maintenance se produisent.
properties.maxLogSizeBytes	integer	Taille maximale du journal pour cette base de données.
properties.maxSizeBytes	integer	Taille maximale de la base de données exprimée en octets.
properties.minCapacity	number	Capacité minimale que la base de données aura toujours allouée, si elle n’est pas suspendue
properties.pausedDate	string	Date à laquelle la base de données a été suspendue par la configuration utilisateur ou l’action (format ISO8601). Null si la base de données est prête.
properties.readScale	DatabaseReadScale	État du routage en lecture seule. Si cette option est activée, les connexions dont l’intention d’application est définie sur readonly dans leur chaîne de connexion peuvent être routées vers un réplica secondaire en lecture seule dans la même région. Non applicable à une base de données Hyperscale au sein d’un pool élastique.
properties.recoverableDatabaseId	string	Identificateur de ressource de la base de données récupérable associée à l’opération de création de cette base de données.
properties.recoveryServicesRecoveryPointId	string	Identificateur de ressource du point de récupération associé à l’opération de création de cette base de données.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Type de compte de stockage à utiliser pour stocker les sauvegardes de cette base de données.
properties.requestedServiceObjectiveName	string	Nom de l’objectif de niveau de service demandé de la base de données.
properties.restorableDroppedDatabaseId	string	Identificateur de ressource de la base de données supprimée restaurable associée à l’opération de création de cette base de données.
properties.restorePointInTime	string	Spécifie le point dans le temps (format ISO8601) de la base de données source qui sera restaurée pour créer la nouvelle base de données.
properties.resumedDate	string	Date à laquelle la base de données a été reprise par action utilisateur ou connexion à la base de données (format ISO8601). Null si la base de données est suspendue.
properties.sampleName	SampleName	Nom de l’exemple de schéma à appliquer lors de la création de cette base de données.
properties.secondaryType	SecondaryType	Type secondaire de la base de données s’il s’agit d’une base de données secondaire. Les valeurs valides sont Geo et Named.
properties.sourceDatabaseDeletionDate	string	Spécifie l’heure à laquelle la base de données a été supprimée.
properties.sourceDatabaseId	string	Identificateur de ressource de la base de données source associée à l’opération de création de cette base de données.
properties.sourceResourceId	string	Identificateur de ressource de la source associée à l’opération de création de cette base de données. Cette propriété est uniquement prise en charge pour l’édition DataWarehouse et permet de restaurer entre les abonnements. Lorsque sourceResourceId est spécifié, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId et sourceDatabaseDeletionDate ne doivent pas être spécifiés et CreateMode doit être PointInTimeRestore, Restore ou Recover. Lorsque createMode a la valeur PointInTimeRestore, sourceResourceId doit être l’ID de ressource de la base de données existante ou du pool SQL existant, et restorePointInTime doit être spécifié. Lorsque createMode a la valeur Restore, sourceResourceId doit être l’ID de ressource de la base de données supprimée restaurable ou du pool SQL supprimé pouvant être restauré. Lorsque createMode a la valeur Recover, sourceResourceId doit être l’ID de ressource de la base de données récupérable ou du pool SQL récupérable. Lorsque l’abonnement source appartient à un locataire différent de l’abonnement cible, l’en-tête « x-ms-authorization-auxiliary » doit contenir un jeton d’authentification pour le locataire source. Pour plus d’informations sur l’en-tête « x-ms-authorization-auxiliary », consultez https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status	DatabaseStatus	Statut de la base de données.
properties.zoneRedundant	boolean	Si cette base de données est redondante interzone ou non, les réplicas de cette base de données seront répartis sur plusieurs zones de disponibilité.
sku	Sku	Référence SKU de base de données. La liste des références SKU peut varier selon la région et l’offre de support. Pour déterminer les références SKU (y compris le nom de la référence SKU, le niveau/édition, la famille et la capacité) disponibles pour votre abonnement dans une région Azure, utilisez l’API `Capabilities_ListByLocation` REST ou l’une des commandes suivantes : `az sql db list-editions -l <location> -o table` `Get-AzSqlServerServiceObjective -Location <location>`
tags	object	Balises de ressource.
type	string	Type de ressource.

DatabaseIdentity

Configuration d’identité Azure Active Directory pour une ressource.

Nom	Type	Description
tenantId	string	ID de locataire Azure Active Directory.
type	DatabaseIdentityType	Type d’identité
userAssignedIdentities	<string, DatabaseUserIdentity>	ID de ressource des identités affectées par l’utilisateur à utiliser

DatabaseIdentityType

Type d’identité

Nom	Type	Description
None	string
UserAssigned	string

DatabaseLicenseType

Type de licence à appliquer pour cette base de données. LicenseIncludedsi vous avez besoin d’une licence, ou BasePrice si vous disposez d’une licence et que vous êtes éligible pour le Azure Hybrid Benefit.

Nom	Type	Description
BasePrice	string
LicenseIncluded	string

DatabaseListResult

Liste des bases de données.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	Database[]	Tableau de résultats.

DatabaseReadScale

État du routage en lecture seule. Si cette option est activée, les connexions dont l’intention d’application est définie sur readonly dans leur chaîne de connexion peuvent être routées vers un réplica secondaire en lecture seule dans la même région. Non applicable à une base de données Hyperscale au sein d’un pool élastique.

Nom	Type	Description
Disabled	string
Enabled	string

DatabaseStatus

Statut de la base de données.

Nom	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

Configuration de l’identité Azure Active Directory pour une ressource.

Nom	Type	Description
clientId	string	ID client Azure Active Directory.
principalId	string	ID du principal Azure Active Directory.

SampleName

Nom de l’exemple de schéma à appliquer lors de la création de cette base de données.

Nom	Type	Description
AdventureWorksLT	string
WideWorldImportersFull	string
WideWorldImportersStd	string

SecondaryType

Type secondaire de la base de données s’il s’agit d’une base de données secondaire. Les valeurs valides sont Geo et Named.

Nom	Type	Description
Geo	string
Named	string

Sku

Référence SKU de ressource ARM.

Nom	Type	Description
capacity	integer	Capacité de la référence SKU particulière.
family	string	Si le service a différentes générations de matériel, pour la même référence SKU, cela peut être capturé ici.
name	string	Nom de la référence SKU, généralement une lettre + un code numérique, par exemple P3.
size	string	Taille de la référence SKU particulière
tier	string	Niveau ou édition de la référence SKU particulière, par exemple De base, Premium.

Partager via

Databases - List By Server

Paramètres URI

Réponses

Exemples

Gets a list of databases.

Exemple de requête

Exemple de réponse

Définitions

BackupStorageRedundancy

CatalogCollationType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseLicenseType

DatabaseListResult

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

SampleName

SecondaryType

Sku

Ressources supplémentaires