Push Datasets - Datasets PostDataset

Odwołanie

Service:: Power BI REST APIs

API Version:: v1.0

Tworzy nowy zestaw danych w obszarze Mój obszar roboczy.

Zakres wymagany

Dataset.ReadWrite.All

Ograniczenia

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

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

With optional parameters:

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	Utworzone
202 Accepted	Dataset	Zaakceptowano

Przykłady

Push example

Sample Request

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

Request Body

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

Sample Response

Status code:: 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 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.
DatasetMode	Tryb lub typ zestawu danych
DatasetQueryScaleOutSettings	Wykonywanie zapytań dotyczących ustawień skalowania 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 źródła danych usługi Power BI. Zobacz przykłady w temacie Pobieranie źródeł danych lub Pobieranie źródeł danych w grupie.
DefaultRetentionPolicy	Domyślne zasady przechowywania
DependentDataflow	Zależny od przepływu 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 główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.
Table	Tabela zestawu danych

ASMashupExpression

Źródło tabeli zestawu danych

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

Column

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	Nazwa kolumny
sortByColumn	string	Opcjonalny. Nazwa ciągu kolumny w tej samej tabeli, która ma być używana do porządkowania bieżącej kolumny.
summarizeBy	string	Opcjonalny. Funkcja agregacji do użycia do podsumowania tej kolumny.

CreateDatasetRequest

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

Kierunek filtrowania relacji

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

Dataset

Zestaw danych usługi Power BI. 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	Encryption	Informacje o szyfrowaniu zestawu danych. Ma zastosowanie tylko wtedy, gdy `$expand` zostanie określony.
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	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[]	(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 `getArtifactUsers` .
webUrl	string	Internetowy adres URL zestawu danych

DatasetMode

Tryb lub typ zestawu danych

Nazwa	Typ	Opis
AsAzure	string	Zestaw danych z połączeniem na żywo z Azure Analysis Services
AsOnPrem	string	Zestaw danych z połączeniem na żywo z lokalnymi Azure Analysis Services
Push	string	Zestaw danych, który umożliwia dostęp programowy do wypychania danych do usługi Power BI
PushStreaming	string	Zestaw danych obsługujący przesyłanie strumieniowe danych i umożliwia programowy dostęp do wypychania danych do usługi Power BI
Streaming	string	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.

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	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	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	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

Datasource

Ź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) Źródło danych parametry połączenia. Dostępne tylko dla trybu DirectQuery.
datasourceId	string	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	Powiązany identyfikator bramy, który jest pusty, gdy nie jest powiązany z bramą. W przypadku korzystania z klastra bramy identyfikator bramy odwołuje się do podstawowej (pierwszej) bramy 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

Szczegóły połączenia źródła danych usługi Power BI. Zobacz przykłady w temacie 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

Domyślne zasady przechowywania

Nazwa	Typ	Opis
None	string	Brak
basicFIFO	string	basicFIFO

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

Measure

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 po wyświetleniu jej zgodnie z FORMAT_STRING.
isHidden	boolean	Opcjonalny. Czy miara jest ukryta.
name	string	Nazwa miary

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

Relationship

Relacja między tabelami w zestawie danych

Nazwa	Typ	Wartość domyślna	Opis
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	Kierunek filtrowania relacji
fromColumn	string		Nazwa kolumny klucza obcego
fromTable	string		Nazwa tabeli kluczy obcych
name	string		Nazwa i identyfikator relacji
toColumn	string		Nazwa kolumny klucza podstawowego
toTable	string		Nazwa tabeli klucza podstawowego

Row

Wiersz danych w zestawie danych

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator wiersza

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

Table

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	Nazwa tabeli
rows	Row[]	Wiersze danych w tej tabeli
source	ASMashupExpression[]	Źródło tabeli