Admin - Dashboards GetDashboardsAsAdmin
Zwraca listę pulpitów nawigacyjnych dla organizacji.
Uprawnienia
- Użytkownik musi mieć uprawnienia administratora (takie jak administrator globalny Office 365 lub administrator usługi Power BI) lub uwierzytelnić się przy użyciu jednostki usługi.
- Uprawnienia delegowane są obsługiwane.
W przypadku uruchamiania w ramach uwierzytelniania prinicipal usługi aplikacja nie może mieć żadnych wymaganych przez administratora premisji dla usługi Power BI ustawionych w Azure Portal.
Wymagany zakres
Tenant.Read.All lub Tenant.ReadWrite.All
Istotne tylko w przypadku uwierzytelniania za pośrednictwem standardowego tokenu dostępu administratora delegowanego. Nie może być obecny w przypadku użycia uwierzytelniania za pośrednictwem jednostki usługi.
Ograniczenia
Maksymalnie 50 żądań na godzinę lub 5 żądań na minutę na dzierżawę.
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
$expand
|
query |
string |
Akceptuje rozdzielaną przecinkami listę typów danych, które zostaną rozwinięte w tekście w odpowiedzi. Obsługuje funkcję |
|
$filter
|
query |
string |
Filtruje wyniki na podstawie warunku logicznego |
|
$skip
|
query |
integer int32 |
Pomija pierwsze n wyników |
|
$top
|
query |
integer int32 |
Zwraca tylko pierwsze n wyników |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
Przykłady
Example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards
Sample Response
{
"value": [
{
"id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"displayName": "SalesMarketing",
"embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"isReadOnly": false,
"workspaceId": "abfbdc89-2659-43c1-9142-93e8378eac96"
}
]
}
Definicje
Nazwa | Opis |
---|---|
Admin |
Pulpit nawigacyjny usługi Power BI zwrócony przez interfejsy API Administracja. Interfejs API zwraca podzestaw następujących właściwości pulpitu nawigacyjnego. Podzestaw zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI. |
Admin |
Otoka odpowiedzi OData dla kolekcji pulpitów nawigacyjnych usługi Power BI |
Admin |
Kafelek usługi Power BI zwrócony przez interfejsy API Administracja. |
Dashboard |
Odpowiedni wpis dostępu użytkownika usługi Power BI dla pulpitu nawigacyjnego |
Dashboard |
Prawo dostępu, które użytkownik ma dla pulpitu nawigacyjnego (poziom uprawnień) |
Principal |
Typ podmiotu zabezpieczeń |
Service |
Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami. |
Subscription |
Subskrypcja poczty e-mail dla elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego) |
Subscription |
Użytkownik subskrypcji poczty e-mail usługi Power BI |
AdminDashboard
Pulpit nawigacyjny usługi Power BI zwrócony przez interfejsy API Administracja. Interfejs API zwraca podzestaw następujących właściwości pulpitu nawigacyjnego. Podzestaw zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI.
Nazwa | Typ | Opis |
---|---|---|
appId |
string |
Identyfikator aplikacji zwrócony tylko wtedy, gdy pulpit nawigacyjny należy do aplikacji |
displayName |
string |
Nazwa wyświetlana pulpitu nawigacyjnego |
embedUrl |
string |
Adres URL osadzania pulpitu nawigacyjnego |
id |
string |
Identyfikator pulpitu nawigacyjnego |
isReadOnly |
boolean |
Czy pulpit nawigacyjny jest tylko do odczytu |
subscriptions |
(Wartość pusta) Szczegóły subskrypcji elementu usługi Power BI (takie jak raport lub pulpit nawigacyjny). Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o subskrypcji dla raportu usługi Power BI można pobrać za pomocą wywołania interfejsu API pobierania raportów jako wywołania interfejsu API Administracja. |
|
tiles |
Kafelki należące do pulpitu nawigacyjnego |
|
users |
(Wartość pusta) Szczegóły dostępu użytkownika pulpitu nawigacyjnego. Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o użytkowniku na pulpicie nawigacyjnym usługi Power BI można pobrać przy użyciu wywołania interfejsu API pobierz pulpit nawigacyjny jako Administracja lub wywołania interfejsu API PostWorkspaceInfo z parametrem |
|
webUrl |
string |
Internetowy adres URL pulpitu nawigacyjnego |
workspaceId |
string |
Identyfikator obszaru roboczego (GUID) pulpitu nawigacyjnego. Ta właściwość zostanie zwrócona tylko w obszarze GetDashboardsAsAdmin. |
AdminDashboards
Otoka odpowiedzi OData dla kolekcji pulpitów nawigacyjnych usługi Power BI
Nazwa | Typ | Opis |
---|---|---|
odata.context |
string |
Kontekst OData |
value |
Kolekcja pulpitów nawigacyjnych |
AdminTile
Kafelek usługi Power BI zwrócony przez interfejsy API Administracja.
Nazwa | Typ | Opis |
---|---|---|
colSpan |
integer |
Liczba kolumn obejmujących kafelek |
datasetId |
string |
Identyfikator zestawu danych. Dostępne tylko dla kafelków utworzonych na podstawie raportu lub przy użyciu zestawu danych, takiego jak kafelki Q&A. |
embedData |
string |
Dane osadzania dla kafelka |
embedUrl |
string |
Adres URL osadzania kafelka |
id |
string |
Identyfikator kafelka |
reportId |
string |
Identyfikator raportu. Dostępne tylko dla kafelków utworzonych na podstawie raportu. |
rowSpan |
integer |
Liczba kafelków obejmuje wiersze |
title |
string |
Nazwa wyświetlana kafelka |
DashboardUser
Odpowiedni wpis dostępu użytkownika usługi Power BI dla pulpitu nawigacyjnego
Nazwa | Typ | Opis |
---|---|---|
dashboardUserAccessRight |
Prawo dostępu, które użytkownik ma dla pulpitu nawigacyjnego (poziom uprawnień) |
|
displayName |
string |
Nazwa wyświetlana podmiotu zabezpieczeń |
emailAddress |
string |
Adres e-mail użytkownika |
graphId |
string |
Identyfikator podmiotu zabezpieczeń w programie Microsoft Graph. Dostępne tylko dla interfejsów API administratora. |
identifier |
string |
Identyfikator podmiotu zabezpieczeń |
principalType |
Typ podmiotu zabezpieczeń |
|
profile |
Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami. |
|
userType |
string |
Typ użytkownika. |
DashboardUserAccessRight
Prawo dostępu, które użytkownik ma dla pulpitu nawigacyjnego (poziom uprawnień)
Nazwa | Typ | Opis |
---|---|---|
None |
string |
Brak uprawnień do zawartości na pulpicie nawigacyjnym |
Owner |
string |
Udziela dostępu do odczytu, zapisu i udostępniania dalej do zawartości w raporcie |
Read |
string |
Udziela dostępu do odczytu zawartości na pulpicie nawigacyjnym |
ReadCopy |
string |
Udziela dostępu do odczytu i kopiowania zawartości na pulpicie nawigacyjnym |
ReadReshare |
string |
Udziela dostępu do odczytu i udostępniania dalej zawartości na pulpicie nawigacyjnym |
ReadWrite |
string |
Udziela dostępu do odczytu i zapisu zawartości na pulpicie nawigacyjnym |
PrincipalType
Typ podmiotu zabezpieczeń
Nazwa | Typ | Opis |
---|---|---|
App |
string |
Typ jednostki usługi |
Group |
string |
Typ podmiotu zabezpieczeń grupy |
None |
string |
Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji. |
User |
string |
Typ podmiotu zabezpieczeń użytkownika |
ServicePrincipalProfile
Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.
Nazwa | Typ | Opis |
---|---|---|
displayName |
string |
Nazwa profilu jednostki usługi |
id |
string |
Identyfikator profilu jednostki usługi |
Subscription
Subskrypcja poczty e-mail dla elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
Nazwa | Typ | Opis |
---|---|---|
artifactDisplayName |
string |
Nazwa subskrybowanego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego) |
artifactId |
string |
Identyfikator subskrybowanego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego) |
artifactType |
string |
Typ elementu usługi Power BI (na przykład |
attachmentFormat |
string |
Format raportu dołączonego do subskrypcji poczty e-mail |
endDate |
string |
Data i godzina zakończenia subskrypcji poczty e-mail |
frequency |
string |
Częstotliwość subskrypcji poczty e-mail |
id |
string |
Identyfikator subskrypcji |
isEnabled |
boolean |
Czy subskrypcja poczty e-mail jest włączona |
linkToContent |
boolean |
Czy link subskrypcji istnieje w subskrypcji poczty e-mail |
previewImage |
boolean |
Czy zrzut ekranu raportu istnieje w subskrypcji poczty e-mail |
startDate |
string |
Data i godzina rozpoczęcia subskrypcji poczty e-mail |
subArtifactDisplayName |
string |
Nazwa strony subskrybowanego elementu usługi Power BI, jeśli jest to raport. |
title |
string |
Nazwa aplikacji |
users |
Szczegóły każdego subskrybenta poczty e-mail. W przypadku korzystania z wywołania interfejsu API Get User Subscriptions As Administracja zwracana wartość jest pustą tablicą (null). Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o subskrypcji w raporcie lub pulpicie nawigacyjnym usługi Power BI można pobrać za pomocą polecenia Pobierz subskrypcje raportów jako Administracja lub Pobierz subskrypcje pulpitu nawigacyjnego Jako wywołania interfejsu API Administracja. |
SubscriptionUser
Użytkownik subskrypcji poczty e-mail usługi Power BI
Nazwa | Typ | Opis |
---|---|---|
displayName |
string |
Nazwa wyświetlana podmiotu zabezpieczeń |
emailAddress |
string |
Adres e-mail użytkownika |
graphId |
string |
Identyfikator podmiotu zabezpieczeń w programie Microsoft Graph. Dostępne tylko dla interfejsów API administratora. |
identifier |
string |
Identyfikator podmiotu zabezpieczeń |
principalType |
Typ podmiotu zabezpieczeń |
|
profile |
Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami. |
|
userType |
string |
Typ użytkownika. |