Microsoft Fabric SQL Pools API

openapi: 3.2.0
info:
  title: Microsoft Fabric Workload Items REST SQL Pools API
  version: v1
  x-source: 'https://github.com/microsoft/fabric-rest-api-specs (bundled from openapi/_original/fabric-rest-api-specs: anomalyDetector/swagger.json, apacheAirflowJob/swagger.json, appBackend/swagger.json, azureDatabricksStorage/swagger.json, copyJob/swagger.json, cosmosDbDatabase/swagger.json, dashboard/swagger.json, dataAgent/swagger.json, dataBuildToolJob/swagger.json, dataPipeline/swagger.json, dataflow/swagger.json, datamart/swagger.json, deploymentPlan/swagger.json, digitalTwinBuilder/swagger.json, digitalTwinBuilderFlow/swagger.json, environment/swagger.json, eventSchemaSet/swagger.json, eventhouse/swagger.json, eventstream/swagger.json, graphModel/swagger.json, graphQLApi/swagger.json, graphQuerySet/swagger.json, kqlDashboard/swagger.json, kqlDatabase/swagger.json, kqlQueryset/swagger.json, lakehouse/swagger.json, map/swagger.json, mirroredAzureDatabricksCatalog/swagger.json, mirroredCatalog/swagger.json, mirroredDatabase/swagger.json, mirroredWarehouse/swagger.json, mlExperiment/swagger.json, mlModel/swagger.json, monitoring/swagger.json, mountedDataFactory/swagger.json, notebook/swagger.json, ontology/swagger.json, operationsAgent/swagger.json, orgApp/swagger.json, orgAppAudience/swagger.json, paginatedReport/swagger.json, plan/swagger.json, policySet/swagger.json, realTimeIntelligence/swagger.json, reflex/swagger.json, report/swagger.json, semanticModel/swagger.json, snowflakeDatabase/swagger.json, spark/swagger.json, sparkjobdefinition/swagger.json, sqlDatabase/swagger.json, sqlEndpoint/swagger.json, userDataFunction/swagger.json, variableLibrary/swagger.json, warehouse/swagger.json)'
servers:
- url: https://api.fabric.microsoft.com/v1
security: []
tags:
- name: SQLPools
paths:
  /workspaces/{workspaceId}/warehouses/sqlPoolsConfiguration:
    get:
      summary: Gets the SQL Pools configuration in the specified workspace
      description: '## Permissions


        The caller must have admin workspace role.


        ## Required Delegated Scopes


        Workspace.Read.All or Workspace.ReadWrite.All


        ## Microsoft Entra supported identities


        This API supports the Microsoft identities listed in this section.


        | Identity | Support |

        |-|-|

        | User | Yes |

        | Service principal and Managed identities | Yes |


        ## Interface'
      tags:
      - SQLPools
      operationId: SQLPools_GetSQLPoolsConfiguration
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SQLPoolsConfigurationResponse'
        '429':
          description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
          x-ms-error-response: true
          headers:
            Retry-After:
              description: The number of seconds to wait before retrying the request.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: 'Common error codes:


            * UnknownError - An error occurred.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      summary: Updates the SQL Pools configuration in the specified workspace
      description: '## Permissions


        The caller must have admin workspace role.


        ## Required Delegated Scopes


        Workspace.ReadWrite.All


        ## Microsoft Entra supported identities


        This API supports the Microsoft identities listed in this section.


        | Identity | Support |

        |-|-|

        | User | Yes |

        | Service principal and Managed identities | Yes |


        ## Interface'
      tags:
      - SQLPools
      operationId: SQLPools_UpdateSQLPoolsConfiguration
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Request completed successfully.
        '429':
          description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
          x-ms-error-response: true
          headers:
            Retry-After:
              description: The number of seconds to wait before retrying the request.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: 'Common error codes:


            * UnknownError - An error occurred.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSQLPoolsConfigurationRequest'
        description: A SQL pools configuration update request.
        required: true
