Admin - Dashboards GetDashboardsInGroupAsAdmin
Zwraca listę pulpitów nawigacyjnych z określonego obszaru roboczego.
Permissions
- 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 aplikacja 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/groups/{groupId}/dashboards
GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/dashboards?$filter={$filter}&$top={$top}&$skip={$skip}
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
group
|
path | True |
string (uuid) |
Identyfikator obszaru roboczego |
|
$filter
|
query |
string |
Zwraca podzbiór wyników na podstawie warunku parametru zapytania filtru Odata . |
|
|
$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
Przykładowe żądanie
GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards
Przykładowa odpowiedź
{
"value": [
{
"id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"displayName": "SalesMarketing",
"embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
"isReadOnly": false
}
]
}
Definicje
| Nazwa | Opis |
|---|---|
|
Admin |
Pulpit nawigacyjny usługi Power BI zwrócony przez interfejsy API administratora. 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 administratora. |
|
Dashboard |
Wpis prawa 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 jednostki usługi Power BI. Dotyczy tylko rozwiązania z wieloma dzierżawami usługi Power BI Embedded. |
| 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 administratora. 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 (uuid) |
Identyfikator pulpitu nawigacyjnego |
| isReadOnly |
boolean |
Czy pulpit nawigacyjny jest tylko do odczytu |
| subscriptions |
(Pusta wartość) 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 raportu usługi Power BI można pobrać przy użyciu wywołania interfejsu API administracyjnego pobierz subskrypcje raportów . |
|
| tiles |
Kafelki należące do pulpitu nawigacyjnego |
|
| users |
(Pusta wartość) 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 Pobierania pulpitu nawigacyjnego jako administratora lub wywołania interfejsu API PostWorkspaceInfo z parametrem |
|
| webUrl |
string |
Internetowy adres URL pulpitu nawigacyjnego |
| workspaceId |
string (uuid) |
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 administratora.
| 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 pytań i pytań. |
| embedData |
string |
Dane osadzania dla kafelka |
| embedUrl |
string |
Adres URL osadzania kafelka |
| id |
string (uuid) |
Identyfikator kafelka |
| reportId |
string (uuid) |
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
Wpis prawa 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 administratorów. |
| identifier |
string |
Identyfikator podmiotu zabezpieczeń |
| principalType |
Typ podmiotu zabezpieczeń |
|
| profile |
Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania z wieloma dzierżawami usługi Power BI Embedded. |
|
| userType |
string |
Typ użytkownika. |
DashboardUserAccessRight
Prawo dostępu, które użytkownik ma dla pulpitu nawigacyjnego (poziom uprawnień)
| Wartość | Opis |
|---|---|
| None |
Brak uprawnień do zawartości na pulpicie nawigacyjnym |
| Read |
Przyznaje dostęp do odczytu zawartości na pulpicie nawigacyjnym |
| ReadWrite |
Udziela dostępu do odczytu i zapisu do zawartości na pulpicie nawigacyjnym |
| ReadReshare |
Udziela dostępu do odczytu i udostępniania dalej zawartości na pulpicie nawigacyjnym |
| ReadCopy |
Udziela dostępu do odczytu i kopiowania zawartości na pulpicie nawigacyjnym |
| Owner |
Udziela dostępu do odczytu, zapisu i udostępniania dalej do zawartości w raporcie |
PrincipalType
Typ podmiotu zabezpieczeń
| Wartość | Opis |
|---|---|
| None |
Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji. |
| User |
Typ podmiotu zabezpieczeń użytkownika |
| Group |
Typ podmiotu zabezpieczeń grupy |
| App |
Typ jednostki usługi |
ServicePrincipalProfile
Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania z wieloma dzierżawami usługi Power BI Embedded.
| Nazwa | Typ | Opis |
|---|---|---|
| displayName |
string |
Nazwa profilu jednostki usługi |
| id |
string (uuid) |
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 (uuid) |
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 (date-time) |
Data i godzina zakończenia subskrypcji poczty e-mail |
| frequency |
string |
Częstotliwość subskrypcji poczty e-mail |
| id |
string (uuid) |
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 (date-time) |
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 poszczególnych subskrybentów poczty e-mail. W przypadku używania wywołania interfejsu API pobierania subskrypcji użytkowników jako administratora 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ć przy użyciu opcji Pobierz subskrypcje raportów jako administrator lub Pobierz subskrypcje pulpitu nawigacyjnego jako wywołania interfejsu API administratora . |
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 administratorów. |
| identifier |
string |
Identyfikator podmiotu zabezpieczeń |
| principalType |
Typ podmiotu zabezpieczeń |
|
| profile |
Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania z wieloma dzierżawami usługi Power BI Embedded. |
|
| userType |
string |
Typ użytkownika. |