Admin - Groups GetGroupsAsAdmin

Odwołanie

Usługa:: Power BI REST APIs

Wersja interfejsu API:: v1.0

Zwraca listę obszarów roboczych 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

Maksymalnie 50 żądań na godzinę lub 15 żądań na minutę na dzierżawę. To wywołanie spowoduje również przekroczenie limitu czasu po upływie 30 sekund, aby zapobiec niekorzystnemu wpływowi na usługę Power BI.

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$top={$top}

Z parametrami opcjonalnymi:

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 `users`, `reports`, `dashboards`, `datasets`, `dataflows`i `workbooks`.
$filter	query		string	Zwraca podzbiór wyników na podstawie warunku parametru zapytania filtru Odata.
$skip	query		integer int32	Pomija pierwsze n wyników. Użyj funkcji z góry, aby pobrać wyniki poza pierwszym 5000.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AdminGroups	OK

Przykłady

Get deleted workspaces example.

Get orphaned workspaces example.

Get workspaces with their 'dashboards' expanded example

Get workspaces with their 'datasets' expanded example

Get workspaces with their 'datasets' expanded example.

Get workspaces with their 'reports' expanded example

Get workspaces with their 'users' expanded example.

Get workspaces with their 'workbooks' expanded example

Get deleted workspaces example.

Przykładowe żądanie

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$filter=state eq 'Deleted'&$top=100

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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.

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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

Przykładowe żądanie

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=dashboards&$top=100

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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

Przykładowe żądanie

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets&$top=100

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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.

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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

Przykładowe żądanie

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=reports&$top=100

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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.

Przykładowe żądanie

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$top=100

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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

