Capacities - Get Capacities

Returns a list of capacities that the user has access to.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded. The profile creator must have capacity permissions.

Required Scope

Capacity.Read.All or Capacity.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/capacities

Responses

Name Type Description
200 OK

Capacities

OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/capacities

Sample response

{
  "value": [
    {
      "id": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "displayName": "MyCapacity",
      "admins": [
        "john@contoso.com"
      ],
      "sku": "A1",
      "state": "Active",
      "region": "West Central US",
      "capacityUserAccessRight": "Admin"
    }
  ]
}

Definitions

Name Description
Capacities

OData response wrapper for a Power BI capacity list

Capacity

A Power BI capacity

CapacityState

The capacity state

capacityUserAccessRight

The access right that the user has on the capacity

TenantKey

Encryption key information

Capacities

OData response wrapper for a Power BI capacity list

Name Type Description
odata.context

string

value

Capacity[]

The capacity list

Capacity

A Power BI capacity

Name Type Description
admins

string[]

An array of capacity admins

capacityUserAccessRight

capacityUserAccessRight

The access right a user has on the capacity

displayName

string

The display name of the capacity

id

string

The capacity ID

region

string

The Azure region where the capacity was provisioned

sku

string

The capacity SKU

state

CapacityState

The capacity state

tenantKey

TenantKey

Encryption key information (only applies to admin routes)

tenantKeyId

string

The ID of an encryption key (only applicable to the admin route)

CapacityState

The capacity state

Name Type Description
Active

string

The capacity is ready to use

Deleted

string

The capacity was deleted and is unavailable

Deleting

string

Deletion of the capacity is in progress

Invalid

string

The capacity can't be used

NotActivated

string

Unsupported

PreSuspended

string

Unsupported

ProvisionFailed

string

Provisioning of the capacity failed

Provisioning

string

Activation of the capacity is in progress

Suspended

string

Use of the capacity is suspended

UpdatingSku

string

A capacity SKU change is in progress

capacityUserAccessRight

The access right that the user has on the capacity

Name Type Description
Admin

string

User has administrator rights on the capacity

Assign

string

User has contributor rights and can assign workspaces to the capacity

None

string

User doesn't have access to the capacity

TenantKey

Encryption key information

Name Type Description
createdAt

string

The creation date and time of the encryption key

id

string

The ID of the encryption key

isDefault

boolean

Whether the encryption key is the default key for the entire tenant. Any newly created capacity inherits the default key.

keyVaultKeyIdentifier

string

The URI that uniquely specifies the encryption key in Azure Key Vault

name

string

The name of the encryption key

updatedAt

string

The last update date and time of the encryption key