Microsoft Fabric Activation API

openapi: 3.2.0
info:
  title: Microsoft Fabric Workload Items REST Activation 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: Activation
paths:
  /workspaces/{workspaceId}/policySets/{policySetId}/activate:
    post:
      summary: Activates the policy set on the specified scope
      description: '> [!NOTE]

        > Policy set item is currently in Preview (learn more).


        ## Permissions


        - The caller must have *read* permissions for the policy set.


        - Based on the scope the PolicySet is applied to, caller must have:

        - For Capacity scope - The caller must be capacity Admin.


        ## Required Delegated Scopes


        - Item.Read.All or Item.ReadWrite.All


        - Based on the scope the PolicySet is applied to, the following scopes are also required:

        - For Capacity policy-scope - Capacity.ReadWrite.All


        ## Limitations


        - Only a single policy set can be active on the specified scope.


        ## 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:
      - Activation
      operationId: Activation_Activate
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: policySetId
        description: The policy set ID.
        required: true
        schema:
          type: string
          format: uuid
      - name: allowReplace
        description: 'When true, allow to replace existing active PolicySet. Default: false.'
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Request completed successfully.
        '429':
          x-ms-error-response: true
          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.
          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:


            * Unauthorized - User permission to the policy set is not sufficient to perform the operation.


            * NotFound - Requested policy set id not found.


            * PolicySetActivationConflict - PolicySet activation failed because another policy set is already active.


            * PropertyCannotBeDefault - A required property must not have default value.


            * PropertyCannotBeNullOrEmpty - A required property must have value.


            * InvalidActivationScope - An activation scope type must be aligned with the policy set scope type.


            * UnsupportedPropertyValue - The specified property value is unsupported.


            * PolicySetActivationConflict - PolicySet activation failed because another PolicySet is already active on the specified scope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScopeActivationRequest'
        description: Scope activation request payload.
        required: true
  /workspaces/{workspaceId}/policySets/{policySetId}/deactivate:
    post:
      summary: Deactivates the policy set from the specified scope
      description: '> [!NOTE]

        > Policy set item is currently in Preview (learn more).


        ## Permissions


        - The caller must have *read* permissions for the policy set.


        - Based on the scope the PolicySet is applied to, caller must have:

        - For Capacity scope - The caller must be capacity Admin.


        ## Required Delegated Scopes


        - Item.Read.All or Item.ReadWrite.All


        - Based on the scope the PolicySet is applied to, the following scopes are also required:

        - For Capacity policy-scope - Capacity.ReadWrite.All


        ## Limitations


        - Only a single policy set can be active on the specified scope.


        ## 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:
      - Activation
      operationId: Activation_Deactivate
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: policySetId
        description: The policy set ID.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Request completed successfully.
        '429':
          x-ms-error-response: true
          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.
          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:


            * Unauthorized - User permission to the policy set is not sufficient to perform the operation.


            * NotFound - Requested policy set id not found.


            * PropertyCannotBeNullOrEmpty - A required property must have value.


            * InvalidActivationScope - An activation scope type must be aligned with the policy set scope type.


            * UnsupportedPropertyValue - The specified property value is unsupported.


            * PolicySetNotActiveOnScope - Policy set is not active on the specified scope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScopeDeactivationRequest'
        description: Scope deactivation request payload.
        required: true
  /capacities/{capacityId}/policySets/active:
    get:
      summary: Returns the active policy set on the specified capacity
      description: '> [!NOTE]

        > Policy set item is currently in Preview (learn more).


        ## Permissions


        The caller must be an administrator of the specified capacity.


        ## Required Delegated Scopes


        Capacity.ReadWrite.All or Capacity.Read.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:
      - Activation
      operationId: Activation_GetActiveForCapacity
      parameters:
      - in: path
        name: capacityId
        description: The capacity ID.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivePolicySetResponse'
        '429':
          x-ms-error-response: true
          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.
          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:


            * Unauthorized - User permission to the capacity is not sufficient to perform the operation.


            * ActivePolicySetNotFoundForCapacity - No active policy set was found on the specified capacity.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ActivePolicySetResponse:
      description: The active policy set response.
      type: object
      properties:
        id:
          description: The policy set ID.
          type: string
          format: uuid
          readOnly: true
        displayName:
          description: The policy set display name.
          type: string
          readOnly: false
        description:
          description: The policy set description.
          type: string
          readOnly: false
        workspaceId:
          description: The ID of the workspace that contains the policy set.
          type: string
          format: uuid
          readOnly: true
    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
    ScopeActivationRequest:
      description: Scope activation request payload. The `scopeType` discriminator selects the concrete request shape.
      type: object
      required:
      - scopeType
      properties:
        scopeType:
          $ref: '#/components/schemas/policySet_Scope'
      discriminator:
        propertyName: scopeType
    ScopeDeactivationRequest:
      description: Scope deactivation request payload.
      type: object
      required:
      - scopeType
      properties:
        scopeType:
          $ref: '#/components/schemas/policySet_Scope'
    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
    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
    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
    policySet_Scope:
      type: string
      description: Policy scope type. Additional types may be added over time.
      enum:
      - Tenant
      - Capacity
      x-ms-enum:
        name: ScopeType
        modelAsString: true
        values:
        - value: Tenant
          description: Tenant policy scope.
        - value: Capacity
          description: Capacity policy scope.