Admin - Get Capacities As Admin

Returns a list of capacities for the organization.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/admin/capacities
GET https://api.powerbi.com/v1.0/myorg/admin/capacities?$expand={$expand}

URI Parameters

Name In Required Type Description
$expand
query
  • string

Expands related entities inline

Responses

Name Type Description
200 OK

OK

Examples

Example
Example with expand on tenant key

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/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",
      "tenantKeyId": "82d9a37a-2b45-4221-b012-cb109b8e30c7"
    }
  ]
}

Example with expand on tenant key

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/capacities?$expand=tenantKey

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",
      "tenantKeyId": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
      "tenantKey": {
        "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
        "name": "Contoso Sales",
        "keyVaultKeyIdentifier": "https://contoso-vault2.vault.azure.net/keys/ContosoKeyVault/b2ab4ba1c7b341eea5ecaaa2wb54c4d2",
        "isDefault": true,
        "createdAt": "2019-04-30T21:35:15.867-07:00",
        "updatedAt": "2019-04-30T21:35:15.867-07:00"
      }
    }
  ]
}

Definitions

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

The capacity list

Capacity

A Power BI capacity

Name Type Description
admins
  • string[]

An array of capacity admins

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

The capacity state

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