Admin - Get Capacities As Admin

Služba:

Power BI REST APIs

Verze rozhraní API:

v1.0

Vrátí seznam kapacit pro organizaci.

Dovolení

• Uživatel musí být správcem infrastruktury nebo se musí ověřit pomocí instančního objektu.
• Delegovaná oprávnění jsou podporována.

Při spuštění v rámci ověřování prinicipal služby nesmí aplikace nesmí mít na webu Azure Portal nastavené žádné žádosti o udělení souhlasu správce pro Power BI.

Požadovaný obor

Tenant.Read.All nebo Tenant.ReadWrite.All

Relevantní pouze při ověřování prostřednictvím standardního delegovaného přístupového tokenu správce. Při ověřování pomocí instančního objektu nesmí být k dispozici.

Omezení

Maximálně 200 požadavků za hodinu.

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

S volitelnými parametry:

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í související entity vložené do textu.

Odpovědi

Name	Typ	Description
200 OK	Capacities	OK

Příklady

Example

Example with expand on tenant key

Example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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ědí OData pro seznam kapacit Power BI
Capacity	Kapacita Power BI
CapacityState	Stav kapacity
capacityUserAccessRight	Přístupové právo, které má uživatel v kapacitě
TenantKey	Informace o šifrovacím klíči

Capacities

Obálka odpovědí OData pro seznam kapacit Power BI

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

Capacity

Kapacita Power BI

Name	Typ	Description
admins	string[]	Pole správců kapacity
capacityUserAccessRight	capacityUserAccessRight	Přístupové právo, které má uživatel na 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 byla odstraněna a není k dispozici.
Deleting	string	Probíhá odstranění kapacity.
Invalid	string	Kapacitu nejde 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	Použití kapacity je pozastaveno.
UpdatingSku	string	Probíhá změna skladové položky kapacity.

capacityUserAccessRight

Přístupové právo, které má uživatel v 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 přiřazovat pracovní prostory ke kapacitě.
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. Všechny nově vytvořené kapacity dědí výchozí klíč.
keyVaultKeyIdentifier	string	Identifikátor URI, který jednoznačně určuje šifrovací klíč ve službě Azure Key Vault
name	string	Název šifrovacího klíče
updatedAt	string	Datum a čas poslední aktualizace šifrovacího klíče