Instance Pools - Get

Szolgáltatás:

SQL Database

API-verzió:

2023-08-01

Lekéri a példánykészletet.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
instancePoolName	path	True	string	A lekérendő példánykészlet neve.
resourceGroupName	path	True	string	Az erőforrást tartalmazó erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
subscriptionId	path	True	string	Az Azure-előfizetést azonosító előfizetés-azonosító.
api-version	query	True	string	A kéréshez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	InstancePool	Sikeresen lekérte a megadott példánykészletet.
Other Status Codes	ErrorResponse	Hibaválaszok: *** 400 MismatchingResourceGroupNameWithUrl – A megadott erőforráscsoport neve nem egyezett az URL-címben megadott névvel. 400 MismatchingSubscriptionWithUrl – A megadott előfizetés nem egyezett meg az URL-címben szereplő előfizetéssel. 400 InvalidMinimalTlsVersion – Érvénytelen minimális TLS-verzió. 400 InvalidResourceId – Érvénytelen erőforrás-azonosító. 400 InvalidParameterValue – Érvénytelen értéket adott meg egy paraméter. 400 DeleteOfManagedInstanceIsDisabled – A felügyelt példány törlési művelete le van tiltva. 400 CustomMaintenanceWindowIsDisabled – Az egyéni karbantartási időszak nincs engedélyezve. 400 MICantBeMovedFromOrToInstancePool – A meglévő felügyelt példány nem helyezhető át felügyelt példánykészletbe. 404 SubscriptionNotFound – A kért előfizetés nem található. 404 InstancePoolNotFound – Nem található példánykészlet 429 SubscriptionTooManyRequests – Az elérhető erőforrások által feldolgozható kérelmek maximálisnál több kérése. 503 TooManyRequests – A rendelkezésre álló erőforrások által feldolgozható maximális kérelmeken túli kérések.

Példák

Get an instance pool

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
InstancePool	Egy Azure SQL-példánykészlet.
InstancePoolLicenseType	A licenc típusa. A lehetséges értékek a "LicenseIncluded" (az SQL-licenc ára) és a "BasePrice" (SQL-licenc ára nélkül).
Sku	ARM-erőforrás termékváltozata.

ErrorAdditionalInfo

Objektum

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

Objektum

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 hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

InstancePool

Objektum

Egy Azure SQL-példánykészlet.

Name	Típus	Description
id	string	Erőforrás-azonosító.
location	string	Erőforrás helye.
name	string	Erőforrás neve.
properties.dnsZone	string	Az a DNS-zóna, amelyben a felügyelt példánykészlet található.
properties.licenseType	InstancePoolLicenseType	A licenc típusa. A lehetséges értékek a "LicenseIncluded" (az SQL-licenc ára) és a "BasePrice" (SQL-licenc ára nélkül).
properties.maintenanceConfigurationId	string (arm-id)	Megadja a felügyelt példányra alkalmazandó karbantartási konfiguráció azonosítóját.
properties.subnetId	string	Az alhálózat erőforrás-azonosítója a példánykészlet elhelyezéséhez.
properties.vCores	integer (int32)	A példánykészlethez tartozó virtuális magok száma.
sku	Sku	Az SKU neve és szintje.
tags	object	Erőforráscímkék.
type	string	Erőforrás típusa.

InstancePoolLicenseType

Enumerálás

A licenc típusa. A lehetséges értékek a "LicenseIncluded" (az SQL-licenc ára) és a "BasePrice" (SQL-licenc ára nélkül).

Érték	Description
BasePrice
LicenseIncluded

Sku

Objektum

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.