Instance Pools - Get

Dienst:: SQL Database

API-Version:: 2025-01-01

Ruft einen Instanzpool ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
instancePoolName	path	True	string	Der Name des abzurufenden Instanzpools.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
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	InstancePool	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 an instance pool

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP?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/GetInstancePool.json
// this example is just showing the usage of "InstancePools_Get" 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 InstancePoolResource created on azure
// for more information of creating InstancePoolResource, please refer to the document of InstancePoolResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string instancePoolName = "testIP";
ResourceIdentifier instancePoolResourceId = InstancePoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, instancePoolName);
InstancePoolResource instancePool = client.GetInstancePoolResource(instancePoolResourceId);

// invoke the operation
InstancePoolResource result = await instancePool.GetAsync();

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
InstancePool	An Azure SQL instance pool.
InstancePoolLicenseType	Der Lizenztyp. Mögliche Werte sind "LicenseIncluded" (Preis für SQL-Lizenz ist enthalten) und "BasePrice" (ohne SQL-Lizenzpreis).
Sku	Eine ARM-Ressourcen-SKU.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

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.

InstancePool

Objekt

An Azure SQL instance 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}"
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.dnsZone	string	Die DNS-Zone, in der sich der verwaltete Instanzpool befindet.
properties.licenseType	InstancePoolLicenseType	Der Lizenztyp. Mögliche Werte sind "LicenseIncluded" (Preis für SQL-Lizenz ist enthalten) und "BasePrice" (ohne SQL-Lizenzpreis).
properties.maintenanceConfigurationId	string (arm-id)	Gibt die Wartungskonfigurations-ID an, die auf diese verwaltete Instanz angewendet werden soll.
properties.subnetId	string	Ressourcen-ID des Subnetzes, in dem dieser Instanzpool platziert werden soll.
properties.vCores	integer (int32)	Anzahl der vCores, die zu diesem Instanzpool gehören.
sku	Sku	Der Name und die Ebene der SKU.
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"

InstancePoolLicenseType

Enumeration

Der Lizenztyp. Mögliche Werte sind "LicenseIncluded" (Preis für SQL-Lizenz ist enthalten) und "BasePrice" (ohne SQL-Lizenzpreis).

Wert	Beschreibung
LicenseIncluded	LizenzEnthaltene Lizenz
BasePrice	BasePrice

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.