Elastic Pools - List By Server

Szolgáltatás:

SQL Database

API-verzió:

2025-01-01

Lekéri a kiszolgáló összes rugalmas készletét.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serverName	path	True	string	A kiszolgáló neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.
$skip	query		integer (int64)	A kihagyni kívánt gyűjtemény elemeinek száma.

Válaszok

Name	Típus	Description
200 OK	ElasticPoolListResult	Az Azure működése sikeresen befejeződött.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get all elastic pools in a server

Mintakérelem

HTTP

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

Java

/**
 * Samples for ElasticPools ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ElasticPoolListByServer.json
     */
    /**
     * Sample code: Get all elastic pools in a server.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void getAllElasticPoolsInAServer(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getElasticPools().listByServer("sqlcrudtest-2369", "sqlcrudtest-8069", null,
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python elastic_pool_list_by_server.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.elastic_pools.list_by_server(
        resource_group_name="sqlcrudtest-2369",
        server_name="sqlcrudtest-8069",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/ElasticPoolListByServer.json
if __name__ == "__main__":
    main()

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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets all elastic pools in a server.
 *
 * @summary gets all elastic pools in a server.
 * x-ms-original-file: 2025-01-01/ElasticPoolListByServer.json
 */
async function getAllElasticPoolsInAServer() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.elasticPools.listByServer(
    "sqlcrudtest-2369",
    "sqlcrudtest-8069",
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

dotnet

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
AlwaysEncryptedEnclaveType	Az adatbázisban kért enklávé típusa, azaz alapértelmezett vagy VBS enklávé.
AvailabilityZoneType	Azt a rendelkezésre állási zónát adja meg, amelybe az adatbázis rögzítve van.
createdByType	Az erőforrást létrehozó identitás típusa.
ElasticPool	Rugalmas készlet.
ElasticPoolLicenseType	A rugalmas készletre alkalmazandó licenctípus.
ElasticPoolListResult	Ez az ElasticPool lista művelet válasza.
ElasticPoolPerDatabaseSettings	Rugalmas készlet adatbázis-beállításai szerint.
ElasticPoolState	A rugalmas készlet állapota.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
Sku	ARM-erőforrás termékváltozata.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

AlwaysEncryptedEnclaveType

Felsorolás

Az adatbázisban kért enklávé típusa, azaz alapértelmezett vagy VBS enklávé.

Érték	Description
Default	Alapértelmezett
VBS	VBS

AvailabilityZoneType

Felsorolás

Azt a rendelkezésre állási zónát adja meg, amelybe az adatbázis rögzítve van.

Érték	Description
NoPreference	NoPreference
1	1
2	2
3	3

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ElasticPool

Tárgy

Rugalmas készlet.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Egyfajta rugalmas készlet. Ez az Azure portál élményhez használt metaadat.
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.autoPauseDelay	integer (int32)	A rugalmas készlet automatikus szüneteltetése percek alatt. A -1 értéke azt jelenti, hogy az automatikus szüneteltetés le van tiltva
properties.availabilityZone	AvailabilityZoneType	Megadja azt a rendelkezésre állási zónát, amelybe a készlet elsődleges replikája rögzítve van.
properties.creationDate	string (date-time)	A rugalmas készlet létrehozási dátuma (ISO8601 formátum).
properties.highAvailabilityReplicaCount	integer (int32)	Az üzletileg kritikus, prémium vagy rugalmas skálázású kiadás rugalmas készletéhez társított másodlagos replikák száma, amelyek magas rendelkezésre állást biztosítanak. Csak rugalmas készletekre alkalmazható.
properties.licenseType	ElasticPoolLicenseType	A rugalmas készletre alkalmazandó licenctípus.
properties.maintenanceConfigurationId	string	A rugalmas készlethez rendelt karbantartási konfiguráció azonosítója. Ez a konfiguráció határozza meg azt az időszakot, amikor a karbantartási frissítések bekövetkeznek.
properties.maxSizeBytes	integer (int64)	Az adatbázis rugalmas készletének tárterületkorlátja bájtban.
properties.minCapacity	number (double)	Minimális kapacitás, amely alatt a kiszolgáló nélküli készlet nem zsugorodik, ha nincs szüneteltetve
properties.perDatabaseSettings	ElasticPoolPerDatabaseSettings	A rugalmas készlet adatbázisonkénti beállításai.
properties.preferredEnclaveType	AlwaysEncryptedEnclaveType	A rugalmas készleten kért enklávé típusa.
properties.state	ElasticPoolState	A rugalmas készlet állapota.
properties.zoneRedundant	boolean	Azt jelzi, hogy ez a rugalmas készlet zónaredundáns-e, ami azt jelenti, hogy ennek a rugalmas készletnek a replikái több rendelkezésre állási zónában lesznek elosztva.
sku	Sku	A rugalmas készlet termékváltozata. A termékváltozatok listája régiónként és támogatási ajánlatonként eltérő lehet. Ahhoz, hogy meghatározd azokat a SKU-kat (beleértve a SKU nevet, szintet/kiadást, családot és kapacitást), amelyek elérhetők az előfizetésed számára egy Azure régióban, használd a Capabilities_ListByLocation REST API-t vagy a következő parancsot: az sql elastic-pool list-editions -l <location> -o table
systemData	systemData	Azure Resource Manager metaadat, amely createdBy és modifiedBy információkat tartalmaz.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Például: "Microsoft. Compute/virtualMachines" vagy "Microsoft. Tárhely/tárolásFiókok"

ElasticPoolLicenseType

Felsorolás

A rugalmas készletre alkalmazandó licenctípus.

Érték	Description
LicenseIncluded	LicenceIncluded
BasePrice	BasePrice

ElasticPoolListResult

Tárgy

Ez az ElasticPool lista művelet válasza.

Name	Típus	Description
nextLink	string (uri)	A következő oldalra mutató link
value	ElasticPool[]	Az ElasticPool elemek ezen az oldalon

ElasticPoolPerDatabaseSettings

Tárgy

Rugalmas készlet adatbázis-beállításai szerint.

Name	Típus	Description
autoPauseDelay	integer (int32)	Adatbázisonkénti késleltetés automatikus szüneteltetése a készleten belül
maxCapacity	number (double)	Egy adatbázis maximális kapacitása.
minCapacity	number (double)	Az összes adatbázis minimális kapacitása garantált.

ElasticPoolState

Felsorolás

A rugalmas készlet állapota.

Érték	Description
Creating	Készítés
Ready	Kész
Disabled	Disabled

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

Sku

Tárgy

ARM-erőforrás termékváltozata.

Name	Típus	Description
capacity	integer (int32)	Az adott termékváltozat kapacitása.
family	string	Ha a szolgáltatás különböző hardvergenerációval rendelkezik ugyanahhoz az SKU-hoz, akkor ezt itt rögzítheti.
name	string	Az termékváltozat neve általában egy betű + Szám kód, pl. P3.
size	string	Az adott termékváltozat mérete
tier	string	Az adott termékváltozat szintje vagy kiadása, például Alapszintű, Prémium.

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.