Azure SQL Database Instance Pools API

The InstancePools API from Azure SQL Database — 3 operation(s) for instancepools.

GitHub OpenAPI

Operations 6

GET /subscriptions/{subscriptionId}/providers/Microsoft.Sql/instancePools Instance pools list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools Instance pools list by resource group #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName} Instance pools get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName} Instance pools create or update #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName} Instance pools update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName} Instance pools delete #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-sql-database:microsoft-azure-sql-database-instancepools-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-sql-database-instancepools-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: SqlManagementClient Instance Pools API
  version: '2025-01-01'
  description: The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: InstancePools
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/instancePools:
    get:
      operationId: InstancePools_List
      tags:
      - InstancePools
      description: Gets a list of all instance pools in the subscription.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstancePoolListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Instance pools list
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools:
    get:
      operationId: InstancePools_ListByResourceGroup
      tags:
      - InstancePools
      description: Gets a list of instance pools in the resource group
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstancePoolListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Instance pools list by resource group
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}
  : get:
      operationId: InstancePools_Get
      tags:
      - InstancePools
      description: Gets an instance pool.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: instancePoolName
        in: path
        description: The name of the instance pool to be retrieved.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstancePool'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Instance pools get
      x-summary-source: derived
    put:
      operationId: InstancePools_CreateOrUpdate
      tags:
      - InstancePools
      description: Creates or updates an instance pool.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: instancePoolName
        in: path
        description: The name of the instance pool to be retrieved.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'InstancePool' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstancePool'
        '201':
          description: Resource 'InstancePool' create operation succeeded
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstancePool'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/InstancePool'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstancePool'
        description: The requested instance pool resource state.
        required: true
      summary: Instance pools create or update
      x-summary-source: derived
    patch:
      operationId: InstancePools_Update
      tags:
      - InstancePools
      description: Updates an instance pool.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: instancePoolName
        in: path
        description: The name of the instance pool to be retrieved.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstancePool'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/InstancePool'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstancePoolUpdate'
        description: The requested instance pool resource state.
        required: true
      summary: Instance pools update
      x-summary-source: derived
    delete:
      operationId: InstancePools_Delete
      tags:
      - InstancePools
      description: Deletes an instance pool
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: instancePoolName
        in: path
        description: The name of the instance pool to be retrieved.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Instance pools delete
      x-summary-source: derived
components:
  schemas:
    Sku:
      type: object
      description: An ARM Resource SKU.
      properties:
        name:
          type: string
          description: The name of the SKU, typically, a letter + Number code, e.g. P3.
        tier:
          type: string
          description: The tier or edition of the particular SKU, e.g. Basic, Premium.
        size:
          type: string
          description: Size of the particular SKU
        family:
          type: string
          description: If the service has different generations of hardware, for the same SKU, then that can be captured here.
        capacity:
          type: integer
          format: int32
          description: Capacity of the particular SKU.
      required:
      - name
    InstancePoolLicenseType:
      type: string
      description: The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).
      enum:
      - LicenseIncluded
      - BasePrice
      x-ms-enum:
        name: InstancePoolLicenseType
        modelAsString: true
        values:
        - name: LicenseIncluded
          value: LicenseIncluded
          description: LicenseIncluded
        - name: BasePrice
          value: BasePrice
          description: BasePrice
    InstancePoolListResult:
      type: object
      description: The response of a InstancePool list operation.
      properties:
        value:
          type: array
          description: The InstancePool items on this page
          items:
            $ref: '#/components/schemas/InstancePool'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    InstancePoolProperties:
      type: object
      description: Properties of an instance pool.
      properties:
        subnetId:
          type: string
          description: Resource ID of the subnet to place this instance pool in.
          x-ms-mutability:
          - read
          - create
        vCores:
          type: integer
          format: int32
          description: Count of vCores belonging to this instance pool.
        licenseType:
          $ref: '#/components/schemas/InstancePoolLicenseType'
          description: The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).
        dnsZone:
          type: string
          description: The Dns Zone that the managed instance pool is in.
          readOnly: true
        maintenanceConfigurationId:
          type: string
          format: arm-id
          description: Specifies maintenance configuration id to apply to this managed instance.
          x-ms-arm-id-details:
            allowedResources:
            - type: Microsoft.Maintenance/publicMaintenanceConfigurations
      required:
      - subnetId
      - vCores
      - licenseType
    InstancePoolUpdate:
      type: object
      description: An update to an Instance pool.
      properties:
        sku:
          $ref: '#/components/schemas/Sku'
          description: The name and tier of the SKU.
        properties:
          $ref: '#/components/schemas/InstancePoolProperties'
          description: Resource properties.
          x-ms-client-flatten: true
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    InstancePool:
      type: object
      description: An Azure SQL instance pool.
      properties:
        properties:
          $ref: '#/components/schemas/InstancePoolProperties'
          description: Resource properties.
          x-ms-client-flatten: true
        sku:
          $ref: '#/components/schemas/Sku'
          description: The name and tier of the SKU.
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
    TrackedResource:
      type: object
      title: Tracked Resource
      description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - create
          - update
        location:
          type: string
          description: The geo-location where the resource lives
          x-ms-mutability:
          - read
          - create
      required:
      - location
      allOf:
      - $ref: '#/components/schemas/Resource'
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.