Elastic Pools - Get

Dienst:: SQL Database

API-Version:: 2025-01-01

Ruft einen elastischen Datenbankpool ab

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
elasticPoolName	path	True	string	Der Name des elastischen Pools.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ElasticPool	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
AlwaysEncryptedEnclaveType	Typ der in der Datenbank angeforderten Enklave, d. h. Standard- oder VBS-Enklaven.
AvailabilityZoneType	Gibt die Verfügbarkeitszone an, an die die Datenbank angeheftet ist.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ElasticPool	Ein elastischer Pool.
ElasticPoolLicenseType	Der Lizenztyp, der für diesen elastischen Pool gilt.
ElasticPoolPerDatabaseSettings	Pro Datenbankeinstellungen eines elastischen Pools.
ElasticPoolState	Der Zustand des elastischen Pools.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
Sku	Eine ARM-Ressourcen-SKU.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AlwaysEncryptedEnclaveType

Enumeration

Typ der in der Datenbank angeforderten Enklave, d. h. Standard- oder VBS-Enklaven.

Wert	Beschreibung
Default	Vorgabe
VBS	VBS

AvailabilityZoneType

Enumeration

Gibt die Verfügbarkeitszone an, an die die Datenbank angeheftet ist.

Wert	Beschreibung
NoPreference	Keine Präferenz
1	1
2	2
3	3

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ElasticPool

Objekt

Ein elastischer Pool.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Art des elastischen Pools. Dies sind Metadaten, die für das Azure-Portal-Erlebnis verwendet werden.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.autoPauseDelay	integer (int32)	Die Zeit in Minuten, nach der der elastische Pool automatisch angehalten wird. Ein Wert von -1 bedeutet, dass die automatische Pause deaktiviert ist.
properties.availabilityZone	AvailabilityZoneType	Gibt die Verfügbarkeitszone an, an die das primäre Replikat des Pools angeheftet ist.
properties.creationDate	string (date-time)	Das Erstellungsdatum des elastischen Pools (ISO8601 Format).
properties.highAvailabilityReplicaCount	integer (int32)	Die Anzahl der sekundären Replikate, die dem elastischen Business Critical-, Premium- oder Hyperscale Edition-Pool zugeordnet sind, der verwendet wird, um hohe Verfügbarkeit bereitzustellen. Gilt nur für hyperskalenlastische Pools.
properties.licenseType	ElasticPoolLicenseType	Der Lizenztyp, der für diesen elastischen Pool gilt.
properties.maintenanceConfigurationId	string	Die Wartungskonfigurations-ID, die dem elastischen Pool zugewiesen ist. Diese Konfiguration definiert den Zeitraum, in dem die Wartungsupdates auftreten.
properties.maxSizeBytes	integer (int64)	Der Speichergrenzwert für den datenbanklastischen Pool in Byte.
properties.minCapacity	number (double)	Minimale Kapazität, die serverlose Pools nicht verkleinern, wenn nicht angehalten
properties.perDatabaseSettings	ElasticPoolPerDatabaseSettings	Die Einstellungen pro Datenbank für den elastischen Pool.
properties.preferredEnclaveType	AlwaysEncryptedEnclaveType	Typ der Enklave auf dem elastischen Pool angefordert.
properties.state	ElasticPoolState	Der Zustand des elastischen Pools.
properties.zoneRedundant	boolean	Unabhängig davon, ob dieser elastische Pool zonenredundant ist, bedeutet dies, dass die Replikate dieses elastischen Pools über mehrere Verfügbarkeitszonen verteilt werden.
sku	Sku	Die SKU des elastischen Pools. Die Liste der SKUs kann je nach Region und Supportangebot variieren. Um die SKUs (einschließlich SKU-Name, Tier/Edition, Familie und Kapazität) zu bestimmen, die Ihrem Abonnement in einer Azure Region zur Verfügung stehen, verwenden Sie die `Capabilities_ListByLocation` REST API oder den folgenden Befehl: `az sql elastic-pool list-editions -l <location> -o table`
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

ElasticPoolLicenseType

Enumeration

Der Lizenztyp, der für diesen elastischen Pool gilt.

Wert	Beschreibung
LicenseIncluded	LizenzEnthaltene Lizenz
BasePrice	BasePrice

ElasticPoolPerDatabaseSettings

Objekt

Pro Datenbankeinstellungen eines elastischen Pools.

Name	Typ	Beschreibung
autoPauseDelay	integer (int32)	Automatische Pausenverzögerung pro Datenbank innerhalb des Pools
maxCapacity	number (double)	Die maximale Kapazität jeder Datenbank kann verbrauchen.
minCapacity	number (double)	Die Mindestkapazität aller Datenbanken ist gewährleistet.

ElasticPoolState

Enumeration

Der Zustand des elastischen Pools.

Wert	Beschreibung
Creating	Erstellen
Ready	Bereit
Disabled	Deaktiviert

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Sku

Objekt

Eine ARM-Ressourcen-SKU.

Name	Typ	Beschreibung
capacity	integer (int32)	Kapazität der jeweiligen SKU.
family	string	Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden.
name	string	Der Name der SKU, in der Regel ein Buchstabe + Zahlencode, z. B. P3.
size	string	Größe der jeweiligen SKU
tier	string	Die Stufe oder Edition der jeweiligen SKU, z. B. Basic, Premium.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Elastic Pools - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Get a Hyperscale elastic pool

Beispielanforderung

Beispiel für eine Antwort

Get an elastic pool

Beispielanforderung

Beispiel für eine Antwort

Get an elastic pool with Availability Zone

Beispielanforderung

Beispiel für eine Antwort

Get an elastic pool with preferred enclave type parameter

Beispielanforderung

Beispiel für eine Antwort

Get an elastic pool with serverless properties

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AlwaysEncryptedEnclaveType

AvailabilityZoneType

createdByType

ElasticPool

ElasticPoolLicenseType

ElasticPoolPerDatabaseSettings

ElasticPoolState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

systemData