Databases - List By Elastic Pool

Obtient une liste de bases de données dans un pool élastique.

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

Paramètres URI

Name In Required Type Description
elasticPoolName
path True
  • string

Nom du pool élastique.

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.

Réponses

Name Type Description
200 OK

Récupération réussie d’une liste de bases de données dans un pool élastique.

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.

  • 404 CannotFindObject - Impossible de trouver l’objet, car il n’existe pas ou vous n’avez pas d’autorisations

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

  • 404 ServerNotInSubscription : le serveur spécifié n’existe pas sur l’abonnement spécifié.

  • 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà des demandes maximales pouvant être traitées par les ressources disponibles.

  • 429 SubscriptionTooManyRequests : demandes au-delà des demandes maximales pouvant être traitées par les ressources disponibles.

  • 503 TooManyRequests : demandes au-delà des demandes maximales pouvant être traitées par les ressources disponibles.

  • 504 RequestTimeout : la demande de service a dépassé le délai d’expiration autorisé.

Exemples

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

Définitions

BackupStorageRedundancy

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

CatalogCollationType

Classement du catalogue de métadonnées.

CreateMode

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

Valeur par défaut : création normale de la base de données.

Copie : 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 à un point 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.

Restauration : 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é pouvant être restauré et sourceDatabaseDeletionDate est ignoré. restorePointInTime peut également être spécifié pour restaurer à 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

Ressource de base de données.

DatabaseIdentity

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

DatabaseIdentityType

Type d’identité

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 au 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 en lecture seule 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 Géo et Nommées.

Sku

Référence SKU de ressource ARM.

BackupStorageRedundancy

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

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

CatalogCollationType

Classement du catalogue de métadonnées.

Name Type Description
DATABASE_DEFAULT
  • string
SQL_Latin1_General_CP1_CI_AS
  • string

CreateMode

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

Valeur par défaut : création normale de la base de données.

Copie : 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 à un point 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.

Restauration : 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é pouvant être restauré et sourceDatabaseDeletionDate est ignoré. restorePointInTime peut également être spécifié pour restaurer à 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.

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

Database

Ressource de base de données.

Name Type Description
id
  • string

ID de la ressource

identity

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

Classement du catalogue de métadonnées.

properties.collation
  • string

Classement de la base de données.

properties.createMode

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

Valeur par défaut : création normale de la base de données.

Copie : 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 à un point 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.

Restauration : 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é pouvant être restauré et sourceDatabaseDeletionDate est ignoré. restorePointInTime peut également être spécifié pour restaurer à 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

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

properties.currentServiceObjectiveName
  • string

Nom de l’objectif de niveau de service actuel de la base de données.

properties.currentSku

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 CMK entre locataires par base de données

properties.highAvailabilityReplicaCount
  • integer

Nombre de réplicas secondaires associés à la base de données utilisée 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

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 au 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 allouée par la base de données, si elle n’est pas suspendue

properties.pausedDate
  • string

Date à laquelle la base de données a été suspendue par configuration ou action de l’utilisateur (format ISO8601). Null si la base de données est prête.

properties.readScale

État du routage en lecture seule. Si cette option est activée, les connexions dont l’intention d’application est définie en lecture seule 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

Type de compte de stockage à utiliser pour stocker des sauvegardes pour 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 pouvant être restaurée 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é pour créer la nouvelle base de données.

properties.resumedDate
  • string

Date à laquelle la base de données a été reprise par l’action de l’utilisateur ou la connexion à la base de données (format ISO8601). Null si la base de données est suspendue.

properties.sampleName

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

properties.secondaryType

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

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 la restauration entre les abonnements.

Lorsque sourceResourceId est spécifié, sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId et sourceDatabaseDeletionDate ne doivent pas être spécifiés et CreateMode doit être PointInTimeRestore, Restore ou Recover.

Lorsque createMode est 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 est Restore, sourceResourceId doit être l’ID de ressource de la base de données supprimée pouvant être restaurée ou du pool sql supprimé pouvant être restauré.

Lorsque createMode est 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 autre locataire que 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

Statut de la base de données.

properties.zoneRedundant
  • boolean

Indique si cette base de données est redondante interzone, ce qui signifie que les réplicas de cette base de données seront répartis entre plusieurs zones de disponibilité.

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 de l’identité Azure Active Directory pour une ressource.

Name Type Description
tenantId
  • string

ID de locataire Azure Active Directory.

type

Type d’identité

userAssignedIdentities

ID de ressource des identités affectées par l’utilisateur à utiliser

DatabaseIdentityType

Type d’identité

Name 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 au Azure Hybrid Benefit.

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

DatabaseListResult

Liste des bases de données.

Name Type Description
nextLink
  • string

Lien pour récupérer la page suivante des résultats.

value

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 en lecture seule 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.

Name Type Description
Disabled
  • string
Enabled
  • string

DatabaseStatus

Statut de la base de données.

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

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

Name 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.

Name 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 Géo et Nommées.

Name Type Description
Geo
  • string
Named
  • string

Sku

Référence SKU de ressource ARM.

Name Type Description
capacity
  • integer

Capacité de la référence SKU particulière.

family
  • string

Si le service a des générations de matériel différentes, 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 + 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.