Push Datasets - Datasets PostDataset

Usługa:: Power BI REST APIs

Wersja interfejsu API:: v1.0

Tworzy nowy zestaw danych w Mój obszar roboczy.

Wymagany zakres

Dataset.ReadWrite.All

Ograniczenia

To wywołanie interfejsu API obsługuje tylko zestawy danych wypychania . Aby uzyskać pełną listę ograniczeń, zobacz Ograniczenia zestawów danych wypychania.

POST https://api.powerbi.com/v1.0/myorg/datasets

Z parametrami opcjonalnymi:

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy={defaultRetentionPolicy}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
defaultRetentionPolicy	query		DefaultRetentionPolicy	Domyślne zasady przechowywania

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string	Nazwa zestawu danych
tables	True	Table[]	Tabele zestawu danych
datasources		Datasource[]	Źródła danych skojarzone z tym zestawem danych
defaultMode		DatasetMode	Tryb lub typ zestawu danych
relationships		Relationship[]	Relacje zestawu danych

Odpowiedzi

Nazwa	Typ	Opis
201 Created	Dataset	Utworzono
202 Accepted	Dataset	Zaakceptowano

Przykłady

Push example

Przykładowe żądanie

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy=basicFIFO

Treść żądania

{
  "name": "SalesMarketing",
  "defaultMode": "Push",
  "tables": [
    {
      "name": "Product",
      "columns": [
        {
          "name": "ProductID",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsCompete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        }
      ]
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:: 201

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "defaultRetentionPolicy": "basicFIFO"
}

Definicje

Nazwa	Opis
ASMashupExpression	Źródło tabeli zestawu danych
Column	Kolumna zestawu danych
CreateDatasetRequest	Zestaw danych usługi Power BI
CrossFilteringBehavior	Kierunek filtrowania relacji
Dataset	Zestaw danych usługi Power BI. 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.
DatasetMode	Tryb lub typ 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ń)
Datasource	Źródło danych usługi Power BI
DatasourceConnectionDetails	Szczegóły połączenia ze źródłem danych usługi Power BI. Zobacz przykłady Pobieranie źródeł danych lub Pobieranie źródeł danych w grupie.
DefaultRetentionPolicy	Domyślne zasady przechowywania
DependentDataflow	Zależny przepływ danych usługi Power BI
Encryption	Informacje o szyfrowaniu zestawu danych
EncryptionStatus	Stan szyfrowania zestawu danych
Measure	Miara usługi Power BI
PrincipalType	Typ podmiotu zabezpieczeń
Relationship	Relacja między tabelami w zestawie danych
Row	Wiersz danych w zestawie danych
ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
Table	Tabela zestawu danych

ASMashupExpression

Objekt

Źródło tabeli zestawu danych

Nazwa	Typ	Opis
expression	string	Wyrażenie źródłowe

Column

Objekt

Kolumna zestawu danych

Nazwa	Typ	Opis
dataCategory	string	Opcjonalny. Wartość ciągu, która ma być używana dla kategorii danych, która opisuje dane w tej kolumnie.
dataType	string	Typ danych kolumny
formatString	string	Opcjonalny. Format kolumny określony w FORMAT_STRING.
isHidden	boolean	Opcjonalny. Czy kolumna jest ukryta. Wartość domyślna to `false`.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Nazwa kolumny
sortByColumn	string	Opcjonalny. Nazwa ciągu kolumny w tej samej tabeli, która ma być używana do zamawiania bieżącej kolumny.
summarizeBy	string	Opcjonalny. Funkcja agregacji używana do podsumowywania tej kolumny.

CreateDatasetRequest

Objekt

Zestaw danych usługi Power BI

Nazwa	Typ	Opis
datasources	Datasource[]	Źródła danych skojarzone z tym zestawem danych
defaultMode	DatasetMode	Tryb lub typ zestawu danych
name	string	Nazwa zestawu danych
relationships	Relationship[]	Relacje zestawu danych
tables	Table[]	Tabele zestawu danych

CrossFilteringBehavior

Wyliczanie

Kierunek filtrowania relacji

Wartość	Opis
OneDirection	Do celów filtrowania filtr zostanie zastosowany w tabeli, w której są agregowane wartości.
BothDirections	Do celów filtrowania obie tabele są traktowane jako pojedyncza tabela.
Automatic	Zachowanie filtrowania krzyżowego jest definiowane automatycznie

Dataset

Objekt

Zestaw danych usługi Power BI. 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

DatasetMode

Wyliczanie

Tryb lub typ zestawu danych

Wartość	Opis
AsAzure	Zestaw danych z połączeniem na żywo z usługami Azure Analysis Services
AsOnPrem	Zestaw danych z połączeniem na żywo z lokalnymi usługami Azure Analysis Services
Push	Zestaw danych, który umożliwia dostęp programowy do wypychania danych do usługi Power BI
Streaming	Zestaw danych obsługujący przesyłanie strumieniowe danych. Aby uzyskać więcej informacji, zobacz Przesyłanie strumieniowe w czasie rzeczywistym w usłudze Power BI.
PushStreaming	Zestaw danych obsługujący przesyłanie strumieniowe danych i umożliwia dostęp programowy do wypychania danych do usługi Power BI

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
ReadWrite	Przyznaje dostęp do odczytu i zapisu do zawartości w zestawie danych
ReadReshare	Przyznaje dostęp do odczytu i udostępniania dalej do zawartości w zestawie danych
ReadWriteReshare	Udziela dostępu do odczytu, zapisu i udostępniania dalej do zawartości w zestawie danych
ReadExplore	Przyznaje dostęp do odczytu i eksplorowania zawartości w zestawie danych
ReadReshareExplore	Udziela uprawnień do odczytu, udostępniania dalej i eksplorowania dostępu do zawartości w zestawie danych
ReadWriteExplore	Udziela dostępu do odczytu, zapisu i eksplorowania zawartości w zestawie danych
ReadWriteReshareExplore	Przyznaje dostęp do zawartości w zestawie danych: odczyt, zapis, udostępnianie dalej i eksplorowanie

Datasource

Objekt

Źródło danych usługi Power BI

Nazwa	Typ	Opis
connectionDetails	DatasourceConnectionDetails	Szczegóły połączenia ze źródłem danych
connectionString	string	(Przestarzałe) Parametry połączenia ze źródłem danych. Dostępne tylko dla trybu DirectQuery.
datasourceId	string (uuid)	Powiązany identyfikator źródła danych, który jest pusty, gdy nie jest powiązany z bramą
datasourceType	string	Typ źródła danych
gatewayId	string (uuid)	Powiązany identyfikator bramy, który jest pusty, gdy nie jest powiązany z bramą. W przypadku korzystania z klastra bramy identyfikator bramy odnosi się do bramy podstawowej (pierwszej) w klastrze i jest podobny do identyfikatora klastra bramy.
name	string	(Przestarzałe) Nazwa źródła danych. Dostępne tylko dla trybu DirectQuery.

DatasourceConnectionDetails

Objekt

Szczegóły połączenia ze źródłem danych usługi Power BI. Zobacz przykłady Pobieranie źródeł danych lub Pobieranie źródeł danych w grupie.

Nazwa	Typ	Opis
account	string	Konto połączenia
classInfo	string	Informacje o klasie połączenia
database	string	Baza danych połączeń
domain	string	Domena połączenia
emailAddress	string	Adres e-mail połączenia
kind	string	Rodzaj połączenia
loginServer	string	Serwer logowania połączenia
path	string	Ścieżka połączenia
server	string	Serwer połączeń
url	string	Adres URL połączenia

DefaultRetentionPolicy

Wyliczanie

Domyślne zasady przechowywania

Wartość	Opis
None	Żaden
basicFIFO	basicFIFO

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
Unknown	Stan szyfrowania jest nieznany z powodu uszkodzenia zestawu danych
NotSupported	Szyfrowanie nie jest obsługiwane dla tego zestawu danych
InSyncWithWorkspace	Szyfrowanie jest obsługiwane i jest synchronizowane z ustawieniami szyfrowania
NotInSyncWithWorkspace	Szyfrowanie jest obsługiwane, ale nie jest zsynchronizowane z ustawieniami szyfrowania

Measure

Objekt

Miara usługi Power BI

Nazwa	Typ	Opis
description	string	Opcjonalny. Opis miary.
expression	string	Prawidłowe wyrażenie języka DAX
formatString	string	Opcjonalny. Ciąg opisujący sposób formatowania wartości, gdy jest on wyświetlany zgodnie z opisem w FORMAT_STRING.
isHidden	boolean	Opcjonalny. Czy miara jest ukryta.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Nazwa miary

PrincipalType

Wyliczanie

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

Relationship

Objekt

Relacja między tabelami w zestawie danych

Nazwa	Typ	Domyślna wartość	Opis
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	Kierunek filtrowania relacji
fromColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		Nazwa kolumny klucza obcego
fromTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		Nazwa tabeli kluczy obcych
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		Nazwa i identyfikator relacji
toColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		Nazwa kolumny klucza podstawowego
toTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		Nazwa tabeli kluczy podstawowych

Row

Objekt

Wiersz danych w zestawie danych

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator wiersza

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

Table

Objekt

Tabela zestawu danych

Nazwa	Typ	Opis
columns	Column[]	Schemat kolumny dla tej tabeli
description	string	Opis tabeli
isHidden	boolean	Opcjonalny. Czy ta tabela zestawów danych jest ukryta.
measures	Measure[]	Miary w tej tabeli
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$	Nazwa tabeli
rows	Row[]	Wiersze danych w tej tabeli
source	ASMashupExpression[]	Źródło tabeli

Udostępnij przez

Push Datasets - Datasets PostDataset

Wymagany zakres

Ograniczenia

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

Push example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ASMashupExpression

Column

CreateDatasetRequest

CrossFilteringBehavior

Dataset

DatasetMode

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

Datasource

DatasourceConnectionDetails

DefaultRetentionPolicy

DependentDataflow

Encryption

EncryptionStatus

Measure

PrincipalType

Relationship

Row

ServicePrincipalProfile

Table