Admin - Get Capacities As Admin

Service:

Power BI REST APIs

API Version:

v1.0

Retourne une liste de capacités pour l’organisation.

Autorisations

• L’utilisateur doit disposer de droits d’administrateur (tels que Office 365 administrateur général ou administrateur de service Power BI) ou s’authentifier à l’aide d’un principal de service.
• Les autorisations déléguées sont prises en charge.

Lors de l’exécution sous l’authentification prinicipal de service, une application ne doit pas avoir de prémissions requises de consentement administrateur pour Power BI définies sur elle dans le Portail Azure.

Étendue requise

Tenant.Read.All ou Tenant.ReadWrite.All

Pertinent uniquement lors de l’authentification via un jeton d’accès administrateur délégué standard. Ne doit pas être présent lors de l’utilisation de l’authentification via un principal de service.

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
$expand	query		string	Développe les entités associées inline

Réponses

Nom	Type	Description
200 OK	Capacities	OK

Exemples

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

Définitions

Nom	Description
Capacities	Wrapper de réponse OData pour une liste de capacité Power BI
Capacity	Une capacité Power BI
CapacityState	État de capacité
capacityUserAccessRight	Droit d’accès de l’utilisateur sur la capacité
TenantKey	Informations sur la clé de chiffrement

Capacities

Wrapper de réponse OData pour une liste de capacité Power BI

Nom	Type	Description
odata.context	string
value	Capacity[]	Liste de capacité

Capacity

Une capacité Power BI

Nom	Type	Description
admins	string[]	Tableau d’administrateurs de capacité
capacityUserAccessRight	capacityUserAccessRight	Droit d’accès d’un utilisateur sur la capacité
displayName	string	Nom d’affichage de la capacité
id	string	ID de capacité
region	string	Région Azure où la capacité a été provisionnée
sku	string	Référence SKU de capacité
state	CapacityState	État de capacité
tenantKey	TenantKey	Informations sur la clé de chiffrement (s’appliquent uniquement aux itinéraires d’administration)
tenantKeyId	string	ID d’une clé de chiffrement (applicable uniquement à l’itinéraire administrateur)

CapacityState

État de capacité

Nom	Type	Description
Active	string	La capacité est prête à être utilisée
Deleted	string	La capacité a été supprimée et n’est pas disponible
Deleting	string	La suppression de la capacité est en cours
Invalid	string	La capacité ne peut pas être utilisée
NotActivated	string	Non pris en charge
PreSuspended	string	Non pris en charge
ProvisionFailed	string	Échec de l’approvisionnement de la capacité
Provisioning	string	L’activation de la capacité est en cours
Suspended	string	L’utilisation de la capacité est suspendue
UpdatingSku	string	Un changement de référence SKU de capacité est en cours

capacityUserAccessRight

Droit d’accès de l’utilisateur sur la capacité

Nom	Type	Description
Admin	string	L’utilisateur dispose de droits d’administrateur sur la capacité
Assign	string	L’utilisateur dispose de droits contributeurs et peut affecter des espaces de travail à la capacité
None	string	L’utilisateur n’a pas accès à la capacité

TenantKey

Informations sur la clé de chiffrement

Nom	Type	Description
createdAt	string	Date et heure de création de la clé de chiffrement
id	string	ID de la clé de chiffrement
isDefault	boolean	Indique si la clé de chiffrement est la clé par défaut pour l’ensemble du locataire. Toute capacité nouvellement créée hérite de la clé par défaut.
keyVaultKeyIdentifier	string	URI qui spécifie de manière unique la clé de chiffrement dans Azure Key Vault
name	string	Nom de la clé de chiffrement
updatedAt	string	Date et heure de la dernière mise à jour de la clé de chiffrement