Przykładowe żądanie

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=workbooks&$top=100

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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
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.
AdminDataflow	Metadane przepływu danych zwrócone przez interfejsy API administratora. 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.
AdminDataset	Zestaw danych usługi Power BI zwracany przez interfejsy API administratora. Interfejs API zwraca podzbiór poniższych 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.
AdminGroup	Grupa usługi Power BI zwrócona przez interfejsy API administratora
AdminGroups	Otoka odpowiedzi OData dla listy grup usługi Power BI zwracanych przez interfejsy API administratora
AdminReport	Raport usługi Power BI zwrócony przez interfejsy API administratora. Interfejs API zwraca podzestaw następujących właściwości raportu. Podzestaw zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI.
AdminTile	Kafelek usługi Power BI zwrócony przez interfejsy API administratora.
AzureResource	Odpowiedź z opisem zasobu platformy Azure należącego do użytkownika, takiego jak obszar roboczy usługi Log Analytics.
DashboardUser	Wpis prawa dostępu użytkownika usługi Power BI dla pulpitu nawigacyjnego
DashboardUserAccessRight	Prawo dostępu, które użytkownik ma dla pulpitu nawigacyjnego (poziom uprawnień)
DataflowUser	Wpis prawa dostępu użytkownika usługi Power BI dla przepływu danych
DataflowUserAccessRight	Prawo dostępu, które użytkownik ma dla przepływu danych (poziom uprawnień)
DatasetQueryScaleOutSettings	Ustawienia skalowania zapytań w poziomie zestawu danych
DatasetUser	Wpis prawa dostępu użytkownika usługi Power BI dla zestawu danych
DatasetUserAccessRight	Prawo dostępu, które użytkownik ma dla zestawu danych (poziom uprawnień)
DefaultDatasetStorageFormat	Domyślny format magazynu zestawu danych w grupie
DependentDataflow	Zależny przepływ danych usługi Power BI
Encryption	Informacje o szyfrowaniu zestawu danych
EncryptionStatus	Stan szyfrowania zestawu danych
GroupType	Typ grupy
GroupUser	Użytkownik usługi Power BI z dostępem do obszaru roboczego
GroupUserAccessRight	Prawo dostępu (poziom uprawnień), który użytkownik ma w obszarze roboczym
PrincipalType	Typ podmiotu zabezpieczeń
ReportUser	Wpis prawa dostępu użytkownika usługi Power BI dla raportu
ReportUserAccessRight	Prawo dostępu, które użytkownik ma dla raportu (poziom uprawnień)
ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
Subscription	Subskrypcja poczty e-mail dla elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
SubscriptionUser	Użytkownik subskrypcji poczty e-mail usługi Power BI
Workbook	Skoroszyt 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	Identyfikator pulpitu nawigacyjnego
isReadOnly	boolean	Czy pulpit nawigacyjny jest tylko do odczytu
subscriptions	Subscription[]	(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 Pobierz subskrypcje raportów jako wywołanie interfejsu API administratora.
tiles	AdminTile[]	Kafelki należące do pulpitu nawigacyjnego
users	DashboardUser[]	(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 administratora Pobierz użytkowników pulpitu nawigacyjnego lub wywołania interfejsu API PostWorkspaceInfo z parametrem `getArtifactUsers`.
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.

AdminDataflow

Metadane przepływu danych zwrócone przez interfejsy API administratora. 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)
name	string	Nazwa przepływu danych
objectId	string	Identyfikator przepływu danych
users	DataflowUser[]	(Pusta wartość) 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 administratora Pobierz użytkowników przepływu danych lub wywołania interfejsu API PostWorkspaceInfo z parametrem `getArtifactUser`.
workspaceId	string	Identyfikator obszaru roboczego przepływu danych.

AdminDataset

Zestaw danych usługi Power BI zwracany przez interfejsy API administratora. Interfejs API zwraca podzbiór poniższych 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 zestawu danych tworzenia raportu
Encryption	Encryption	Informacje o szyfrowaniu zestawu danych. Ma zastosowanie tylko wtedy, gdy określono `$expand`.
IsEffectiveIdentityRequired	boolean	Czy zestaw danych wymaga obowiązującej 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ą zdefiniowane wewnątrz pliku pbix usługi Power BI. Jeśli tak, musisz określić rolę.
IsInPlaceSharingEnabled	boolean	Czy zestaw danych może być udostępniany użytkownikom zewnętrznym do użycia we własnej dzierżawie
IsOnPremGatewayRequired	boolean	Czy zestaw danych wymaga lokalnej bramy danych
IsRefreshable	boolean	To pole zwraca `true`, gdy zestaw danych jest ostatnio odświeżony lub jest skonfigurowany do automatycznego odświeżania, a tryb połączenia został specjalnie ustawiony na "Importuj". Wartość zwróci `false` dla innych trybów połączenia, takich jak "DirectQuery" i "LiveConnection", niezależnie od tego, czy zestaw danych jest ręcznie odświeżany, czy skonfigurowany do automatycznego odświeżania.
QnaEmbedURL	string	Zestaw danych Q&adres URL osadzania
addRowsAPIEnabled	boolean	Czy zestaw danych umożliwia dodawanie nowych wierszy
configuredBy	string	Właściciel zestawu danych
createdDate	string	Data i godzina utworzenia zestawu danych
description	string	Opis zestawu danych
id	string	Identyfikator zestawu danych
name	string	Nazwa zestawu danych
queryScaleOutSettings	DatasetQueryScaleOutSettings	Ustawienia skalowania zapytań w poziomie zestawu danych
targetStorageMode	string	Tryb przechowywania zestawu danych
upstreamDataflows	DependentDataflow[]	Lista wszystkich przepływów danych, od których zależy ten element
users	DatasetUser[]	(Pusta wartość) 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 Pobierz użytkowników zestawu danych jako interfejsu API administratora lub interfejsu API PostWorkspaceInfo za pomocą parametru `getArtifactUsers`.
webUrl	string	Internetowy adres URL zestawu danych
workspaceId	string	Identyfikator obszaru roboczego zestawu danych. Ta właściwość zostanie zwrócona tylko w obszarze GetDatasetsAsAdmin.

AdminGroup

Grupa usługi Power BI zwrócona przez interfejsy API administratora

Nazwa	Typ	Opis
capacityId	string	Identyfikator pojemności
dashboards	AdminDashboard[]	Pulpity nawigacyjne należące do grupy
dataflowStorageId	string	Identyfikator konta magazynu przepływu danych usługi Power BI
dataflows	AdminDataflow[]	Przepływy danych należące do grupy
datasets	AdminDataset[]	Zestawy danych należące do grupy
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Domyślny format magazynu zestawu danych w obszarze roboczym. Zwracane tylko wtedy, gdy `isOnDedicatedCapacity` jest `true`
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	AzureResource	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 przypisany do obszaru roboczego.
reports	AdminReport[]	Raporty należące do grupy
state	string	Stan grupy
type	GroupType	Zwracany typ grupy.
users	GroupUser[]	(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 Uzyskiwanie użytkowników grupy jako administrator lub wywołania interfejsu API PostWorkspaceInfo z parametrem `getArtifactUsers`.
workbooks	Workbook[]	Skoroszyty należące do grupy

AdminGroups

Otoka odpowiedzi OData dla listy grup usługi Power BI zwracanych przez interfejsy API administratora

Nazwa	Typ	Opis
@odata.context	string	Kontekst OData
value	AdminGroup[]	Lista grup

AdminReport

Raport usługi Power BI zwrócony przez interfejsy API administratora. Interfejs API zwraca podzestaw następujących właściwości raportu. 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 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: PaginatedReport PowerBIReport	Typ raportu
subscriptions	Subscription[]	(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 Pobierz subskrypcje raportów jako wywołanie interfejsu API administratora.
users	ReportUser[]	(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 administratora Pobierz użytkowników raportów lub wywołania interfejsu API PostWorkspaceInfo z parametrem `getArtifactUsers`.
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 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 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ź z opisem zasobu platformy Azure należącego do użytkownika, takiego 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	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	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
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	Przyznaje dostęp 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 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	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 administratorów.
identifier	string	Identyfikator podmiotu zabezpieczeń
principalType	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
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	Udziela dostępu do odczytu, zapisu i udostępniania dalej do zawartości w przepływie danych
Read	string	Przyznaje dostęp do odczytu do zawartości w przepływie danych
ReadReshare	string	Udziela dostępu 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

Ustawienia skalowania zapytań 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	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 administratorów.
identifier	string	Identyfikator podmiotu zabezpieczeń
principalType	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
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 zawartości w zestawie danych
ReadExplore	string	Przyznaje dostęp do odczytu i eksplorowania zawartości w zestawie danych
ReadReshare	string	Przyznaje dostęp do odczytu i udostępniania dalej do zawartości w zestawie danych
ReadReshareExplore	string	Udziela uprawnień 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	Udziela dostępu do odczytu, zapisu i eksplorowania zawartości w zestawie danych
ReadWriteReshare	string	Udziela dostępu do odczytu, zapisu i udostępniania dalej do 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 magazynu dużych zestawów danych
Small	string	Format magazynu małych zestawów danych

DependentDataflow

Zależny przepływ 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	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 dla tego zestawu danych
Unknown	string	Stan szyfrowania jest nieznany z powodu uszkodzenia zestawu danych

GroupType

Typ grupy

Nazwa	Typ	Opis
AdminWorkspace	string	Monitorowanie administracyjne dla administratorów sieci szkieletowej
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 administratorów.
groupUserAccessRight	GroupUserAccessRight	Prawo dostępu (poziom uprawnień), który użytkownik ma w obszarze roboczym
identifier	string	Identyfikator podmiotu zabezpieczeń
principalType	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
userType	string	Typ użytkownika.

GroupUserAccessRight

Prawo dostępu (poziom uprawnień), który 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ęp do zawartości obszaru roboczego
Member	string	Odczyt, ponowne 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 administratorów.
identifier	string	Identyfikator podmiotu zabezpieczeń
principalType	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
reportUserAccessRight	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	Udziela dostępu do odczytu, zapisu i udostępniania dalej do zawartości w raporcie
Read	string	Przyznaje dostęp do odczytu zawartości w raporcie
ReadCopy	string	Przyznaje dostęp do odczytu i kopiowania zawartości w raporcie
ReadReshare	string	Udziela dostępu do odczytu i udostępniania dalej zawartości w raporcie
ReadWrite	string	Udziela dostępu do odczytu i zapisu do zawartości w raporcie

ServicePrincipalProfile

Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.

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 `Report`, `Dashboard`lub `Dataset`)
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	SubscriptionUser[]	Szczegóły poszczególnych subskrybentów poczty e-mail. W przypadku używania wywołania interfejsu API Pobierz subskrypcje użytkowników jako administrator 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 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	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
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

Udostępnij za pośrednictwem

Admin - Groups GetGroupsAsAdmin

Uprawnienia

Wymagany zakres

Ograniczenia

Parametry identyfikatora URI

Odpowiedzi

Przykłady

Get deleted workspaces example.

Przykładowe żądanie

Przykładowa odpowiedź

Get orphaned workspaces example.

Przykładowe żądanie

Przykładowa odpowiedź

Get workspaces with their 'dashboards' expanded example

Przykładowe żądanie

Przykładowa odpowiedź

Get workspaces with their 'datasets' expanded example

Przykładowe żądanie

Przykładowa odpowiedź

Get workspaces with their 'datasets' expanded example.

Przykładowe żądanie

Przykładowa odpowiedź

Get workspaces with their 'reports' expanded example

Przykładowe żądanie

Przykładowa odpowiedź

Get workspaces with their 'users' expanded example.

Przykładowe żądanie

Przykładowa odpowiedź

Get workspaces with their 'workbooks' expanded example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AdminDashboard

AdminDataflow

AdminDataset

AdminGroup

AdminGroups

AdminReport

AdminTile

AzureResource

DashboardUser

DashboardUserAccessRight

DataflowUser

DataflowUserAccessRight

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DefaultDatasetStorageFormat

DependentDataflow

Encryption

EncryptionStatus

GroupType

GroupUser

GroupUserAccessRight

PrincipalType

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

Workbook

Dodatkowe zasoby