Instance Pools - List

Usługa:: SQL Database

Wersja interfejsu API:: 2025-01-01

Pobiera listę wszystkich pul wystąpień w subskrypcji.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/instancePools?api-version=2025-01-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	InstancePoolListResult	Operacja Azure zakończyła się pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List instance pools in the subscription

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/instancePools?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.Resources;
using Azure.ResourceManager.Resources.Models;
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/ListInstancePoolsBySubscriptionId.json
// this example is just showing the usage of "InstancePools_List" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (InstancePoolResource item in subscriptionResource.GetInstancePoolsAsync())
{
    // 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
    InstancePoolData 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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "name": "testIP",
      "type": "Microsoft.Sql/instancePools",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP",
      "location": "japaneast",
      "properties": {
        "dnsZone": "1234567890",
        "licenseType": "LicenseIncluded",
        "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetwork/myvnet/subnets/mysubnet1",
        "vCores": 8
      },
      "sku": {
        "name": "GP_Gen5",
        "family": "Gen5",
        "tier": "GeneralPurpose"
      },
      "tags": {
        "a": "b"
      }
    },
    {
      "name": "testIP2",
      "type": "Microsoft.Sql/instancePools",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group2/providers/Microsoft.Sql/instancePools/testIP2",
      "location": "japaneast",
      "properties": {
        "dnsZone": "1234567890",
        "licenseType": "LicenseIncluded",
        "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group2/providers/Microsoft.Network/virtualNetwork/myvnet/subnets/mysubnet1",
        "vCores": 8
      },
      "sku": {
        "name": "GP_Gen5",
        "family": "Gen5",
        "tier": "GeneralPurpose"
      },
      "tags": {
        "a": "b"
      }
    }
  ]
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
InstancePool	A Azure SQL instance pool.
InstancePoolLicenseType	Typ licencji. Możliwe wartości to "LicenseIncluded" (cena licencji SQL jest uwzględniona) i "BasePrice" (bez ceny licencji SQL).
InstancePoolListResult	Odpowiedź operacji listy Instancji.
Sku	Jednostka SKU zasobu usługi ARM.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Błąd dodatkowe informacje.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Cel błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

InstancePool

Objekt

A Azure SQL instance pool.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.dnsZone	string	Strefa DNS, w ramach którego znajduje się pula wystąpień zarządzanych.
properties.licenseType	InstancePoolLicenseType	Typ licencji. Możliwe wartości to "LicenseIncluded" (cena licencji SQL jest uwzględniona) i "BasePrice" (bez ceny licencji SQL).
properties.maintenanceConfigurationId	string (arm-id)	Określa identyfikator konfiguracji konserwacji, który ma być stosowany do tego wystąpienia zarządzanego.
properties.subnetId	string	Identyfikator zasobu podsieci do umieszczenia tej puli wystąpień.
properties.vCores	integer (int32)	Liczba rdzeni wirtualnych należących do tej puli wystąpień.
sku	Sku	Nazwa i warstwa jednostki SKU.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

InstancePoolLicenseType

Wyliczenie

Typ licencji. Możliwe wartości to "LicenseIncluded" (cena licencji SQL jest uwzględniona) i "BasePrice" (bez ceny licencji SQL).

Wartość	Opis
LicenseIncluded	LicencjaUwzględniona
BasePrice	BasePrice

InstancePoolListResult

Objekt

Odpowiedź operacji listy Instancji.

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony elementów
value	InstancePool[]	Elementy InstancePool na tej stronie

Sku

Objekt

Jednostka SKU zasobu usługi ARM.

Nazwa	Typ	Opis
capacity	integer (int32)	Pojemność określonej jednostki SKU.
family	string	Jeśli usługa ma różne generacje sprzętu, dla tej samej jednostki SKU, można je przechwycić tutaj.
name	string	Nazwa jednostki SKU, zazwyczaj, litera + kod liczbowy, np. P3.
size	string	Rozmiar konkretnej jednostki SKU
tier	string	Warstwa lub wersja konkretnej jednostki SKU, np. Podstawowa, Premium.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.