Azure SQL Database ElasticPools API

openapi: 3.0.0
info:
  title: Azure SQL Database elasticPools API (Microsoft.Sql 2025-01-01)
  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'
  x-source: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/elasticPools.json
  x-provenance:
    method: searched
    generated: '2026-11-05'
    note: Converted Swagger 2.0 to OpenAPI 3 (swagger2openapi, refs resolved, x-ms-examples dropped) from Microsoft own Azure/azure-rest-api-specs repo; host management.azure.com is Azure Resource Manager,
      operated by Microsoft. Verbatim originals in openapi/_original/.
security:
- azure_auth:
  - user_impersonation
tags:
- name: ElasticPools
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools
  : get:
      operationId: ElasticPools_ListByServer
      tags:
      - ElasticPools
      description: Gets all elastic pools in a server.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      - name: $skip
        in: query
        description: The number of elements in the collection to skip.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ElasticPoolListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}
  : get:
      operationId: ElasticPools_Get
      tags:
      - ElasticPools
      description: Gets an elastic pool.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      - name: elasticPoolName
        in: path
        description: The name of the elastic pool.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ElasticPool'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: ElasticPools_CreateOrUpdate
      tags:
      - ElasticPools
      description: Creates or updates an elastic pool.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      - name: elasticPoolName
        in: path
        description: The name of the elastic pool.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ElasticPool'
        description: The elastic pool parameters.
        required: true
      responses:
        '200':
          description: Resource 'ElasticPool' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ElasticPool'
        '201':
          description: Resource 'ElasticPool' create operation succeeded
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ElasticPool'
        '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: azure-async-operation
        final-state-schema: '#/definitions/ElasticPool'
      x-ms-long-running-operation: true
    patch:
      operationId: ElasticPools_Update
      tags:
      - ElasticPools
      description: Updates an elastic pool.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      - name: elasticPoolName
        in: path
        description: The name of the elastic pool.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ElasticPoolUpdate'
        description: The elastic pool update parameters.
        required: true
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ElasticPool'
        '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/ElasticPool'
      x-ms-long-running-operation: true
    delete:
      operationId: ElasticPools_Delete
      tags:
      - ElasticPools
      description: Deletes an elastic pool.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      - name: elasticPoolName
        in: path
        description: The name of the elastic pool.
        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
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/failover
  : post:
      operationId: ElasticPools_Failover
      tags:
      - ElasticPools
      description: Failovers an elastic pool.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      - name: elasticPoolName
        in: path
        description: The name of the elastic pool.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
        '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
      x-ms-long-running-operation: true
