Edit

Capacities - List Capacities

Service:
Core
API Version:
v1

Returns a list of capacities the principal can access (either administrator or a contributor).
This API supports pagination.

Required Delegated Scopes

Capacity.Read.All or Capacity.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

GET https://api.fabric.microsoft.com/v1/capacities
With optional parameters: 
GET https://api.fabric.microsoft.com/v1/capacities?continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
continuationToken
 query

string

A token for retrieving the next page of results.

Responses

Name Type Description
200 OK

Capacities

Request completed successfully.
429 Too Many Requests

ErrorResponse

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: integer
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

List capacities example
List capacities with continuation example

List capacities example

Sample request

GET https://api.fabric.microsoft.com/v1/capacities

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
      "displayName": "F4 Capacity",
      "sku": "F4",
      "region": "West Central US",
      "state": "Active"
    },
    {
      "id": "0b9a4952-b5e7-4a55-8739-3e7251a2fd43",
      "displayName": "F8 Capacity",
      "sku": "F8",
      "region": "West Central US",
      "state": "Inactive"
    },
    {
      "id": "af196b7b-0bf8-4430-b383-ad48d14f4edf",
      "displayName": "F16 Capacity",
      "sku": "F16",
      "region": "West Central US",
      "state": "Active"
    }
  ]
}

List capacities with continuation example

Sample request

GET https://api.fabric.microsoft.com/v1/capacities

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
      "displayName": "F4 Capacity",
      "sku": "F4",
      "region": "West Central US",
      "state": "Active"
    },
    {
      "id": "0b9a4952-b5e7-4a55-8739-3e7251a2fd43",
      "displayName": "F8 Capacity",
      "sku": "F8",
      "region": "West Central US",
      "state": "Inactive"
    },
    {
      "id": "af196b7b-0bf8-4430-b383-ad48d14f4edf",
      "displayName": "F16 Capacity",
      "sku": "F16",
      "region": "West Central US",
      "state": "Active"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/capacities?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definitions

Name Description
Capacities
Capacity

A capacity object.
CapacityState

A Capacity state. Additional capacity states may be added over time.
ErrorParameter

A structured parameter providing additional machine-readable context about an error.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.

Capacities

Object
Name Type Description
continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.
value

Capacity[]

A list of capacities.

Capacity

Object

A capacity object.

Name Type Description
displayName

string

The capacity display name.
id

string (uuid)

The capacity ID.
region

string

The Azure region where the capacity was provisioned.
sku

string

The capacity SKU.
state

CapacityState

The capacity state.

CapacityState

Enumeration

A Capacity state. Additional capacity states may be added over time.

Value Description
Active

The capacity is ready to use.
Inactive

The capacity can't be used.

ErrorParameter

Object

A structured parameter providing additional machine-readable context about an error.

Name Type Description
message

string

A human-readable description of the parameter's meaning.
name

string

The parameter identifier.
value

string

The parameter value.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
isRetriable

boolean

When true, the request can be retried. Use the Retry-After response header to determine the delay, if available.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
parameters

ErrorParameter[]

Structured parameters providing additional machine-readable context about the error.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string (uuid)

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.