Admin - Get Capacities As Admin

Service:

Power BI REST APIs

API Version:

v1.0

Vrátí seznam kapacit pro organizaci.

Oprávnění

• Uživatel musí mít oprávnění správce (například Office 365 globálního správce nebo správce služby Power BI) nebo ověřování pomocí instančního objektu.
• Delegovaná oprávnění jsou podporovaná.

Při spuštění v rámci ověřování prinicipal služby nesmí mít aplikace v Azure Portal nastavená oprávnění pro Power BI vyžadovaná správcem.

Požadovaný obor

Tenant.Read.All nebo Tenant.ReadWrite.All

Relevantní pouze při ověřování prostřednictvím standardního přístupového tokenu delegovaného správce. Nesmí být přítomen, když se používá ověřování prostřednictvím instančního objektu.

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
$expand	query		string	Rozbalí vložené související entity.

Odpovědi

Name	Typ	Description
200 OK	Capacities	OK

Příklady

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

Definice

Name	Description
Capacities	Obálka odpovědi OData pro seznam kapacity Power BI
Capacity	Kapacita Power BI
CapacityState	Stav kapacity
capacityUserAccessRight	Přístupová práva, která má uživatel ke kapacitě
TenantKey	Informace o šifrovacím klíči

Capacities

Obálka odpovědi OData pro seznam kapacity Power BI

Name	Typ	Description
odata.context	string
value	Capacity[]	Seznam kapacit

Capacity

Kapacita Power BI

Name	Typ	Description
admins	string[]	Pole správců kapacity
capacityUserAccessRight	capacityUserAccessRight	Přístupová práva, která má uživatel ke kapacitě
displayName	string	Zobrazovaný název kapacity
id	string	ID kapacity
region	string	Oblast Azure, ve které byla kapacita zřízena
sku	string	Skladová položka kapacity
state	CapacityState	Stav kapacity
tenantKey	TenantKey	Informace o šifrovacím klíči (platí jenom pro trasy správce)
tenantKeyId	string	ID šifrovacího klíče (platí jenom pro trasu správce)

CapacityState

Stav kapacity

Name	Typ	Description
Active	string	Kapacita je připravená k použití.
Deleted	string	Kapacita se odstranila a není k dispozici.
Deleting	string	Probíhá odstraňování kapacity.
Invalid	string	Kapacitu nelze použít.
NotActivated	string	Nepodporované
PreSuspended	string	Nepodporované
ProvisionFailed	string	Zřizování kapacity se nezdařilo.
Provisioning	string	Probíhá aktivace kapacity.
Suspended	string	Využití kapacity je pozastaveno.
UpdatingSku	string	Probíhá změna skladové položky kapacity

capacityUserAccessRight

Přístupová práva, která má uživatel ke kapacitě

Name	Typ	Description
Admin	string	Uživatel má oprávnění správce ke kapacitě.
Assign	string	Uživatel má práva přispěvatele a může ke kapacitě přiřadit pracovní prostory.
None	string	Uživatel nemá přístup ke kapacitě.

TenantKey

Informace o šifrovacím klíči

Name	Typ	Description
createdAt	string	Datum a čas vytvoření šifrovacího klíče
id	string	ID šifrovacího klíče
isDefault	boolean	Určuje, jestli je šifrovací klíč výchozím klíčem pro celého tenanta. Každá nově vytvořená kapacita dědí výchozí klíč.
keyVaultKeyIdentifier	string	Identifikátor URI, který jednoznačně určuje šifrovací klíč v Azure Key Vault
name	string	Název šifrovacího klíče
updatedAt	string	Datum a čas poslední aktualizace šifrovacího klíče