Microsoft Fabric Compute API

openapi: 3.2.0
info:
  title: Microsoft Fabric Workload Items REST Compute 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: Compute
paths:
  /workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/compute?beta=true:
    get:
      summary: Returns the compute configuration for the specified Apache Airflow job…
      description: '> [!NOTE]

        > This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.


        ## Permissions


        The caller must have *read* permissions for the Apache Airflow job.


        ## Required Delegated Scopes


        Item.Read.All or Item.ReadWrite.All


        Set the `beta` query parameter to `true` to call this API.


        **When calling this API, callers must specify `true` as the value for the query parameter `beta`.**


        ## 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:
      - Compute
      operationId: Compute_Get_Apache_Airflow_Job_Compute_(beta)
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: apacheAirflowJobId
        description: The Apache Airflow job ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: query
        name: beta
        description: This required parameter must be set to `true` to access this API, which is currently in beta.
        required: true
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AirflowComputeResponse'
        '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:


            * ItemNotFound - The requested Apache Airflow job was not found.


            * Forbidden - The caller doesn''t have permissions to call the API.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/updateCompute?beta=true:
    post:
      summary: Updates the compute configuration for an Apache Airflow job environment
      description: '> [!NOTE]

        > This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.


        This API supports long running operations (LRO).


        ## Permissions


        The caller must have *read and write* permissions for the Apache Airflow job.


        ## Required Delegated Scopes


        Item.ReadWrite.All


        Set the `beta` query parameter to `true` to call this API.


        **When calling this API, callers must specify `true` as the value for the query parameter `beta`.**


        ## 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:
      - Compute
      operationId: Compute_Update_Apache_Airflow_Job_Compute_(beta)
      x-ms-fabric-sdk-long-running-operation: true
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: apacheAirflowJobId
        description: The Apache Airflow job ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: query
        name: beta
        description: This required parameter must be set to `true` to access this API, which is currently in beta.
        required: true
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Request completed successfully.
        '202':
          description: Request accepted. The compute configuration will be updated in the background.
          headers:
            Location:
              description: The URL of the operation status, which can be used to track the operation state.
              schema:
                type: string
            x-ms-operation-id:
              description: The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.
              schema:
                type: string
                format: uuid
            Retry-After:
              description: The number of seconds to wait before retrying the request.
              schema:
                type: integer
        '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:


            * ItemNotFound - The requested Apache Airflow job was not found.


            * Forbidden - The caller doesn''t have permissions to call the API.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AirflowEnvironmentComputeRequest'
        description: Update Apache Airflow environment compute request payload.
        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
    ComputeScalability:
      description: Compute scalability properties.
      required:
      - minNodeCount
      - maxNodeCount
      type: object
      properties:
        minNodeCount:
          description: The minimum node count. The minimum value is always 5.
          format: int32
          type: integer
          minimum: 5
        maxNodeCount:
          description: The maximum node count.
          format: int32
          type: integer
          minimum: 5
    AirflowEnvironmentComputeRequest:
      description: The request payload for updating Apache Airflow environment compute configuration.
      type: object
      required:
      - poolTemplateId
      properties:
        poolTemplateId:
          description: The pool template ID.
          type: string
          format: uuid
    AirflowComputeResponse:
      description: Apache Airflow compute configuration response.
      type: object
      properties:
        poolTemplateId:
          description: The pool template ID.
          type: string
          format: uuid
          readOnly: true
        poolTemplateName:
          description: The pool template name.
          type: string
          readOnly: true
        nodeSize:
          $ref: '#/components/schemas/NodeSize'
        computeScalability:
          $ref: '#/components/schemas/ComputeScalability'
        apacheAirflowJobVersion:
          description: The Apache Airflow job version.
          type: string
          readOnly: true
        apacheAirflowJobVersionDetails:
          $ref: '#/components/schemas/ApacheAirflowJobVersionDetails'
        availabilityZones:
          $ref: '#/components/schemas/AvailabilityZonesStatus'
        shutdownPolicy:
          $ref: '#/components/schemas/ShutdownPolicy'
    ShutdownPolicy:
      type: string
      description: Shutdown policy. Additional `ShutdownPolicy` types may be added over time.
      enum:
      - AlwaysOn
      - OneHourInactivity
      x-ms-enum:
        name: ShutdownPolicy
        modelAsString: true
        values:
        - value: AlwaysOn
          description: Always on
        - value: OneHourInactivity
          description: Shutdown after one hour of inactivity
    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
    ApacheAirflowJobVersionDetails:
      description: Apache Airflow job version details.
      type: object
      properties:
        apacheAirflowVersion:
          description: The Apache Airflow version.
          type: string
          readOnly: true
        pythonVersion:
          description: The Python version.
          type: string
          readOnly: true
    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
    AvailabilityZonesStatus:
      type: string
      description: Availability zones status. Additional `AvailabilityZonesStatus` values may be added over time.
      enum:
      - Enabled
      - Disabled
      x-ms-enum:
        name: AvailabilityZonesStatus
        modelAsString: true
        values:
        - value: Enabled
          description: Availability zones are enabled.
        - value: Disabled
          description: Availability zones are disabled.
    NodeSize:
      type: string
      description: Node size. Additional `NodeSize` types may be added over time.
      enum:
      - Small
      - Large
      x-ms-enum:
        name: NodeSize
        modelAsString: true
        values:
        - value: Small
          description: Small node size
        - value: Large
          description: Large node size
    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