servers:
- url: https://management.azure.com
components:
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        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
    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
        minLength: 1
        maxLength: 90
  securitySchemes:
    azure_auth:
      type: oauth2
      description: Azure Active Directory OAuth2 Flow.
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account
  schemas:
    ElasticPool:
      type: object
      description: An elastic pool.
      properties:
        properties:
          $ref: '#/components/schemas/ElasticPoolProperties'
        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
        kind:
          type: string
          description: Kind of elastic pool. This is metadata used for the Azure portal experience.
          readOnly: true
      allOf:
      - 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:
        - type: object
          title: Resource
          description: Common fields that are returned in the response for all Azure Resource Manager resources
          properties:
            id:
              type: string
              format: arm-id
              description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
              readOnly: true
            name:
              type: string
              description: The name of the resource
              readOnly: true
            type:
              type: string
              description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
              readOnly: true
            systemData:
              type: object
              description: Metadata pertaining to creation and last modification of the resource.
              properties:
                createdBy:
                  type: string
                  description: The identity that created the resource.
                createdByType:
                  type: string
                  description: The type of identity that created the resource.
                  enum:
                  - User
                  - Application
                  - ManagedIdentity
                  - Key
                  x-ms-enum:
                    name: createdByType
                    modelAsString: true
                createdAt:
                  type: string
                  format: date-time
                  description: The timestamp of resource creation (UTC).
                lastModifiedBy:
                  type: string
                  description: The identity that last modified the resource.
                lastModifiedByType:
                  type: string
                  description: The type of identity that last modified the resource.
                  enum:
                  - User
                  - Application
                  - ManagedIdentity
                  - Key
                  x-ms-enum:
                    name: createdByType
                    modelAsString: true
                lastModifiedAt:
                  type: string
                  format: date-time
                  description: The timestamp of resource last modification (UTC)
              readOnly: true
          x-ms-azure-resource: true
    ElasticPoolListResult:
      type: object
      description: The response of a ElasticPool list operation.
      properties:
        value:
          type: array
          description: The ElasticPool items on this page
          items:
            $ref: '#/components/schemas/ElasticPool'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ElasticPoolPerDatabaseSettings:
      type: object
      description: Per database settings of an elastic pool.
      properties:
        minCapacity:
          type: number
          format: double
          description: The minimum capacity all databases are guaranteed.
        maxCapacity:
          type: number
          format: double
          description: The maximum capacity any one database can consume.
        autoPauseDelay:
          type: integer
          format: int32
          description: Auto Pause Delay for per database within pool
    ElasticPoolProperties:
      type: object
      description: Properties of an elastic pool
      properties:
        state:
          type: string
          description: The state of the elastic pool.
          enum:
          - Creating
          - Ready
          - Disabled
          x-ms-enum:
            name: ElasticPoolState
            modelAsString: true
            values:
            - name: Creating
              value: Creating
              description: Creating
            - name: Ready
              value: Ready
              description: Ready
            - name: Disabled
              value: Disabled
              description: Disabled
        creationDate:
          type: string
          format: date-time
          description: The creation date of the elastic pool (ISO8601 format).
          readOnly: true
        maxSizeBytes:
          type: integer
          format: int64
          description: The storage limit for the database elastic pool in bytes.
        minCapacity:
          type: number
          format: double
          description: Minimal capacity that serverless pool will not shrink below, if not paused
        perDatabaseSettings:
          $ref: '#/components/schemas/ElasticPoolPerDatabaseSettings'
        zoneRedundant:
          type: boolean
          description: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
        licenseType:
          type: string
          description: The license type to apply for this elastic pool.
          enum:
          - LicenseIncluded
          - BasePrice
          x-ms-enum:
            name: ElasticPoolLicenseType
            modelAsString: true
            values:
            - name: LicenseIncluded
              value: LicenseIncluded
              description: LicenseIncluded
            - name: BasePrice
              value: BasePrice
              description: BasePrice
        maintenanceConfigurationId:
          type: string
          description: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
        highAvailabilityReplicaCount:
          type: integer
          format: int32
          description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to
            Hyperscale elastic pools.
        autoPauseDelay:
          type: integer
          format: int32
          description: Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled
        preferredEnclaveType:
          type: string
          description: Type of enclave requested on the database i.e. Default or VBS enclaves.
          enum:
          - Default
          - VBS
          x-ms-enum:
            name: AlwaysEncryptedEnclaveType
            modelAsString: true
            values:
            - name: Default
              value: Default
              description: Default
            - name: VBS
              value: VBS
              description: VBS
        availabilityZone:
          type: string
          description: Specifies the availability zone the database is pinned to.
          enum:
          - NoPreference
          - '1'
          - '2'
          - '3'
          x-ms-enum:
            name: AvailabilityZoneType
            modelAsString: true
            values:
            - name: NoPreference
              value: NoPreference
              description: NoPreference
            - name: '1'
              value: '1'
              description: '1'
            - name: '2'
              value: '2'
              description: '2'
            - name: '3'
              value: '3'
              description: '3'
    ElasticPoolUpdate:
      type: object
      description: An elastic pool update.
      properties:
        sku:
          $ref: '#/components/schemas/ElasticPool/properties/sku'
        properties:
          $ref: '#/components/schemas/ElasticPoolUpdateProperties'
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
    ElasticPoolUpdateProperties:
      type: object
      description: Properties of an elastic pool
      properties:
        maxSizeBytes:
          type: integer
          format: int64
          description: The storage limit for the database elastic pool in bytes.
        minCapacity:
          type: number
          format: double
          description: Minimal capacity that serverless pool will not shrink below, if not paused
        perDatabaseSettings:
          $ref: '#/components/schemas/ElasticPoolPerDatabaseSettings'
        zoneRedundant:
          type: boolean
          description: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
        licenseType:
          $ref: '#/components/schemas/ElasticPoolProperties/properties/licenseType'
        maintenanceConfigurationId:
          type: string
          description: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
        highAvailabilityReplicaCount:
          type: integer
          format: int32
          description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to
            Hyperscale elastic pools.
        autoPauseDelay:
          type: integer
          format: int32
          description: Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled
        preferredEnclaveType:
          $ref: '#/components/schemas/ElasticPoolProperties/properties/preferredEnclaveType'
        availabilityZone:
          $ref: '#/components/schemas/ElasticPoolProperties/properties/availabilityZone'
    ErrorDetail:
      type: object
      description: The error detail.
      properties:
        code:
          type: string
          description: The error code.
          readOnly: true
        message:
          type: string
          description: The error message.
          readOnly: true
        target:
          type: string
          description: The error target.
          readOnly: true
        details:
          type: array
          description: The error details.
          items:
            $ref: '#/components/schemas/ErrorDetail'
          readOnly: true
          x-ms-identifiers:
          - message
          - target
        additionalInfo:
          type: array
          description: The error additional info.
          items:
            type: object
            description: The resource management error additional info.
            properties:
              type:
                type: string
                description: The additional info type.
                readOnly: true
              info:
                type: object
                description: The additional info.
                readOnly: true
          readOnly: true
          x-ms-identifiers: []
    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:
          type: object
          description: The error detail.
          properties:
            code:
              type: string
              description: The error code.
              readOnly: true
            message:
              type: string
              description: The error message.
              readOnly: true
            target:
              type: string
              description: The error target.
              readOnly: true
            details:
              type: array
              description: The error details.
              items:
                $ref: '#/components/schemas/ErrorDetail'
              readOnly: true
              x-ms-identifiers:
              - message
              - target
            additionalInfo:
              type: array
              description: The error additional info.
              items:
                type: object
                description: The resource management error additional info.
                properties:
                  type:
                    type: string
                    description: The additional info type.
                    readOnly: true
                  info:
                    type: object
                    description: The additional info.
                    readOnly: true
              readOnly: true
              x-ms-identifiers: []