Elastic Pools - Get

Service:: SQL Database

Version d'API:: 2025-01-01

Obtenir un pool élastique.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
elasticPoolName	path	True	string	Nom du pool élastique.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ElasticPool	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get a Hyperscale elastic pool

Get an elastic pool

Get an elastic pool with Availability Zone

Get an elastic pool with preferred enclave type parameter

Get an elastic pool with serverless properties

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=2025-01-01

Exemple de réponse

Code d’état:: 200

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

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=2025-01-01

Exemple de réponse

Code d’état:: 200

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

Get an elastic pool with Availability Zone

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=2025-01-01

Exemple de réponse

Code d’état:: 200

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

Get an elastic pool with preferred enclave type parameter

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=2025-01-01

Exemple de réponse

Code d’état:: 200

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

Get an elastic pool with serverless properties

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=2025-01-01

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
AlwaysEncryptedEnclaveType	Type d’enclave demandé sur la base de données, c’est-à-dire les enclaves par défaut ou VBS.
AvailabilityZoneType	Spécifie la zone de disponibilité à laquelle la base de données est épinglée.
createdByType	Type d’identité qui a créé la ressource.
ElasticPool	Un pool élastique.
ElasticPoolLicenseType	Type de licence à appliquer pour ce pool élastique.
ElasticPoolPerDatabaseSettings	Par paramètres de base de données d’un pool élastique.
ElasticPoolState	État du pool élastique.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
Sku	Référence SKU de ressource ARM.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AlwaysEncryptedEnclaveType

Énumération

Type d’enclave demandé sur la base de données, c’est-à-dire les enclaves par défaut ou VBS.

Valeur	Description
Default	Par défaut
VBS	VBS

AvailabilityZoneType

Énumération

Spécifie la zone de disponibilité à laquelle la base de données est épinglée.

Valeur	Description
NoPreference	Sans préférence
1	1
2	2
3	3

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ElasticPool

Objet

Un pool élastique.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
kind	string	Type de pool élastique. Ce sont des métadonnées utilisées pour l’expérience du portail Azure.
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.autoPauseDelay	integer (int32)	Durée en minutes après laquelle le pool élastique est automatiquement suspendu. Une valeur de -1 signifie que la pause automatique est désactivée
properties.availabilityZone	AvailabilityZoneType	Spécifie la zone de disponibilité vers laquelle le réplica principal du pool est épinglé.
properties.creationDate	string (date-time)	Date de création du pool élastique (format ISO8601).
properties.highAvailabilityReplicaCount	integer (int32)	Nombre de réplicas secondaires associés au pool élastique Critique pour l’entreprise, Premium ou Hyperscale qui sont 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 affecté au pool élastique. Cette configuration définit la période pendant laquelle les mises à jour de maintenance se produisent.
properties.maxSizeBytes	integer (int64)	Limite de stockage du pool élastique de base de données en octets.
properties.minCapacity	number (double)	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.preferredEnclaveType	AlwaysEncryptedEnclaveType	Type d’enclave demandé sur le pool élastique.
properties.state	ElasticPoolState	État du pool élastique.
properties.zoneRedundant	boolean	Indique si ce pool élastique est redondant interzone, ce qui signifie que les réplicas de ce pool élastique sont répartis entre 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 SKU (y compris le nom du SKU, le niveau/édition, la famille et la capacité) disponibles pour votre abonnement dans une région Azure, utilisez l’API REST `Capabilities_ListByLocation` ou la commande suivante : `az sql elastic-pool list-editions -l <location> -o table`
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

ElasticPoolLicenseType

Énumération

Type de licence à appliquer pour ce pool élastique.

Valeur	Description
LicenseIncluded	LicenceInclus
BasePrice	BasePrice

ElasticPoolPerDatabaseSettings

Objet

Par paramètres de base de données d’un pool élastique.

Nom	Type	Description
autoPauseDelay	integer (int32)	Délai de pause automatique pour chaque base de données dans le pool
maxCapacity	number (double)	Capacité maximale qu’une base de données peut consommer.
minCapacity	number (double)	La capacité minimale de toutes les bases de données est garantie.

ElasticPoolState

Énumération

État du pool élastique.

Valeur	Description
Creating	Création
Ready	Prêt
Disabled	Désactivé

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

Sku

Objet

Référence SKU de ressource ARM.

Nom	Type	Description
capacity	integer (int32)	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, vous pouvez le capturer 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.

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.