Elastic Pools - List By Server

Service:: SQL Database

API-versie:: 2025-01-01

Hiermee haalt u alle elastische pools op een server op.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
$skip	query		integer (int64)	Het aantal elementen in de verzameling dat moet worden overgeslagen.

Antwoorden

Name	Type	Description
200 OK	ElasticPoolListResult	Azure-operatie succesvol voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Get all elastic pools in a server

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ElasticPoolListByServer.json
// this example is just showing the usage of "ElasticPools_ListByServer" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-2369";
string serverName = "sqlcrudtest-8069";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this ElasticPoolResource
ElasticPoolCollection collection = sqlServer.GetElasticPools();

// invoke the operation and iterate over the result
await foreach (ElasticPoolResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ElasticPoolData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "name": "sqlcrudtest-2729",
      "type": "Microsoft.Sql/servers/elasticPools",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-2729",
      "kind": null,
      "location": "Japan East",
      "properties": {
        "creationDate": "2017-02-10T01:27:21.32Z",
        "licenseType": "LicenseIncluded",
        "maxSizeBytes": 5242880000,
        "perDatabaseSettings": {
          "maxCapacity": 1,
          "minCapacity": 0.25
        },
        "state": "Ready",
        "zoneRedundant": true
      },
      "sku": {
        "name": "GP_Gen4_2",
        "capacity": 2,
        "tier": "GeneralPurpose"
      }
    },
    {
      "name": "sqlcrudtest-3191",
      "type": "Microsoft.Sql/servers/elasticPools",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-3191",
      "kind": null,
      "location": "Japan East",
      "properties": {
        "creationDate": "2017-02-10T01:26:26.45Z",
        "maxSizeBytes": 5242880000,
        "perDatabaseSettings": {
          "maxCapacity": 5,
          "minCapacity": 0
        },
        "state": "Ready"
      },
      "sku": {
        "name": "BasicPool",
        "capacity": 50,
        "tier": "Basic"
      }
    },
    {
      "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-02-10T01:25:25.033Z",
        "maxSizeBytes": 5242880000,
        "perDatabaseSettings": {
          "maxCapacity": 5,
          "minCapacity": 0
        },
        "state": "Ready"
      },
      "sku": {
        "name": "BasicPool",
        "capacity": 50,
        "tier": "Basic"
      }
    }
  ]
}

Definities

Name	Description
AlwaysEncryptedEnclaveType	Het type enclave dat is aangevraagd voor de database, bijvoorbeeld standaard- of VBS-enclaves.
AvailabilityZoneType	Hiermee geeft u de beschikbaarheidszone op waaraan de database is vastgemaakt.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ElasticPool	Een elastische pool.
ElasticPoolLicenseType	Het licentietype dat moet worden toegepast op deze elastische pool.
ElasticPoolListResult	De respons van een ElasticPool-lijstoperatie.
ElasticPoolPerDatabaseSettings	Per database-instellingen van een elastische pool.
ElasticPoolState	De status van de elastische pool.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
Sku	Een ARM-resource-SKU.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

AlwaysEncryptedEnclaveType

Opsomming

Het type enclave dat is aangevraagd voor de database, bijvoorbeeld standaard- of VBS-enclaves.

Waarde	Description
Default	Verstek
VBS	VBS

AvailabilityZoneType

Opsomming

Hiermee geeft u de beschikbaarheidszone op waaraan de database is vastgemaakt.

Waarde	Description
NoPreference	NoPreference
1	1
2	2
3	3

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

ElasticPool

Object

Een elastische pool.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
kind	string	Soort elastische pool. Dit is metadata die wordt gebruikt voor de Azure-portaalervaring.
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.autoPauseDelay	integer (int32)	Tijd in minuten waarna elastische pool automatisch wordt onderbroken. Een waarde van -1 betekent dat automatische pauze is uitgeschakeld
properties.availabilityZone	AvailabilityZoneType	Hiermee geeft u de beschikbaarheidszone op waaraan de primaire replica van de pool is vastgemaakt.
properties.creationDate	string (date-time)	De aanmaakdatum van de elastische pool (ISO8601-indeling).
properties.highAvailabilityReplicaCount	integer (int32)	Het aantal secundaire replica's dat is gekoppeld aan de elastische pool Bedrijfskritiek, Premium of Hyperscale-editie die wordt gebruikt om hoge beschikbaarheid te bieden. Alleen van toepassing op elastische Hyperscale-pools.
properties.licenseType	ElasticPoolLicenseType	Het licentietype dat moet worden toegepast op deze elastische pool.
properties.maintenanceConfigurationId	string	Onderhoudsconfiguratie-id die is toegewezen aan de elastische pool. Met deze configuratie wordt de periode gedefinieerd waarop de onderhoudsupdates plaatsvinden.
properties.maxSizeBytes	integer (int64)	De opslaglimiet voor de elastische pool van de database in bytes.
properties.minCapacity	number (double)	Minimale capaciteit die de serverloze pool hieronder niet verkleint, indien niet onderbroken
properties.perDatabaseSettings	ElasticPoolPerDatabaseSettings	De instellingen per database voor de elastische pool.
properties.preferredEnclaveType	AlwaysEncryptedEnclaveType	Het type enclave dat is aangevraagd voor de elastische pool.
properties.state	ElasticPoolState	De status van de elastische pool.
properties.zoneRedundant	boolean	Of deze elastische pool zone-redundant is, wat betekent dat de replica's van deze elastische pool worden verdeeld over meerdere beschikbaarheidszones.
sku	Sku	De SKU voor elastische pools. De lijst met SKU's kan variëren per regio en ondersteuningsaanbieding. Om de SKU's (inclusief de SKU-naam, tier/editie, familie en capaciteit) te bepalen die beschikbaar zijn voor je abonnement in een Azure regio, gebruik je de `Capabilities_ListByLocation` REST API of het volgende commando: `az sql elastic-pool list-editions -l <location> -o table`
systemData	systemData	Azure Resource Manager metadata met creationBy en modifiedBy informatie.
tags	object	Resourcetags.
type	string	Het type bron. Bijvoorbeeld: "Microsoft. Compute/virtualMachines" of "Microsoft. Opslag/opslagAccounts"

ElasticPoolLicenseType

Opsomming

Het licentietype dat moet worden toegepast op deze elastische pool.

Waarde	Description
LicenseIncluded	LicentieInbegrepen
BasePrice	BasePrice

ElasticPoolListResult

Object

De respons van een ElasticPool-lijstoperatie.

Name	Type	Description
nextLink	string (uri)	De koppeling naar de volgende pagina met items
value	ElasticPool[]	De ElasticPool-items op deze pagina

ElasticPoolPerDatabaseSettings

Object

Per database-instellingen van een elastische pool.

Name	Type	Description
autoPauseDelay	integer (int32)	Vertraging automatisch onderbreken voor per database binnen de pool
maxCapacity	number (double)	De maximale capaciteit die elke database kan verbruiken.
minCapacity	number (double)	De minimale capaciteit voor alle databases is gegarandeerd.

ElasticPoolState

Opsomming

De status van de elastische pool.

Waarde	Description
Creating	Creëren
Ready	Klaar
Disabled	Disabled

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoelwit.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

Sku

Object

Een ARM-resource-SKU.

Name	Type	Description
capacity	integer (int32)	Capaciteit van de specifieke SKU.
family	string	Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan die hier worden vastgelegd.
name	string	De naam van de SKU, meestal een letter + cijfercode, bijvoorbeeld P3.
size	string	Grootte van de specifieke SKU
tier	string	De laag of editie van de specifieke SKU, bijvoorbeeld Basic, Premium.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.