Udostępnij przez

Admin - Get Capacities As Admin

Usługa:
Power BI REST APIs
Wersja interfejsu API:
v1.0

Zwraca listę pojemności dla organizacji.

Uprawnienia

  • Użytkownik musi być administratorem sieci szkieletowej lub uwierzytelniać się przy użyciu jednostki usługi.
  • Uprawnienia delegowane są obsługiwane.

W przypadku uruchamiania w ramach uwierzytelniania podstawowego usługi aplikacji nie może mieć żadnych premii wymaganych przez administratora dla usługi Power BI ustawionych w witrynie Azure Portal.

Wymagany zakres

Tenant.Read.All lub Tenant.ReadWrite.All

Istotne tylko w przypadku uwierzytelniania za pośrednictwem standardowego delegowanego tokenu dostępu administratora. Nie może być obecny, gdy jest używane uwierzytelnianie za pośrednictwem jednostki usługi.

Ograniczenia

Maksymalna liczba żądań na godzinę wynosi 200.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
$expand
 query

string

Rozszerza powiązane jednostki wbudowane

Odpowiedzi

Nazwa Typ Opis
200 OK

Capacities

OK

Przykłady

Example
Example with expand on tenant key

Example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
      }
    }
  ]
}

Definicje

Nazwa Opis
Capacities

Otoka odpowiedzi OData dla listy pojemności usługi Power BI
Capacity

Pojemność usługi Power BI
CapacityState

Stan pojemności
capacityUserAccessRight

Prawo dostępu, które użytkownik ma w pojemności
TenantKey

Informacje o kluczu szyfrowania

Capacities

Objekt

Otoka odpowiedzi OData dla listy pojemności usługi Power BI

Nazwa Typ Opis
@odata.context

string

value

Capacity[]

Lista pojemności

Capacity

Objekt

Pojemność usługi Power BI

Nazwa Typ Opis
admins

string[]

Tablica administratorów pojemności
capacityUserAccessRight

capacityUserAccessRight

Prawo dostępu, które użytkownik ma w pojemności
displayName

string

Nazwa wyświetlana pojemności
id

string (uuid)

Identyfikator pojemności
region

string

Region świadczenia usługi Azure, w którym aprowizowano pojemność
sku

string

Jednostka SKU pojemności
state

CapacityState

Stan pojemności
tenantKey

TenantKey

Informacje o kluczu szyfrowania (dotyczy tylko tras administracyjnych)
tenantKeyId

string (uuid)

Identyfikator klucza szyfrowania (dotyczy tylko trasy administratora)

CapacityState

Wyliczanie

Stan pojemności

Wartość Opis
NotActivated

Nieobsługiwane
Active

Pojemność jest gotowa do użycia
Provisioning

Trwa aktywacja pojemności
ProvisionFailed

Aprowizowanie pojemności nie powiodło się
PreSuspended

Nieobsługiwane
Suspended

Użycie pojemności jest zawieszone
Deleting

Usuwanie pojemności jest w toku
Deleted

Pojemność została usunięta i jest niedostępna
Invalid

Nie można użyć pojemności
UpdatingSku

Trwa zmiana jednostki SKU pojemności

capacityUserAccessRight

Wyliczanie

Prawo dostępu, które użytkownik ma w pojemności

Wartość Opis
None

Użytkownik nie ma dostępu do pojemności
Assign

Użytkownik ma prawa współautora i może przypisywać obszary robocze do pojemności
Admin

Użytkownik ma uprawnienia administratora do pojemności

TenantKey

Objekt

Informacje o kluczu szyfrowania

Nazwa Typ Opis
createdAt

string (date-time)

Data i godzina utworzenia klucza szyfrowania
id

string (uuid)

Identyfikator klucza szyfrowania
isDefault

boolean

Czy klucz szyfrowania jest kluczem domyślnym dla całej dzierżawy. Każda nowo utworzona pojemność dziedziczy klucz domyślny.
keyVaultKeyIdentifier

string

Identyfikator URI, który jednoznacznie określa klucz szyfrowania w usłudze Azure Key Vault
name

string

Nazwa klucza szyfrowania
updatedAt

string (date-time)

Data i godzina ostatniej aktualizacji klucza szyfrowania