Microsoft Fabric Fabric Capacities API

openapi: 3.2.0
info:
  title: Microsoft.Fabric management service Fabric Capacities API
  version: '2023-11-01'
  description: Microsoft.Fabric Resource Provider management API.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: FabricCapacities
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Fabric/capacities:
    get:
      operationId: FabricCapacities_ListBySubscription
      tags:
      - FabricCapacities
      description: List FabricCapacity resources by subscription ID
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricCapacityListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Fabric capacities list by subscription
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.Fabric/locations/{location}/checkNameAvailability:
    post:
      operationId: FabricCapacities_CheckNameAvailability
      tags:
      - FabricCapacities
      description: Implements local CheckNameAvailability operations
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/LocationParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckNameAvailabilityResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckNameAvailabilityRequest'
        description: The CheckAvailability request
        required: true
      summary: Fabric capacities check name availability
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.Fabric/skus:
    get:
      operationId: FabricCapacities_ListSkus
      tags:
      - FabricCapacities
      description: List eligible SKUs for Microsoft Fabric resource provider
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RpSkuEnumerationForNewResourceResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Fabric capacities list skus
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities:
    get:
      operationId: FabricCapacities_ListByResourceGroup
      tags:
      - FabricCapacities
      description: List FabricCapacity resources by 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/FabricCapacityListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Fabric capacities list by resource group
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}:
    get:
      operationId: FabricCapacities_Get
      tags:
      - FabricCapacities
      description: Get a FabricCapacity
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: capacityName
        in: path
        description: The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z][a-z0-9]*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricCapacity'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Fabric capacities get
      x-summary-source: derived
    put:
      operationId: FabricCapacities_CreateOrUpdate
      tags:
      - FabricCapacities
      description: Create a FabricCapacity
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: capacityName
        in: path
        description: The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z][a-z0-9]*$
      responses:
        '200':
          description: Resource 'FabricCapacity' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricCapacity'
        '201':
          description: Resource 'FabricCapacity' create operation succeeded
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              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/FabricCapacity'
        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
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FabricCapacity'
        description: Resource create parameters.
        required: true
      summary: Fabric capacities create or update
      x-summary-source: derived
    patch:
      operationId: FabricCapacities_Update
      tags:
      - FabricCapacities
      description: Update a FabricCapacity
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: capacityName
        in: path
        description: The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z][a-z0-9]*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricCapacity'
        '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
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FabricCapacityUpdate'
        description: The resource properties to be updated.
        required: true
      summary: Fabric capacities update
      x-summary-source: derived
    delete:
      operationId: FabricCapacities_Delete
      tags:
      - FabricCapacities
      description: Delete a FabricCapacity
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: capacityName
        in: path
        description: The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z][a-z0-9]*$
      responses:
        '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: Fabric capacities delete
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}/resume
  : post:
      operationId: FabricCapacities_Resume
      tags:
      - FabricCapacities
      description: Resume operation of the specified Fabric capacity instance.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: capacityName
        in: path
        description: The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z][a-z0-9]*$
      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
      summary: Fabric capacities resume
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}/skus
  : get:
      operationId: FabricCapacities_ListSkusForCapacity
      tags:
      - FabricCapacities
      description: List eligible SKUs for a Microsoft Fabric resource
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: capacityName
        in: path
        description: The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z][a-z0-9]*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RpSkuEnumerationForExistingResourceResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Fabric capacities list skus for capacity
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}/suspend
  : post:
      operationId: FabricCapacities_Suspend
      tags:
      - FabricCapacities
      description: Suspend operation of the specified Fabric capacity instance.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: capacityName
        in: path
        description: The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z][a-z0-9]*$
      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
      summary: Fabric capacities suspend
      x-summary-source: derived
