Elastic Pools - Get

Service:

SQL Database

Version d'API:

2021-11-01

Obtenir un pool élastique.

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

Paramètres URI

Nom	Dans	Obligatoire	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

Nom	Type	Description
200 OK	ElasticPool	Opération réussie
Other Status Codes		Réponses d’erreur : *** 400 ElasticPoolOverStorageUsage : tentative d’écriture de données dans une base de données lorsque la limite de stockage du pool élastique a été atteinte. 400 InvalidSku : l’utilisateur a spécifié une référence SKU non valide. 400 InvalidTierSkuCombination : le niveau spécifié ne prend pas en charge la référence SKU spécifiée. 400 ServerQuotaExceeded : le serveur a atteint sa limite pour l’unité de débit de base de données autorisée. 400 ElasticPoolAlreadyExists : le serveur contient déjà un pool élastique avec le nom spécifié. 400 SubscriptionVcoreQuotaExceeded : impossible d’effectuer l’opération, car l’abonnement dépasserait le quota de vCore autorisé. 400 InvalidInputValueForEdition : l’édition spécifiée n’est pas prise en charge pour l’approvisionnement de pool élastique. 400 ElasticPoolDtuBelowLimit : la valeur DTU demandée est trop faible pour le niveau de service du pool élastique demandé. 400 ElasticPoolDtuAboveLimit : la valeur DTU demandée est trop élevée pour le niveau de service du pool élastique demandé. 400 InvalidMaxSize : taille maximale non valide. 400 ElasticPoolDbDtuMaxBelowLimit : le nombre maximal de DTU demandé par base de données est trop faible pour le niveau de service du pool élastique demandé. 400 ElasticPoolDbDtuMaxAboveLimit : le nombre maximal de DTU demandé par base de données est trop élevé pour le niveau de service du pool élastique demandé. 400 InvalidInputValueForDatabaseDtuMax : tentative de définir le nombre maximal de DTU par base de données pour le pool de ressources qui ne correspond pas aux valeurs autorisées. 400 ElasticPoolDbDtuMinAboveLimit : le nombre minimal de DTU demandé par base de données est trop élevé pour le niveau de service demandé. 400 ElasticPoolOverStorage : tentative d’écriture de données dans une base de données lorsque la limite de stockage du pool élastique a été atteinte. 400 InvalidInputValueForDatabaseDtuMin : tentative de définir le nombre minimal de DTU par base de données pour le pool de ressources qui ne correspond pas aux valeurs autorisées. 400 ElasticPoolInconsistentDtuGuaranteeSettings : tentative de fournir des DTU min pour les bases de données du pool élastique qui dépassent les DTU demandées du pool élastique. 400 ElasticPoolDtuUnsupported : l’utilisateur a tenté de créer ou de mettre à jour un pool élastique avec une capacité DTU qui n’est pas prise en charge. 400 ElasticPoolStorageAboveLimitGB : tentative de définir la limite de stockage du pool élastique sous la limite prise en charge. 400 ElasticPoolsNotEnabled : les pools élastiques n’ont pas été activés dans cette région. 400 ElasticPoolNotEmpty : demande de suppression d’un pool élastique qui n’est pas vide. 400 ElasticPoolStorageBelowLimitGB : tentative de définir la limite de stockage du pool élastique en dessous de la limite prise en charge. 400 ElasticPoolStorageNotAllowedGB : tentative de définir la limite de stockage du pool élastique en go qui ne correspond pas aux valeurs autorisées. 400 ElasticPoolDatabaseLimit : le pool élastique a atteint sa limite pour le nombre de bases de données. 400 ElasticPoolDecreaseStorageLimitBelowUsage : tentative de réduction de la limite de stockage du pool élastique sous son utilisation du stockage. 400 InvalidInputValueDatabaseDtuMinLargerThanMax : tentative de définir le nombre minimal de DTU par base de données supérieur au nombre maximal de DTU par base de données. 400 ElasticPoolInconsistentVcoreGuaranteeSettings : le nombre de bases de données et de VCore min par base de données ne peut pas dépasser les VCores demandés du pool élastique. 400 ElasticPoolStorageBelowLimitMB : tentative de définir la limite de stockage du pool élastique en dessous de la limite prise en charge. 400 ElasticPoolStorageNotAllowedMB : tentative de définir la limite de stockage du pool élastique en mo qui ne correspond pas aux valeurs autorisées. 400 ElasticPoolCapacityStorageNotAllowedMB : tentative de définir la limite de stockage du pool élastique en mo qui ne correspond pas aux valeurs autorisées. 400 ElasticPoolStorageAboveLimitMB : tentative de définir la limite de stockage du pool élastique en dessous de la limite prise en charge. 400 RegionDoesNotSupportVersion : un utilisateur a tenté de créer un serveur d’une version spécifiée à un emplacement où cette version de serveur n’est pas prise en charge. 400 InvalidTier : l’utilisateur a spécifié un niveau non valide. 400 SourceDatabaseEditionCouldNotBeUpgraded : la base de données source ne peut pas avoir d’édition supérieure à la base de données cible. 400 TargetDatabaseEditionCouldNotBeDowngraded : la base de données cible ne peut pas avoir d’édition inférieure à la base de données source. 400 ElasticPoolUpdateHkNotAllowed : le pool élastique ne peut pas abaisser son niveau de service de Premium à Standard ou De base, car une ou plusieurs de ses bases de données utilisent des objets mémoire optimisés. 400 UpdateNotAllowedIfGeoDrOperationInProgress : l’opération n’est pas autorisée, car l’opération de copie ou de basculement de la base de données «{0} » sur le serveur «{1} » est en cours. 400 RegionDoesNotAllowProvisioning : l’emplacement sélectionné n’accepte pas les nouveaux serveurs Windows Azure SQL Database. Cela peut changer ultérieurement. 400 ElasticPoolOverFileSpace : espace de fichier insuffisant dans le pool élastique. 400 ElasticPoolDbDtuMinBelowLimit : la valeur minimale DTU demandée par base de données est trop faible pour le niveau de service du pool élastique demandé. 400 ElasticPoolDbVcoreMaxBelowLimit : la valeur maximale de VCore demandée par base de données est trop faible pour le niveau de service du pool élastique demandé. 400 ElasticPoolDbVcoreMaxAboveLimit : la valeur maximale de VCore demandée par base de données est trop élevée pour le niveau de service du pool élastique demandé. 400 InvalidInputValueForDatabaseVcoreMax : tentative de définir la valeur maximale VCore par base de données pour le pool de ressources qui ne correspond pas aux valeurs autorisées. 400 ElasticPoolDbVcoreMinBelowLimit : la valeur minimale VCore demandée par base de données est trop faible pour le niveau de service du pool élastique demandé. 400 InvalidInputValueForDatabaseVcoreMin : tentative de définir le nombre minimal de VCore par base de données pour le pool de ressources qui ne correspond pas aux valeurs autorisées. 400 PartnerDBNotCompatibleForSGXEnclave : la tentative de définition d’une liaison GeoDR ou de mise à jour du SLO pour une base de données avec enclave n’est prise en charge que lorsque les deux bases de données s’exécutent sur du matériel de série DC. 400 InvalidInputValueDatabaseVcoreMinLargerThanMax : tentative de définir la valeur minimale VCore par base de données supérieure à la valeur maximale VCore par base de données. 400 InvalidLicenseType : l’utilisateur a essayé de créer ou de mettre à jour une base de données ou un pool élastique avec un type de licence non pris en charge. 400 ProvisioningDisabled : affiche le message d’erreur de l’autoriseur d’opération de ressources tel qu’il est, sans modification 400 InvalidPublicMaintenanceConfiguration : l’utilisateur a essayé de spécifier une configuration de maintenance publique qui ne peut pas être convertie en id interne (région incorrecte ou incorrecte). 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 ElasticPoolNotFound : le pool élastique spécifié n’existe pas pour le serveur spécifié. 404 OperationIdNotFound : l’opération avec ID n’existe pas. 404 ResourceNotFound : la ressource demandée est introuvable. 405 Non pris en charge : cette fonctionnalité n’est pas prise en charge. 409 ElasticPoolBusy : une opération de gestion a été tentée sur un pool élastique occupé. 409 ServerDisabled : le serveur est désactivé. 409 SimultaneousSkuChangeNotAllowed : les opérations de modification d’objectif de service ne peuvent pas s’exécuter simultanément sur les deux bases de données d’une relation de réplication. 409 ElasticPoolUpdateLinksNotInCatchup : impossible de mettre à jour le pool élastique pendant que l’une de ses bases de données effectue une opération de basculement de copie ou de géoréplication. 409 OperationCancelled : l’opération a été annulée par l’utilisateur. 409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 500 ElasticPoolFailedMoveDbToElasticPool : échec du déplacement de la base de données dans le pool élastique en raison de contraintes de ressources internes. Il peut s’agir d’une condition temporaire. Veuillez réessayer. 500 OperationTimedOut : l’opération a expiré et a été automatiquement restaurée. Réessayez l’opération. 503 ServiceTemporarilyUnavailable - Fonctionnalité temporairement indisponible. 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Exemples

