Admin - Datasets GetDatasetsAsAdmin

Usługa:

Power BI REST APIs

Wersja interfejsu API:

v1.0

Zwraca listę zestawów danych 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 5 żądań na minutę na dzierżawę.

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

Z parametrami opcjonalnymi:

GET https://api.powerbi.com/v1.0/myorg/admin/datasets?$filter={$filter}&$top={$top}&$skip={$skip}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
$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	AdminDatasets	OK

Przykłady

Example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "addRowsAPIEnabled": false,
      "configuredBy": "john@contoso.com",
      "isRefreshable": true,
      "isEffectiveIdentityRequired": false,
      "isEffectiveIdentityRolesRequired": false,
      "isOnPremGatewayRequired": false,
      "isInPlaceSharingEnabled": false,
      "workspaceId": "5c968528-70b6-4588-809f-ce811ffa5c23"
    }
  ]
}

Definicje

Nazwa	Opis
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.
AdminDatasets	Otoka listy odata zestawu danych
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ń)
DependentDataflow	Zależny przepływ danych usługi Power BI
Encryption	Informacje o szyfrowaniu zestawu danych
EncryptionStatus	Stan szyfrowania zestawu danych
PrincipalType	Typ podmiotu zabezpieczeń
ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.

AdminDataset

Objekt

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	Przestarzała właściwość, która powinna być ignorowana.
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.
addRowsAPIEnabled	boolean	Czy zestaw danych umożliwia dodawanie nowych wierszy
configuredBy	string	Właściciel zestawu danych
createReportEmbedURL	string	Adres URL osadzania zestawu danych tworzenia raportu
createdDate	string (date-time)	Data i godzina utworzenia zestawu danych
description	string	Opis zestawu danych
id	string	Identyfikator zestawu danych
name	string	Nazwa zestawu danych
qnaEmbedURL	string	Zestaw danych Q&adres URL osadzania
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 (uuid)	Identyfikator obszaru roboczego zestawu danych. Ta właściwość zostanie zwrócona tylko w obszarze GetDatasetsAsAdmin.

AdminDatasets

Objekt

Otoka listy odata zestawu danych

Nazwa	Typ	Opis
@odata.context	string	Kontekst OData
value	AdminDataset[]	Zestawy danych

DatasetQueryScaleOutSettings

Objekt

Ustawienia skalowania zapytań w poziomie zestawu danych

Nazwa	Typ	Opis
autoSyncReadOnlyReplicas	boolean	Czy zestaw danych automatycznie synchronizuje repliki tylko do odczytu
maxReadOnlyReplicas	integer minimum: -1 maximum: 64	Maksymalna liczba replik tylko do odczytu dla zestawu danych (0–64, -1 dla automatycznej liczby replik)

DatasetUser

Objekt

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

Wyliczanie

Prawo dostępu, które użytkownik ma dla zestawu danych (poziom uprawnień)

Wartość	Opis
None	Usuwa uprawnienia do zawartości w zestawie danych
Read	Przyznaje dostęp do odczytu zawartości w zestawie danych
ReadExplore	Przyznaje dostęp do odczytu i eksplorowania zawartości w zestawie danych
ReadReshare	Przyznaje dostęp do odczytu i udostępniania dalej do zawartości w zestawie danych
ReadReshareExplore	Udziela uprawnień do odczytu, udostępniania dalej i eksplorowania dostępu do zawartości w zestawie danych
ReadWrite	Przyznaje dostęp do odczytu i zapisu do zawartości w zestawie danych
ReadWriteExplore	Udziela dostępu do odczytu, zapisu i eksplorowania zawartości w zestawie danych
ReadWriteReshare	Udziela dostępu do odczytu, zapisu i udostępniania dalej do zawartości w zestawie danych
ReadWriteReshareExplore	Przyznaje dostęp do zawartości w zestawie danych: odczyt, zapis, udostępnianie dalej i eksplorowanie

DependentDataflow

Objekt

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

Objekt

Informacje o szyfrowaniu zestawu danych

Nazwa	Typ	Opis
EncryptionStatus	EncryptionStatus	Stan szyfrowania zestawu danych

EncryptionStatus

Wyliczanie

Stan szyfrowania zestawu danych

Wartość	Opis
InSyncWithWorkspace	Szyfrowanie jest obsługiwane i jest synchronizowane z ustawieniami szyfrowania
NotInSyncWithWorkspace	Szyfrowanie jest obsługiwane, ale nie jest zsynchronizowane z ustawieniami szyfrowania
NotSupported	Szyfrowanie nie jest obsługiwane dla tego zestawu danych
Unknown	Stan szyfrowania jest nieznany z powodu uszkodzenia zestawu danych

PrincipalType

Wyliczanie

Typ podmiotu zabezpieczeń

Wartość	Opis
App	Typ jednostki usługi
Group	Typ podmiotu zabezpieczeń grupy
None	Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji.
User	Typ podmiotu zabezpieczeń użytkownika

ServicePrincipalProfile

Objekt

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 (uuid)	Identyfikator profilu jednostki usługi