components:
  schemas:
    ErrorResponse:
      description: The error response.
      required:
      - message
      - errorCode
      allOf:
      - $ref: '#/components/schemas/ErrorResponseDetails'
      properties:
        requestId:
          type: string
          format: uuid
          description: ID of the request associated with the error.
          readOnly: true
        moreDetails:
          description: List of additional error details.
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseDetails'
          readOnly: true
        isRetriable:
          type: boolean
          description: When true, the request can be retried. Use the `Retry-After` response header to determine the delay, if available.
          readOnly: true
    CustomSQLPool:
      type: object
      description: Custom SQL pool element.
      properties:
        name:
          description: Friendly name for the SQL pool.
          type: string
        isDefault:
          description: Indicates that this is a default SQL pool. Only one pool can be marked as default. True - Sql Pool is the default, False - Sql Pool is not the default.
          type: boolean
        maxResourcePercentage:
          description: Maximum percentage of workspace resources that this SQL pool is allowed to consume. Value is an integer in the range 1-100. The sum of maxResourcePercentage values across all SQL pools must not exceed 100
          format: int32
          type: integer
        optimizeForReads:
          description: Optimizes the SQL pool for read-heavy workloads. True - the SQL pool will leverage enhanced caching to improve read performance. False - the SQL pool will not use enhanced caching. Default is true.
          type: boolean
        classifier:
          $ref: '#/components/schemas/CustomSqlPoolClassifier'
    SQLPoolsConfigurationResponse:
      type: object
      description: SQL pools configuration response.
      properties:
        customSQLPoolsEnabled:
          description: Indicates whether the SQL pools configuration is enabled. When set to false, the configuration is disabled but preserved. Re-enabling it restores the previously saved configuration.
          type: boolean
        customSQLPools:
          description: A list of SQL pool elements.
          type: array
          items:
            $ref: '#/components/schemas/CustomSQLPool'
    ErrorResponseDetails:
      description: The error response details.
      type: object
      required:
      - message
      - errorCode
      properties:
        errorCode:
          type: string
          description: A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
          readOnly: true
        message:
          type: string
          description: A human readable representation of the error.
          readOnly: true
        relatedResource:
          $ref: '#/components/schemas/ErrorRelatedResource'
        parameters:
          description: Structured parameters providing additional machine-readable context about the error.
          type: array
          items:
            $ref: '#/components/schemas/ErrorParameter'
          readOnly: true
    UpdateSQLPoolsConfigurationRequest:
      type: object
      description: SQL pools configuration request payload.
      properties:
        customSQLPoolsEnabled:
          description: Indicates whether the SQL pools configuration is enabled. When set to false, the configuration is disabled but preserved. Re-enabling it restores the previously saved configuration.
          type: boolean
        customSQLPools:
          description: A list of SQL pool elements. In update requests, you must explicitly specify the name of the pools to retain. Any SQL pool not included in the update request will be deleted.
          type: array
          items:
            $ref: '#/components/schemas/CustomSQLPool'
    ErrorRelatedResource:
      description: The error related resource details object.
      type: object
      required:
      - resourceId
      - resourceType
      properties:
        resourceId:
          type: string
          description: The resource ID that's involved in the error.
          readOnly: true
        resourceType:
          type: string
          description: The type of the resource that's involved in the error.
          readOnly: true
    CustomSqlPoolClassifier:
      type: object
      description: A classifier element.
      required:
      - type
      - value
      properties:
        type:
          $ref: '#/components/schemas/CustomSqlPoolClassifierType'
        value:
          description: List of strings.
          type: array
          items:
            type: string
    ErrorParameter:
      description: A structured parameter providing additional machine-readable context about an error.
      type: object
      properties:
        name:
          type: string
          description: The parameter identifier.
          readOnly: true
        value:
          type: string
          description: The parameter value.
          readOnly: true
        message:
          type: string
          description: A human-readable description of the parameter's meaning.
          readOnly: true
    CustomSqlPoolClassifierType:
      description: Classifier element type. Additional classifier element types may be added over time.
      type: string
      enum:
      - Application Name
      - Application Name Regex
      - Statement Type
      x-ms-enum:
        name: CustomSqlPoolClassifierType
        modelAsString: true
        values:
        - value: Application Name
          description: Refers to specific application names applied to the SQL pool.
        - value: Application Name Regex
          description: Refers to a regular expression pattern used to match the application names applied to the SQL pool.
        - value: Statement Type
          description: Refers to SQL statement types applied to the SQL pool.