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 |
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
Capacities |
OData response wrapper for a Power BI capacity list |
Capacity |
A Power BI capacity |
Capacity |
The capacity state |
capacity |
The access right that the user has on the capacity |
Tenant |
Encryption key information |
Capacities
OData response wrapper for a Power BI capacity list
Name | Type | Description |
---|---|---|
odata.context |
|
|
value |
|
The capacity list |
Capacity
A Power BI capacity
Name | Type | Description |
---|---|---|
admins |
|
An array of capacity admins |
capacityUserAccessRight |
The access right a user has on the capacity |
|
displayName |
|
The display name of the capacity |
id |
|
The capacity ID |
region |
|
The Azure region where the capacity was provisioned |
sku |
|
The capacity SKU |
state |
The capacity state |
|
tenantKey |
Encryption key information (only applies to admin routes) |
|
tenantKeyId |
|
The ID of an encryption key (only applicable to the admin route) |
CapacityState
The capacity state
Name | Type | Description |
---|---|---|
Active |
|
The capacity is ready to use |
Deleted |
|
The capacity was deleted and is unavailable |
Deleting |
|
Deletion of the capacity is in progress |
Invalid |
|
The capacity can't be used |
NotActivated |
|
Unsupported |
PreSuspended |
|
Unsupported |
ProvisionFailed |
|
Provisioning of the capacity failed |
Provisioning |
|
Activation of the capacity is in progress |
Suspended |
|
Use of the capacity is suspended |
UpdatingSku |
|
A capacity SKU change is in progress |
capacityUserAccessRight
The access right that the user has on the capacity
Name | Type | Description |
---|---|---|
Admin |
|
User has administrator rights on the capacity |
Assign |
|
User has contributor rights and can assign workspaces to the capacity |
None |
|
User doesn't have access to the capacity |
TenantKey
Encryption key information
Name | Type | Description |
---|---|---|
createdAt |
|
The creation date and time of the encryption key |
id |
|
The ID of the encryption key |
isDefault |
|
Whether the encryption key is the default key for the entire tenant. Any newly created capacity inherits the default key. |
keyVaultKeyIdentifier |
|
The URI that uniquely specifies the encryption key in Azure Key Vault |
name |
|
The name of the encryption key |
updatedAt |
|
The last update date and time of the encryption key |