Instance Pools - Get

Dienst:

SQL Database

API-Version:

2023-08-01

Ruft einen Instanzpool ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
instancePoolName	path	True	string	Der Name des abzurufenden Instanzpools.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	InstancePool	Der angegebene Instanzpool wurde erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 MismatchingResourceGroupNameWithUrl – Der angegebene Ressourcengruppenname stimmte nicht mit dem Namen in der URL überein. 400 MismatchingSubscriptionWithUrl – Das bereitgestellte Abonnement stimmte nicht mit dem Abonnement in der URL überein. 400 InvalidMinimalTlsVersion – Ungültige minimale TLS-Version. 400 InvalidResourceId – Ungültiger Ressourcenbezeichner. 400 InvalidParameterValue – Ein ungültiger Wert wurde einem Parameter zugewiesen. 400 DeleteOfManagedInstanceIsDisabled – Löschvorgang der verwalteten Instanz ist deaktiviert. 400 CustomMaintenanceWindowIsDisabled – Benutzerdefiniertes Wartungsfenster ist nicht aktiviert. 400 MICantBeMovedFromOrToInstancePool – Vorhandene verwaltete Instanz kann nicht in den Pool verwalteter Instanzen verschoben werden. 404 SubscriptionNotFound – Das angeforderte Abonnement wurde nicht gefunden. 404 InstancePoolNotFound – Ein Instanzpool kann nicht gefunden werden. 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

Get an instance pool

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP?api-version=2023-08-01

dotnet

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this InstancePoolResource
InstancePoolCollection collection = resourceGroupResource.GetInstancePools();

// invoke the operation
string instancePoolName = "testIP";
NullableResponse<InstancePoolResource> response = await collection.GetIfExistsAsync(instancePoolName);
InstancePoolResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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

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

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
InstancePool	Ein Azure SQL-Instanzpool.
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.

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

Ein Azure SQL-Instanzpool.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
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.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

InstancePoolLicenseType

Enumeration

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

Wert	Beschreibung
LicenseIncluded
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.