Admin - Get Capacities As Admin

Service:

Power BI REST APIs

API Version:

v1.0

Gibt eine Liste der Kapazitäten für die Organisation zurück.

Berechtigungen

• Der Benutzer muss über Administratorrechte (z. B. Office 365 globalen Administrator oder Power BI-Dienstadministrator) verfügen oder sich mit einem Dienstprinzipal authentifizieren.
• Delegierte Berechtigungen werden unterstützt.

Bei der Ausführung unter dienstprinicipaler Authentifizierung dürfen für eine App keine erforderlichen Administratoreinwilligungsvoreinstellungen für Power BI im Azure-Portal festgelegt sein.

Erforderlicher Bereich

Tenant.Read.All oder Tenant.ReadWrite.All

Nur bei der Authentifizierung über ein standardmäßiges delegiertes Administratorzugriffstoken relevant. Darf nicht vorhanden sein, wenn die Authentifizierung über einen Dienstprinzipal verwendet wird.

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

With optional parameters:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
$expand	query		string	Erweitert verwandte Entitäten inline

Antworten

Name	Typ	Beschreibung
200 OK	Capacities	OK

Beispiele

Example

Example with expand on tenant key

Example

Sample Request

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

Sample Response

Status code:

200

{
  "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

Status code:

200

{
  "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"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
Capacities	OData-Antwort wrapper für eine Power BI-Kapazitätsliste
Capacity	Power BI-Kapazität
CapacityState	Der Kapazitätsstatus
capacityUserAccessRight	Das Zugriffsrecht, das der Benutzer auf die Kapazität hat
TenantKey	Verschlüsselungsschlüsselinformationen

Capacities

OData-Antwort wrapper für eine Power BI-Kapazitätsliste

Name	Typ	Beschreibung
odata.context	string
value	Capacity[]	Die Kapazitätsliste

Capacity

Power BI-Kapazität

Name	Typ	Beschreibung
admins	string[]	Ein Array von Kapazitätsadministratoren
capacityUserAccessRight	capacityUserAccessRight	Das Zugriffsrecht, das ein Benutzer auf die Kapazität hat
displayName	string	Der Anzeigename der Kapazität
id	string	Die Kapazitäts-ID
region	string	Die Azure-Region, in der die Kapazität bereitgestellt wurde
sku	string	Die Kapazitäts-SKU
state	CapacityState	Der Kapazitätsstatus
tenantKey	TenantKey	Verschlüsselungsschlüsselinformationen (gilt nur für Administratorrouten)
tenantKeyId	string	Die ID eines Verschlüsselungsschlüssels (gilt nur für die Administratorroute)

CapacityState

Der Kapazitätsstatus

Name	Typ	Beschreibung
Active	string	Die Kapazität ist einsatzbereit
Deleted	string	Die Kapazität wurde gelöscht und ist nicht verfügbar.
Deleting	string	Das Löschen der Kapazität wird ausgeführt.
Invalid	string	Die Kapazität kann nicht verwendet werden.
NotActivated	string	Nicht unterstützt
PreSuspended	string	Nicht unterstützt
ProvisionFailed	string	Fehler bei der Bereitstellung der Kapazität
Provisioning	string	Die Aktivierung der Kapazität wird ausgeführt.
Suspended	string	Die Nutzung der Kapazität wird angehalten.
UpdatingSku	string	Eine Änderung der Kapazitäts-SKU wird ausgeführt.

capacityUserAccessRight

Das Zugriffsrecht, das der Benutzer auf die Kapazität hat

Name	Typ	Beschreibung
Admin	string	Der Benutzer verfügt über Administratorrechte für die Kapazität.
Assign	string	Der Benutzer hat Mitwirkenderechte und kann arbeitsbereiche der Kapazität zuweisen.
None	string	Der Benutzer hat keinen Zugriff auf die Kapazität.

TenantKey

Verschlüsselungsschlüsselinformationen

Name	Typ	Beschreibung
createdAt	string	Erstellungsdatum und -uhrzeit des Verschlüsselungsschlüssels
id	string	Die ID des Verschlüsselungsschlüssels
isDefault	boolean	Gibt an, ob der Verschlüsselungsschlüssel der Standardschlüssel für den gesamten Mandanten ist. Jede neu erstellte Kapazität erbt den Standardschlüssel.
keyVaultKeyIdentifier	string	Der URI, der den Verschlüsselungsschlüssel in Azure Key Vault
name	string	Der Name des Verschlüsselungsschlüssels
updatedAt	string	Datum und Uhrzeit der letzten Aktualisierung des Verschlüsselungsschlüssels