Instance Pools - Get

Service:: SQL Database

API Version:: 2023-08-01

Gets an instance pool.

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

URI Parameters

Name	In	Required	Type	Description
instancePoolName	path	True	string	The name of the instance pool to be retrieved.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	InstancePool	Successfully retrieved the specified instance pool.
Other Status Codes	ErrorResponse	* Error Responses: * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url. 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url. 400 InvalidMinimalTlsVersion - Invalid minimal TLS version. 400 InvalidResourceId - Invalid resource identifier. 400 InvalidParameterValue - An invalid value was given to a parameter. 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled. 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled. 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool. 404 SubscriptionNotFound - The requested subscription was not found. 404 InstancePoolNotFound - An instance pool cannot be found 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Name

Type

Description

200 OK

InstancePool

Successfully retrieved the specified instance pool.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.
400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.
400 InvalidMinimalTlsVersion - Invalid minimal TLS version.
400 InvalidResourceId - Invalid resource identifier.
400 InvalidParameterValue - An invalid value was given to a parameter.
400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.
400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.
400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.
404 SubscriptionNotFound - The requested subscription was not found.
404 InstancePoolNotFound - An instance pool cannot be found
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Get an instance pool

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP?api-version=2023-08-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.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

Sample response

Status code:: 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"
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
InstancePool	An Azure SQL instance pool.
InstancePoolLicenseType	The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).
Sku	An ARM Resource SKU.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

InstancePool

Object

An Azure SQL instance pool.

Name	Type	Description
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.dnsZone	string	The Dns Zone that the managed instance pool is in.
properties.licenseType	InstancePoolLicenseType	The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).
properties.maintenanceConfigurationId	string (arm-id)	Specifies maintenance configuration id to apply to this managed instance.
properties.subnetId	string	Resource ID of the subnet to place this instance pool in.
properties.vCores	integer (int32)	Count of vCores belonging to this instance pool.
sku	Sku	The name and tier of the SKU.
tags	object	Resource tags.
type	string	Resource type.

InstancePoolLicenseType

Enumeration

The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).

Value	Description
LicenseIncluded
BasePrice

Sku

Object

An ARM Resource SKU.

Name	Type	Description
capacity	integer (int32)	Capacity of the particular SKU.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU, typically, a letter + Number code, e.g. P3.
size	string	Size of the particular SKU
tier	string	The tier or edition of the particular SKU, e.g. Basic, Premium.

Share via

Instance Pools - Get

URI Parameters

Responses

Examples

Get an instance pool

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InstancePool

InstancePoolLicenseType

Sku