components:
  schemas:
    FabricCapacityListResult:
      type: object
      description: The response of a FabricCapacity list operation.
      properties:
        value:
          type: array
          description: The FabricCapacity items on this page
          items:
            $ref: '#/components/schemas/FabricCapacity'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    FabricCapacity:
      type: object
      description: Fabric Capacity resource
      properties:
        properties:
          $ref: '#/components/schemas/FabricCapacityProperties'
          description: The resource-specific properties for this resource.
          x-ms-client-flatten: true
        sku:
          $ref: '#/components/schemas/RpSku'
          description: The SKU details
      required:
      - properties
      - sku
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
    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.
    RpSkuEnumerationForExistingResourceResult:
      type: object
      description: An object that represents enumerating SKUs for existing resources
      properties:
        value:
          type: array
          description: The SKU details
          items:
            $ref: '#/components/schemas/RpSkuDetailsForExistingResource'
          x-ms-identifiers: []
        nextLink:
          type: string
          description: Url for the next page.  Null if no more pages available
      required:
      - value
    RpSkuDetailsForExistingResource:
      type: object
      description: An object that represents SKU details for existing resources
      properties:
        resourceType:
          type: string
          description: The resource type
        sku:
          $ref: '#/components/schemas/RpSku'
          description: The SKU details
      required:
      - resourceType
      - sku
    RpSkuDetailsForNewResource:
      type: object
      description: The SKU details
      properties:
        resourceType:
          type: string
          description: The resource type
        name:
          type: string
          description: The SKU's name
        locations:
          type: array
          description: The list of available locations for the SKU
          items:
            $ref: '#/components/schemas/Azure.Core.azureLocation'
      required:
      - resourceType
      - name
      - locations
    Azure.Core.azureLocation:
      type: string
      description: Represents an Azure geography region where supported resource providers live.
    FabricCapacityUpdate:
      type: object
      description: The type used for update operations of the FabricCapacity.
      properties:
        sku:
          $ref: '#/components/schemas/RpSku'
          description: The SKU details
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
        properties:
          $ref: '#/components/schemas/FabricCapacityUpdateProperties'
          description: The resource-specific properties for this resource.
          x-ms-client-flatten: true
    FabricCapacityUpdateProperties:
      type: object
      description: The updatable properties of the FabricCapacity.
      properties:
        administration:
          $ref: '#/components/schemas/CapacityAdministration'
          description: The capacity administration
    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'
    RpSkuTier:
      type: string
      description: The name of the Azure pricing tier to which the SKU applies.
      enum:
      - Fabric
      x-ms-enum:
        name: RpSkuTier
        modelAsString: true
        values:
        - name: fabric
          value: Fabric
          description: Fabric tier
    CapacityAdministration:
      type: object
      description: The administration properties of the Fabric capacity resource
      properties:
        members:
          type: array
          description: An array of administrator user identities.
          items:
            type: string
      required:
      - members
    ProvisioningState:
      type: string
      description: The provisioning state of the Fabric capacity resource.
      enum:
      - Succeeded
      - Failed
      - Canceled
      - Deleting
      - Provisioning
      - Updating
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
        values:
        - name: Succeeded
          value: Succeeded
          description: Resource has been created.
        - name: Failed
          value: Failed
          description: Resource creation failed.
        - name: Canceled
          value: Canceled
          description: Resource creation was canceled.
        - name: Deleting
          value: Deleting
          description: Resource is deleting
        - name: Provisioning
          value: Provisioning
          description: Resource is provisioning
        - name: Updating
          value: Updating
          description: Resource is updating
      readOnly: true
    CheckNameAvailabilityResponse:
      type: object
      description: The check availability result.
      properties:
        nameAvailable:
          type: boolean
          description: Indicates if the resource name is available.
        reason:
          type: string
          description: The reason why the given name is not available.
          enum:
          - Invalid
          - AlreadyExists
          x-ms-enum:
            name: CheckNameAvailabilityReason
            modelAsString: true
        message:
          type: string
          description: Detailed reason why the given name is available.
    RpSkuEnumerationForNewResourceResult:
      type: object
      description: An object that represents enumerating SKUs for new resources.
      properties:
        value:
          type: array
          description: The collection of available SKUs for new resources
          items:
            $ref: '#/components/schemas/RpSkuDetailsForNewResource'
          x-ms-identifiers: []
        nextLink:
          type: string
          description: Url for the next page.  Null if no more pages available
      required:
      - value
    ResourceState:
      type: string
      description: The state of the Fabric capacity resource.
      enum:
      - Active
      - Provisioning
      - Failed
      - Updating
      - Deleting
      - Suspending
      - Suspended
      - Pausing
      - Paused
      - Resuming
      - Scaling
      - Preparing
      x-ms-enum:
        name: ResourceState
        modelAsString: true
        values:
        - name: Active
          value: Active
          description: Resource is active
        - name: Provisioning
          value: Provisioning
          description: Resource is provisioning
        - name: Failed
          value: Failed
          description: Resource is failed
        - name: Updating
          value: Updating
          description: Resource is updating
        - name: Deleting
          value: Deleting
          description: Resource is deleting
        - name: Suspending
          value: Suspending
          description: Resource is suspending
        - name: Suspended
          value: Suspended
          description: Resource is suspended
        - name: Pausing
          value: Pausing
          description: Resource is pausing
        - name: Paused
          value: Paused
          description: Resource is paused
        - name: Resuming
          value: Resuming
          description: Resource is resuming
        - name: Scaling
          value: Scaling
          description: Resource is scaling
        - name: Preparing
          value: Preparing
          description: Resource is preparing
    CheckNameAvailabilityRequest:
      type: object
      description: The check availability request body.
      properties:
        name:
          type: string
          description: The name of the resource for which availability needs to be checked.
        type:
          type: string
          description: The resource type.
    FabricCapacityProperties:
      type: object
      description: The Microsoft Fabric capacity properties.
      properties:
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The current deployment state of Microsoft Fabric resource. The provisioningState is to indicate states for resource provisioning.
          readOnly: true
        state:
          $ref: '#/components/schemas/ResourceState'
          description: The current state of Microsoft Fabric resource. The state is to indicate more states outside of resource provisioning.
          readOnly: true
        administration:
          $ref: '#/components/schemas/CapacityAdministration'
          description: The capacity administration
      required:
      - administration
    RpSku:
      type: object
      description: Represents the SKU name and Azure pricing tier for Microsoft Fabric capacity resource.
      properties:
        name:
          type: string
          description: The name of the SKU level.
        tier:
          $ref: '#/components/schemas/RpSkuTier'
          description: The name of the Azure pricing tier to which the SKU applies.
      required:
      - name
      - tier
  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
    LocationParameter:
      name: location
      in: path
      description: The name of the Azure region.
      required: true
      x-ms-parameter-location: method
      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
    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.