Share via

Instance Pools - Get

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Gets an instance pool.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}?api-version=2021-11-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

*** Error Responses: ***

  • 404 SubscriptionNotFound - The requested subscription was not found.

  • 404 InstancePoolNotFound - An instance pool cannot be found

Examples

Get an instance pool

Sample request

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

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

InstancePool

An Azure SQL instance pool.

Name Type Description
id

string

Resource ID.
location

string

Resource location.
name

string

Resource name.
properties.licenseType

InstancePoolLicenseType

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

string

Resource ID of the subnet to place this instance pool in.
properties.vCores

integer

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

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

Name Type Description
BasePrice

string

LicenseIncluded

string

Sku

An ARM Resource SKU.

Name Type Description
capacity

integer

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.