Elastic Pools - List By Server

Služba:

SQL Database

Verze rozhraní API:

2025-01-01

Získá všechny elastické fondy na serveru.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
$skip	query		integer (int64)	Počet prvků v kolekci, které chcete přeskočit.

Odpovědi

Name	Typ	Description
200 OK	ElasticPoolListResult	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get all elastic pools in a server

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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"
      }
    }
  ]
}

Definice

Name	Description
AlwaysEncryptedEnclaveType	Typ enklávy požadované v databázi, tj. výchozí enklávy nebo enklávy VBS.
AvailabilityZoneType	Určuje zónu dostupnosti, ke které je databáze připnutá.
createdByType	Typ identity, která prostředek vytvořila.
ElasticPool	Elastický fond.
ElasticPoolLicenseType	Typ licence, který se má použít pro tento elastický fond.
ElasticPoolListResult	Odezva operace seznamu ElasticPool.
ElasticPoolPerDatabaseSettings	Nastavení elastického fondu na databázi
ElasticPoolState	Stav elastického fondu.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
Sku	Skladová položka prostředku ARM.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AlwaysEncryptedEnclaveType

Výčet

Typ enklávy požadované v databázi, tj. výchozí enklávy nebo enklávy VBS.

Hodnota	Description
Default	Výchozí
VBS	VBS

AvailabilityZoneType

Výčet

Určuje zónu dostupnosti, ke které je databáze připnutá.

Hodnota	Description
NoPreference	NoPreference
1	1
2	2
3	3

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ElasticPool

Objekt

Elastický fond.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Druh elastického fondu. Toto jsou metadata používaná pro Azure portálový zážitek.
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.autoPauseDelay	integer (int32)	Doba v minutách, po které se elastický fond automaticky pozastaví. Hodnota -1 znamená, že automatické pozastavení je zakázané.
properties.availabilityZone	AvailabilityZoneType	Určuje zónu dostupnosti, ke které je primární replika fondu připnutá.
properties.creationDate	string (date-time)	Datum vytvoření elastického fondu (formát ISO8601).
properties.highAvailabilityReplicaCount	integer (int32)	Počet sekundárních replik přidružených k elastickému fondu edice Pro důležité obchodní informace, Premium nebo Hyperscale, které slouží k zajištění vysoké dostupnosti. Platí pouze pro elastické fondy Hyperscale.
properties.licenseType	ElasticPoolLicenseType	Typ licence, který se má použít pro tento elastický fond.
properties.maintenanceConfigurationId	string	ID konfigurace údržby přiřazené elastickému fondu Tato konfigurace definuje období, kdy dojde k aktualizacím údržby.
properties.maxSizeBytes	integer (int64)	Limit úložiště pro elastický fond databáze v bajtech.
properties.minCapacity	number (double)	Minimální kapacita bezserverového fondu se nezmenší níže, pokud není pozastavena
properties.perDatabaseSettings	ElasticPoolPerDatabaseSettings	Nastavení jednotlivých databází pro elastický fond.
properties.preferredEnclaveType	AlwaysEncryptedEnclaveType	Typ enklávy požadovaný v elastickém fondu
properties.state	ElasticPoolState	Stav elastického fondu.
properties.zoneRedundant	boolean	Bez ohledu na to, jestli je tento elastický fond zónově redundantní, což znamená, že repliky tohoto elastického fondu budou rozloženy do několika zón dostupnosti.
sku	Sku	Skladová položka elastického fondu. Seznam skladových položek se může lišit podle oblasti a nabídky podpory. Pro určení SKU (včetně názvu SKU, úrovně/edice, rodiny a kapacity), které jsou dostupné vašemu předplatnému v Azure regionu, použijte REST API Capabilities_ListByLocation nebo následující příkaz: az sql elastic-pool list-editions -l <location> -o table
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
tags	object	Značky prostředků
type	string	Typ prostředku. Například "Microsoft. Compute/virtualMachines" nebo "Microsoft. Úložiště/úložištěÚčty"

ElasticPoolLicenseType

Výčet

Typ licence, který se má použít pro tento elastický fond.

Hodnota	Description
LicenseIncluded	LicenceZahrnuto
BasePrice	BasePrice

ElasticPoolListResult

Objekt

Odezva operace seznamu ElasticPool.

Name	Typ	Description
nextLink	string (uri)	Odkaz na další stránku položek
value	ElasticPool[]	Položky ElasticPool na této stránce

ElasticPoolPerDatabaseSettings

Objekt

Nastavení elastického fondu na databázi

Name	Typ	Description
autoPauseDelay	integer (int32)	Zpoždění automatického pozastavení pro každou databázi v rámci fondu
maxCapacity	number (double)	Maximální kapacita může spotřebovávat libovolná databáze.
minCapacity	number (double)	Minimální kapacita je zaručená pro všechny databáze.

ElasticPoolState

Výčet

Stav elastického fondu.

Hodnota	Description
Creating	Vytváření
Ready	Ready
Disabled	Disabled

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Sku

Objekt

Skladová položka prostředku ARM.

Name	Typ	Description
capacity	integer (int32)	Kapacita konkrétní skladové položky.
family	string	Pokud má služba různé generace hardwaru, pro stejnou skladovou položku, můžete ji zde zachytit.
name	string	Název skladové položky, obvykle písmeno + číslo, např. P3.
size	string	Velikost konkrétní skladové položky
tier	string	Úroveň nebo edice konkrétní skladové položky, např. Basic, Premium.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.