Admin - Groups GetGroupsAsAdmin
Zwraca listę obszarów roboczych 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 podstawowego usługi aplikacja nie może mieć żadnych premii wymaganych przez administratora dla usługi Power BI ustawionych w Azure Portal.
Zakres wymagany
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
Maksymalnie 50 żądań na godzinę lub 15 żądań na minutę na dzierżawę. To wywołanie spowoduje również przekroczenie limitu czasu po 30 sekundach, aby zapobiec negatywnemu wpływowi na usługa Power BI.
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$top={$top}
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
$top
|
query | True |
integer int32 |
Zwraca tylko pierwsze n wyników. Ten parametr jest obowiązkowy i musi należeć do zakresu od 1 do 5000. |
$expand
|
query |
string |
Akceptuje rozdzielaną przecinkami listę typów danych, które zostaną rozwinięte w tekście w odpowiedzi. Obsługuje |
|
$filter
|
query |
string |
Filtruje wyniki na podstawie warunku logicznego |
|
$skip
|
query |
integer int32 |
Pomija pierwsze n wyników. Użyj funkcji z góry, aby pobrać wyniki poza pierwsze 5000. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
Przykłady
Get deleted workspaces example.
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$filter=state eq 'Deleted'&$top=100
Sample Response
{
"value": [
{
"id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
"isReadOnly": false,
"isOnDedicatedCapacity": false,
"name": "Sample Group 2",
"description": "Deleted sample group",
"type": "Workspace",
"state": "Deleted"
}
]
}
Get orphaned workspaces example.
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$filter=(not users/any()) or (not users/any(u: u/groupUserAccessRight eq Microsoft.PowerBI.ServiceContracts.Api.GroupUserAccessRight'Admin'))&$top=100
Sample Response
{
"value": [
{
"id": "d5caa808-8c91-400a-911d-06af08dbcc31",
"isReadOnly": false,
"isOnDedicatedCapacity": false,
"name": "Orphaned Group",
"description": "Sample orphan group",
"type": "Workspace",
"state": "Active",
"hasWorkspaceLevelSettings": false,
"users": []
}
]
}
Get workspaces with their 'dashboards' expanded example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=dashboards&$top=100
Sample Response
{
"value": [
{
"id": "94E57E92-CEE2-486D-8CC8-218C97200579",
"isReadOnly": false,
"isOnDedicatedCapacity": false,
"capacityMigrationStatus": "Migrated",
"description": "shorter description",
"type": "Workspace",
"state": "Removing",
"name": "a",
"hasWorkspaceLevelSettings": false,
"dashboards": [
{
"id": "4668133c-ae3f-42fb-ad7c-214a8623280c",
"displayName": "SQlAzure-Refresh.pbix",
"isReadOnly": false
},
{
"id": "a8f18ca7-63e8-4220-bc1c-f576ec180b98",
"displayName": "cdvc",
"isReadOnly": false
}
]
}
]
}
Get workspaces with their 'datasets' expanded example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets&$top=100
Sample Response
{
"value": [
{
"id": "94E57E92-CEE2-486D-8CC8-218C97200579",
"isReadOnly": false,
"isOnDedicatedCapacity": false,
"capacityMigrationStatus": "Migrated",
"description": "shorter description",
"type": "Workspace",
"state": "Removing",
"name": "a",
"hasWorkspaceLevelSettings": false,
"datasets": [
{
"id": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
"name": "SQlAzure-Refresh",
"addRowsAPIEnabled": false,
"configuredBy": "admin@granularcontrols.ccsctp.net",
"isRefreshable": true,
"isEffectiveIdentityRequired": false,
"isEffectiveIdentityRolesRequired": false,
"isOnPremGatewayRequired": false,
"targetStorageMode": "Abf",
"createdDate": "2019-04-30T21:35:15.867-07:00",
"ContentProviderType": "PbixInImportMode",
"isInPlaceSharingEnabled": false
},
{
"id": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69",
"name": "NESGames",
"addRowsAPIEnabled": false,
"configuredBy": "admin@granularcontrols.ccsctp.net",
"isRefreshable": true,
"isEffectiveIdentityRequired": false,
"isEffectiveIdentityRolesRequired": false,
"isOnPremGatewayRequired": false,
"targetStorageMode": "Abf",
"createdDate": "2019-04-30T21:35:15.867-07:00",
"ContentProviderType": "PbixInImportMode",
"isInPlaceSharingEnabled": false
}
]
}
]
}
Get workspaces with their 'datasets' expanded example.
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets
Sample Response
{
"value": [
{
"id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
"isReadOnly": false,
"isOnDedicatedCapacity": true,
"capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
"defaultDatasetStorageFormat": "Small",
"name": "Sample Group 1",
"description": "Sample group",
"type": "Workspace",
"state": "Active",
"hasWorkspaceLevelSettings": true,
"datasets": [
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"addRowsAPIEnabled": false,
"configuredBy": "john@contoso.com",
"isRefreshable": true,
"isEffectiveIdentityRequired": false,
"isEffectiveIdentityRolesRequired": false,
"isOnPremGatewayRequired": false,
"isInPlaceSharingEnabled": false,
"encryption": {
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"encryptionStatus": "InSyncWithWorkspace"
}
}
]
},
{
"id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
"isReadOnly": false,
"isOnDedicatedCapacity": false,
"name": "Sample Group 2",
"description": "Deleted sample group",
"type": "Workspace",
"state": "Deleted",
"datasets": []
}
]
}
Get workspaces with their 'reports' expanded example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=reports&$top=100
Sample Response
{
"value": [
{
"id": "EC1EE11F-845D-495E-82A3-9DAC2072305A",
"isReadOnly": false,
"isOnDedicatedCapacity": false,
"capacityMigrationStatus": "Migrated",
"description": "cvcv",
"type": "Workspace",
"state": "Active",
"name": "WSv2Test12",
"hasWorkspaceLevelSettings": true,
"reports": []
},
{
"id": "94E57E92-CEE2-486D-8CC8-218C97200579",
"isReadOnly": false,
"isOnDedicatedCapacity": false,
"capacityMigrationStatus": "Migrated",
"description": "shorter description",
"type": "Workspace",
"state": "Removing",
"name": "a",
"hasWorkspaceLevelSettings": false,
"reports": [
{
"id": "5DBA60B0-D9A7-42AE-B12C-6D9D51E7739A",
"reportType": "PowerBIReport",
"name": "SQlAzure-Refresh",
"datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
},
{
"id": "197E5C3C-D2F3-42D8-A536-875FB6D7D48C",
"reportType": "PowerBIReport",
"name": "NESGames",
"datasetId": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69"
}
]
}
]
}
Get workspaces with their 'users' expanded example.
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$top=100
Sample Response
{
"value": [
{
"id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
"isReadOnly": false,
"isOnDedicatedCapacity": true,
"capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
"defaultDatasetStorageFormat": "Small",
"name": "Sample Group 1",
"description": "Sample group",
"type": "Workspace",
"state": "Active",
"hasWorkspaceLevelSettings": false,
"users": [
{
"emailAddress": "john@contoso.com",
"groupUserAccessRight": "Admin"
}
]
},
{
"id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
"isReadOnly": false,
"isOnDedicatedCapacity": false,
"name": "Sample Group 2",
"description": "Deleted sample group",
"type": "Workspace",
"state": "Deleted",
"users": []
}
]
}
Get workspaces with their 'workbooks' expanded example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=workbooks&$top=100
Sample Response
{
"value": [
{
"id": "94E57E92-CEE2-486D-8CC8-218C97200579",
"isReadOnly": false,
"isOnDedicatedCapacity": false,
"description": "shorter description",
"type": "Workspace",
"state": "Removing",
"hasWorkspaceLevelSettings": false,
"name": "a",
"workbooks": [
{
"name": "My Excel sheet",
"datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
}
]
}
]
}
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. Podzbiór zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI. |
Admin |
Metadane przepływu danych zwrócone przez interfejsy API Administracja. Poniżej znajduje się lista właściwości, które mogą być zwracane dla przepływu danych. W zależności od wywoływanego interfejsu API zostanie zwrócony tylko podzbiór właściwości, uprawnienia obiektu wywołującego i dostępność danych w bazie danych usługi Power BI. |
Admin |
Zestaw danych usługi Power BI zwracany przez interfejsy API Administracja. Interfejs API zwraca podzestaw następujących właściwości zestawu danych. 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 |
Grupa usługi Power BI zwrócona przez interfejsy API administratora |
Admin |
Otoka odpowiedzi OData dla listy grup usługi Power BI zwracanych przez interfejsy API Administracja |
Admin |
Raport usługi Power BI zwrócony przez interfejsy API Administracja. Interfejs API zwraca podzbiór następujących właściwości raportu. Podzbiór zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI. |
Admin |
Kafelek usługi Power BI zwrócony przez interfejsy API Administracja. |
Azure |
Odpowiedź szczegółowo opisująca należący do użytkownika zasób platformy Azure, taki jak obszar roboczy usługi Log Analytics. |
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ń) |
Dataflow |
Wpis prawa dostępu użytkownika usługi Power BI dla przepływu danych |
Dataflow |
Prawo dostępu, które użytkownik ma dla przepływu danych (poziom uprawnień) |
Dataset |
Wykonywanie zapytań dotyczących ustawień skalowania w poziomie zestawu danych |
Dataset |
Wpis prawa dostępu użytkownika usługi Power BI dla zestawu danych |
Dataset |
Prawo dostępu, które użytkownik ma dla zestawu danych (poziom uprawnień) |
Default |
Domyślny format magazynu zestawu danych w grupie |
Dependent |
Zależny od przepływu danych usługi Power BI |
Encryption |
Informacje o szyfrowaniu zestawu danych |
Encryption |
Stan szyfrowania zestawu danych |
Group |
Typ grupy |
Group |
Użytkownik usługi Power BI z dostępem do obszaru roboczego |
Group |
Prawo dostępu (poziom uprawnień), które użytkownik ma w obszarze roboczym |
Principal |
Typ podmiotu zabezpieczeń |
Report |
Wpis prawa dostępu użytkownika usługi Power BI dla raportu |
Report |
Prawo dostępu, które użytkownik ma dla raportu (poziom uprawnień) |
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 e-mail usługi Power BI |
Workbook |
Skoroszyt 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. Podzbiór 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 |
(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 dla raportu usługi Power BI można pobrać przy użyciu wywołania interfejsu API pobierania raportów jako Administracja. |
|
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 Pobierz użytkowników pulpitu nawigacyjnego 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 getDashboardsAsAdmin. |
AdminDataflow
Metadane przepływu danych zwrócone przez interfejsy API Administracja. Poniżej znajduje się lista właściwości, które mogą być zwracane dla przepływu danych. W zależności od wywoływanego interfejsu API zostanie zwrócony tylko podzbiór właściwości, uprawnienia obiektu wywołującego i dostępność danych w bazie danych usługi Power BI.
Nazwa | Typ | Opis |
---|---|---|
configuredBy |
string |
Właściciel przepływu danych |
description |
string |
Opis przepływu danych |
modelUrl |
string |
Adres URL pliku definicji przepływu danych (model.json) |
modifiedBy |
string |
Użytkownik, który zmodyfikował przepływ danych |
modifiedDateTime |
string |
Data i godzina ostatniej modyfikacji przepływu danych |
name |
string |
Nazwa przepływu danych |
objectId |
string |
Identyfikator przepływu danych |
users |
(Wartość pusta) Szczegóły dostępu użytkownika przepływu danych. Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o użytkowniku w przepływie danych usługi Power BI można pobrać przy użyciu wywołania interfejsu API Pobierania przepływów danych jako wywołania interfejsu API Administracja lub wywołania interfejsu API PostWorkspaceInfo za pomocą parametru |
|
workspaceId |
string |
Identyfikator obszaru roboczego przepływu danych. |
AdminDataset
Zestaw danych usługi Power BI zwracany przez interfejsy API Administracja. Interfejs API zwraca podzestaw następujących właściwości zestawu danych. 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 |
---|---|---|
ContentProviderType |
string |
Typ dostawcy zawartości dla zestawu danych |
CreateReportEmbedURL |
string |
Adres URL osadzania tworzenia raportu dla zestawu danych |
CreatedDate |
string |
Data i godzina utworzenia zestawu danych |
Encryption |
Informacje o szyfrowaniu zestawu danych. Ma zastosowanie tylko wtedy, gdy |
|
IsEffectiveIdentityRequired |
boolean |
Czy zestaw danych wymaga efektywnej tożsamości, którą należy wysłać w wywołaniu interfejsu API GenerateToken . |
IsEffectiveIdentityRolesRequired |
boolean |
Określa, czy zabezpieczenia na poziomie wiersza są definiowane wewnątrz pliku pbix usługi Power BI. Jeśli tak, musisz określić rolę. |
IsInPlaceSharingEnabled |
boolean |
Czy zestaw danych można udostępniać użytkownikom zewnętrznym do użycia we własnej dzierżawie |
IsOnPremGatewayRequired |
boolean |
Czy zestaw danych wymaga lokalnej bramy danych |
IsRefreshable |
boolean |
Niezależnie od tego, czy zestaw danych jest odświeżalny, czy nie. Odświeżany zestaw danych usługi Power BI to zestaw danych, który został odświeżony co najmniej raz lub dla którego istnieje prawidłowy harmonogram odświeżania. |
QnaEmbedURL |
string |
Adres URL osadzania zestawu danych Q& |
addRowsAPIEnabled |
boolean |
Czy zestaw danych umożliwia dodawanie nowych wierszy |
configuredBy |
string |
Właściciel zestawu danych |
description |
string |
Opis zestawu danych |
id |
string |
Identyfikator zestawu danych |
name |
string |
Nazwa zestawu danych |
queryScaleOutSettings |
Ustawienia skalowania zapytań w poziomie zestawu danych |
|
targetStorageMode |
string |
Tryb przechowywania zestawu danych |
upstreamDataflows |
Lista wszystkich przepływów danych, od których zależy ten element |
|
users |
(Wartość pusta) Szczegóły dostępu użytkownika zestawu danych. Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o użytkowniku w elemencie usługi Power BI (takim jak raport lub pulpit nawigacyjny) można pobrać przy użyciu interfejsu API Pobierz zestaw danych jako interfejsu API Administracja lub interfejsu API PostWorkspaceInfo z parametrem |
|
webUrl |
string |
Internetowy adres URL zestawu danych |
workspaceId |
string |
Identyfikator obszaru roboczego zestawu danych. Ta właściwość zostanie zwrócona tylko w getDatasetsAsAdmin. |
AdminGroup
Grupa usługi Power BI zwrócona przez interfejsy API administratora
Nazwa | Typ | Opis |
---|---|---|
capacityId |
string |
Identyfikator pojemności |
dashboards |
Pulpity nawigacyjne należące do grupy |
|
dataflowStorageId |
string |
Identyfikator konta magazynu przepływu danych usługi Power BI |
dataflows |
Przepływy danych należące do grupy |
|
datasets |
Zestawy danych należące do grupy |
|
defaultDatasetStorageFormat |
Domyślny format magazynu zestawu danych w obszarze roboczym. Zwracane tylko wtedy, gdy |
|
description |
string |
Opis grupy |
hasWorkspaceLevelSettings |
boolean |
Czy obszar roboczy ma ustawienia niestandardowe |
id |
string |
Identyfikator obszaru roboczego |
isOnDedicatedCapacity |
boolean |
Czy grupa jest przypisana do pojemności dedykowanej |
isReadOnly |
boolean |
Czy grupa jest tylko do odczytu |
logAnalyticsWorkspace |
Obszar roboczy usługi Log Analytics przypisany do grupy. Jest to zwracane tylko w przypadku pobierania pojedynczej grupy. |
|
name |
string |
Nazwa grupy |
pipelineId |
string |
Identyfikator potoku wdrażania, do którego jest przypisany obszar roboczy. |
reports |
Raporty należące do grupy |
|
state |
string |
Stan grupy |
type |
Zwracany typ grupy. |
|
users |
(Pusta wartość) Użytkownicy należący do grupy i ich prawa dostępu. Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o użytkowniku w elemencie usługi Power BI (takim jak raport lub pulpit nawigacyjny) można pobrać przy użyciu wywołania interfejsu API Pobierz użytkowników grupy jako Administracja lub wywołania interfejsu API PostWorkspaceInfo z parametrem |
|
workbooks |
Workbook[] |
Skoroszyty należące do grupy |
AdminGroups
Otoka odpowiedzi OData dla listy grup usługi Power BI zwracanych przez interfejsy API Administracja
Nazwa | Typ | Opis |
---|---|---|
odata.context |
string |
Kontekst OData |
value |
Lista grup |
AdminReport
Raport usługi Power BI zwrócony przez interfejsy API Administracja. Interfejs API zwraca podzbiór następujących właściwości raportu. Podzbiór 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 raport należy do aplikacji |
createdBy |
string |
Właściciel raportu. Dostępne tylko dla raportów utworzonych po czerwcu 2019 r. |
createdDateTime |
string |
Data i godzina utworzenia raportu |
datasetId |
string |
Identyfikator zestawu danych raportu |
description |
string |
Opis raportu |
embedUrl |
string |
Adres URL osadzania raportu |
id |
string |
Identyfikator raportu |
isOwnedByMe |
boolean |
Ustal, czy raport jest tworzony przez bieżącego użytkownika. |
modifiedBy |
string |
Ostatni użytkownik, który zmodyfikował raport |
modifiedDateTime |
string |
Data i godzina ostatniej modyfikacji raportu |
name |
string |
Nazwa raportu |
originalReportId |
string |
Rzeczywisty identyfikator raportu po opublikowaniu obszaru roboczego jako aplikacja. |
reportType |
enum:
|
Typ raportu |
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 dla raportu usługi Power BI można pobrać przy użyciu wywołania interfejsu API pobierania raportów jako Administracja. |
|
users |
(Pusta wartość) Szczegóły dostępu użytkownika dla raportu usługi Power BI. Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o użytkowniku w raporcie usługi Power BI można pobrać przy użyciu wywołania interfejsu API pobierania raportów jako Administracja lub wywołania interfejsu API PostWorkspaceInfo z parametrem |
|
webUrl |
string |
Internetowy adres URL raportu |
workspaceId |
string |
Identyfikator obszaru roboczego (GUID) raportu. Ta właściwość zostanie zwrócona tylko w getReportsAsAdmin. |
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 |
AzureResource
Odpowiedź szczegółowo opisująca należący do użytkownika zasób platformy Azure, taki jak obszar roboczy usługi Log Analytics.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu w usłudze Power BI. |
resourceGroup |
string |
Grupa zasobów w ramach subskrypcji, w której znajduje się zasób. |
resourceName |
string |
Nazwa zasobu. |
subscriptionId |
string |
Subskrypcja platformy Azure, w której znajduje się zasób. |
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 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 |
Przyznaje prawa dostępu do odczytu, zapisu i udostępniania dalej do zawartości w raporcie |
Read |
string |
Przyznaje dostęp do odczytu do zawartości na pulpicie nawigacyjnym |
ReadCopy |
string |
Przyznaje dostęp do odczytu i kopiowania do zawartości na pulpicie nawigacyjnym |
ReadReshare |
string |
Przyznaje dostęp do odczytu i udostępniania dalej zawartości na pulpicie nawigacyjnym |
ReadWrite |
string |
Przyznaje dostęp do odczytu i zapisu do zawartości na pulpicie nawigacyjnym |
DataflowUser
Wpis prawa dostępu użytkownika usługi Power BI dla przepływu danych
Nazwa | Typ | Opis |
---|---|---|
DataflowUserAccessRight |
Prawo dostępu, które użytkownik ma dla przepływu danych (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. |
DataflowUserAccessRight
Prawo dostępu, które użytkownik ma dla przepływu danych (poziom uprawnień)
Nazwa | Typ | Opis |
---|---|---|
None |
string |
Usuwa uprawnienia do zawartości w przepływie danych |
Owner |
string |
Przyznaje prawa dostępu do odczytu, zapisu i udostępniania dalej zawartości w przepływie danych |
Read |
string |
Przyznaje dostęp do odczytu do zawartości w przepływie danych |
ReadReshare |
string |
Przyznaje dostęp do odczytu i udostępniania dalej zawartości w przepływie danych |
ReadWrite |
string |
Przyznaje dostęp do odczytu i zapisu do zawartości w przepływie danych |
DatasetQueryScaleOutSettings
Wykonywanie zapytań dotyczących ustawień skalowania w poziomie zestawu danych
Nazwa | Typ | Opis |
---|---|---|
autoSyncReadOnlyReplicas |
boolean |
Czy zestaw danych automatycznie synchronizuje repliki tylko do odczytu |
maxReadOnlyReplicas |
integer |
Maksymalna liczba replik tylko do odczytu dla zestawu danych (0–64, -1 dla automatycznej liczby replik) |
DatasetUser
Wpis prawa dostępu użytkownika usługi Power BI dla zestawu danych
Nazwa | Typ | Opis |
---|---|---|
datasetUserAccessRight |
Prawo dostępu, które użytkownik ma dla zestawu danych (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. |
DatasetUserAccessRight
Prawo dostępu, które użytkownik ma dla zestawu danych (poziom uprawnień)
Nazwa | Typ | Opis |
---|---|---|
None |
string |
Usuwa uprawnienia do zawartości w zestawie danych |
Read |
string |
Przyznaje dostęp do odczytu do zawartości w zestawie danych |
ReadExplore |
string |
Przyznaje uprawnienia do odczytu i eksplorowania dostępu do zawartości w zestawie danych |
ReadReshare |
string |
Przyznaje dostęp do odczytu i udostępniania dalej do zawartości w zestawie danych |
ReadReshareExplore |
string |
Przyznaje uprawnienia do odczytu, udostępniania dalej i eksplorowania dostępu do zawartości w zestawie danych |
ReadWrite |
string |
Przyznaje dostęp do odczytu i zapisu do zawartości w zestawie danych |
ReadWriteExplore |
string |
Przyznaje dostęp do zawartości w zestawie danych: odczyt, zapis i eksplorowanie |
ReadWriteReshare |
string |
Udziela dostępu do odczytu, zapisu i udostępniania dalej zawartości w zestawie danych |
ReadWriteReshareExplore |
string |
Przyznaje dostęp do zawartości w zestawie danych: odczyt, zapis, udostępnianie dalej i eksplorowanie |
DefaultDatasetStorageFormat
Domyślny format magazynu zestawu danych w grupie
Nazwa | Typ | Opis |
---|---|---|
Large |
string |
Format dużego magazynu zestawu danych |
Small |
string |
Format magazynu małych zestawów danych |
DependentDataflow
Zależny od przepływu danych usługi Power BI
Nazwa | Typ | Opis |
---|---|---|
groupId |
string |
Identyfikator grupy docelowej |
targetDataflowId |
string |
Identyfikator docelowego przepływu danych |
Encryption
Informacje o szyfrowaniu zestawu danych
Nazwa | Typ | Opis |
---|---|---|
EncryptionStatus |
Stan szyfrowania zestawu danych |
EncryptionStatus
Stan szyfrowania zestawu danych
Nazwa | Typ | Opis |
---|---|---|
InSyncWithWorkspace |
string |
Szyfrowanie jest obsługiwane i jest synchronizowane z ustawieniami szyfrowania |
NotInSyncWithWorkspace |
string |
Szyfrowanie jest obsługiwane, ale nie jest zsynchronizowane z ustawieniami szyfrowania |
NotSupported |
string |
Szyfrowanie nie jest obsługiwane w przypadku tego zestawu danych |
Unknown |
string |
Stan szyfrowania jest nieznany z powodu uszkodzenia zestawu danych |
GroupType
Typ grupy
Nazwa | Typ | Opis |
---|---|---|
Group |
string |
Wersja 1 udostępnionego obszaru roboczego. Ten typ obszarów roboczych będzie przestarzały, ponieważ firma Microsoft migruje wszystkie obszary robocze do najnowszej wersji udostępnionego obszaru roboczego |
Personal |
string |
Specjalny typ obszaru roboczego przeznaczony dla listy programu SharePoint i integracji z usługą OneDrive |
PersonalGroup |
string |
"Mój obszar roboczy", znany również jako osobisty obszar roboczy |
Workspace |
string |
Udostępniony obszar roboczy lub prosty obszar roboczy używany do udostępniania zawartości innym użytkownikom w organizacji |
GroupUser
Użytkownik usługi Power BI z dostępem do obszaru roboczego
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. |
groupUserAccessRight |
Prawo dostępu (poziom uprawnień), które użytkownik ma w obszarze roboczym |
|
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. |
GroupUserAccessRight
Prawo dostępu (poziom uprawnień), które użytkownik ma w obszarze roboczym
Nazwa | Typ | Opis |
---|---|---|
Admin |
string |
Uprawnienia administratora do zawartości obszaru roboczego |
Contributor |
string |
Odczyt i eksplorowanie (ReadExplore) dostępu do zawartości obszaru roboczego |
Member |
string |
Odczytywanie, udostępnianie i eksplorowanie (ReadReshareExplore) praw dostępu do zawartości obszaru roboczego |
None |
string |
Brak dostępu do zawartości obszaru roboczego |
Viewer |
string |
Dostęp tylko do odczytu (odczyt) do zawartości obszaru roboczego |
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 |
ReportUser
Wpis prawa dostępu użytkownika usługi Power BI dla raportu
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. |
|
reportUserAccessRight |
Prawo dostępu, które użytkownik ma dla raportu (poziom uprawnień) |
|
userType |
string |
Typ użytkownika. |
ReportUserAccessRight
Prawo dostępu, które użytkownik ma dla raportu (poziom uprawnień)
Nazwa | Typ | Opis |
---|---|---|
None |
string |
Brak uprawnień do zawartości w raporcie |
Owner |
string |
Przyznaje prawa dostępu do odczytu, zapisu i udostępniania dalej do zawartości w raporcie |
Read |
string |
Przyznaje dostęp do odczytu do zawartości w raporcie |
ReadCopy |
string |
Przyznaje dostęp do odczytu i kopiowania do zawartości w raporcie |
ReadReshare |
string |
Udziela dostępu do odczytu i udostępniania dalej zawartości w raporcie |
ReadWrite |
string |
Przyznaje dostęp do odczytu i zapisu do zawartości w raporcie |
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 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. |
Workbook
Skoroszyt usługi Power BI
Nazwa | Typ | Opis |
---|---|---|
datasetId |
string |
Identyfikator zestawu danych skojarzonego ze skoroszytem. Ma zastosowanie tylko wtedy, gdy skoroszyt ma skojarzony zestaw danych. |
name |
string |
Nazwa skoroszytu |