Get a Hyperscale elastic pool

Get an elastic pool

Get a Hyperscale elastic pool

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102?api-version=2021-11-01

Java

/**
 * Samples for ElasticPools Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/HyperscaleElasticPoolGet.json
     */
    /**
     * Sample code: Get a Hyperscale elastic pool.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAHyperscaleElasticPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getElasticPools().getWithResponse("sqlcrudtest-2369",
            "sqlcrudtest-8069", "sqlcrudtest-8102", 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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "location": "Japan East",
  "kind": "vcore,pool",
  "sku": {
    "name": "HS_Gen5",
    "tier": "Hyperscale",
    "family": "Gen5",
    "capacity": 4
  },
  "properties": {
    "state": "Ready",
    "creationDate": "2021-08-26T03:46:20.57Z",
    "maxSizeBytes": 0,
    "perDatabaseSettings": {
      "minCapacity": 0,
      "maxCapacity": 4
    },
    "zoneRedundant": false,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default",
    "highAvailabilityReplicaCount": 2
  }
}

Get an elastic pool

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102?api-version=2021-11-01

Java

/**
 * Samples for ElasticPools Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ElasticPoolGet.json
     */
    /**
     * Sample code: Get an elastic pool.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAnElasticPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getElasticPools().getWithResponse("sqlcrudtest-2369",
            "sqlcrudtest-8069", "sqlcrudtest-8102", 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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "location": "Japan East",
  "kind": null,
  "sku": {
    "name": "GP_Gen5_2",
    "tier": "GeneralPurpose",
    "capacity": 2
  },
  "properties": {
    "creationDate": "2017-10-10T01:25:25.033Z",
    "state": "Ready",
    "maxSizeBytes": 5242880000,
    "perDatabaseSettings": {
      "minCapacity": 0.25,
      "maxCapacity": 1
    },
    "zoneRedundant": true,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_1"
  }
}

Définitions

Nom	Description
ElasticPool	Un pool élastique.
ElasticPoolLicenseType	Type de licence à appliquer pour ce pool élastique.
ElasticPoolPerDatabaseSettings	Paramètres par base de données d’un pool élastique.
ElasticPoolState	État du pool élastique.
Sku	Référence SKU de ressource ARM.

ElasticPool

Un pool élastique.

Nom	Type	Description
id	string	ID de la ressource
kind	string	Type de pool élastique. Il s’agit des métadonnées utilisées pour l’expérience Portail Azure.
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.creationDate	string	Date de création du pool élastique (format ISO8601).
properties.highAvailabilityReplicaCount	integer	Nombre de réplicas secondaires associés au pool élastique utilisés pour fournir une haute disponibilité. Applicable uniquement aux pools élastiques Hyperscale.
properties.licenseType	ElasticPoolLicenseType	Type de licence à appliquer pour ce pool élastique.
properties.maintenanceConfigurationId	string	ID de configuration de maintenance attribué au pool élastique. Cette configuration définit la période pendant laquelle les mises à jour de maintenance se produisent.
properties.maxSizeBytes	integer	Limite de stockage du pool élastique de base de données en octets.
properties.minCapacity	number	Capacité minimale que le pool serverless ne réduit pas en dessous, s’il n’est pas suspendu
properties.perDatabaseSettings	ElasticPoolPerDatabaseSettings	Paramètres par base de données pour le pool élastique.
properties.state	ElasticPoolState	État du pool élastique.
properties.zoneRedundant	boolean	Si ce pool élastique est redondant interzone ou non, les réplicas de ce pool élastique seront répartis sur plusieurs zones de disponibilité.
sku	Sku	Référence SKU du pool élastique. 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 la commande suivante : az sql elastic-pool list-editions -l <location> -o table
tags	object	Balises de ressource.
type	string	Type de ressource.

ElasticPoolLicenseType

Type de licence à appliquer pour ce pool élastique.

Nom	Type	Description
BasePrice	string
LicenseIncluded	string

ElasticPoolPerDatabaseSettings

Paramètres par base de données d’un pool élastique.

Nom	Type	Description
maxCapacity	number	Capacité maximale qu’une base de données peut consommer.
minCapacity	number	La capacité minimale de toutes les bases de données est garantie.

ElasticPoolState

État du pool élastique.

Nom	Type	Description
Creating	string
Disabled	string
Ready	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.