Push Datasets - Datasets PostDataset

Référence

Service:: Power BI REST APIs

API Version:: v1.0

Crée un jeu de données sur Mon espace de travail.

Étendue requise

Dataset.ReadWrite.All

Limites

Cet appel d’API prend uniquement en charge les jeux de données push. Pour obtenir la liste complète des limitations, consultez Limitations des jeux de données push.

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

With optional parameters:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
defaultRetentionPolicy	query		DefaultRetentionPolicy	Stratégie de rétention par défaut

Corps de la demande

Nom	Obligatoire	Type	Description
name	True	string	Nom du jeu de données
tables	True	Table[]	Tables de jeu de données
datasources		Datasource[]	Sources de données associées à ce jeu de données
defaultMode		DatasetMode	Mode ou type de jeu de données
relationships		Relationship[]	Relations du jeu de données

Réponses

Nom	Type	Description
201 Created	Dataset	Date de création
202 Accepted	Dataset	Accepté

Exemples

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

Définitions

Nom	Description
ASMashupExpression	Une source de table de jeu de données
Column	Colonne d’un jeu de données
CreateDatasetRequest	Un jeu de données Power BI
CrossFilteringBehavior	Direction de filtre de la relation
Dataset	Jeu de données Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés du jeu de données. Le sous-ensemble dépend de l’API appelée, des autorisations de l’appelant et de la disponibilité des données dans la base de données Power BI.
DatasetMode	Mode ou type de jeu de données
DatasetQueryScaleOutSettings	Interroger les paramètres de scale-out d’un jeu de données
DatasetUser	Entrée de droit d’accès utilisateur Power BI pour un jeu de données
DatasetUserAccessRight	Droit d’accès dont dispose l’utilisateur pour le jeu de données (niveau d’autorisation)
Datasource	Une source de données Power BI
DatasourceConnectionDetails	Détails de connexion à la source de données Power BI. Consultez des exemples dans Obtenir des sources de données ou Obtenir des sources de données dans un groupe.
DefaultRetentionPolicy	Stratégie de rétention par défaut
DependentDataflow	Un flux de données dépendant de Power BI
Encryption	Informations de chiffrement pour un jeu de données
EncryptionStatus	status de chiffrement de jeu de données
Measure	Une mesure Power BI
PrincipalType	Type principal
Relationship	Relation entre les tables d’un jeu de données
Row	Ligne de données dans un jeu de données
ServicePrincipalProfile	Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.
Table	Table de jeu de données

ASMashupExpression

Une source de table de jeu de données

Nom	Type	Description
expression	string	Expression source

Column

Colonne d’un jeu de données

Nom	Type	Description
dataCategory	string	facultatif. Valeur de chaîne à utiliser pour la catégorie de données qui décrit les données dans cette colonne.
dataType	string	Type de données de colonne
formatString	string	facultatif. Format de la colonne tel que spécifié dans FORMAT_STRING.
isHidden	boolean	facultatif. Indique si la colonne est masquée. La valeur par défaut est `false`.
name	string	Nom de la colonne
sortByColumn	string	facultatif. Nom de chaîne d’une colonne dans la même table à utiliser pour trier la colonne en cours.
summarizeBy	string	Optionnel. Fonction d’agrégation à utiliser pour résumer cette colonne.

CreateDatasetRequest

Un jeu de données Power BI

Nom	Type	Description
datasources	Datasource[]	Sources de données associées à ce jeu de données
defaultMode	DatasetMode	Mode ou type de jeu de données
name	string	Nom du jeu de données
relationships	Relationship[]	Relations du jeu de données
tables	Table[]	Tables de jeu de données

CrossFilteringBehavior

Direction de filtre de la relation

Nom	Type	Description
Automatic	string	Le comportement de filtrage croisé est automatiquement défini
BothDirections	string	À des fins de filtrage, les deux tables sont traitées comme une table unique.
OneDirection	string	À des fins de filtrage, le filtre est appliqué sur la table où les valeurs sont agrégées.

Dataset

Jeu de données Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés du jeu de données. Le sous-ensemble dépend de l’API appelée, des autorisations de l’appelant et de la disponibilité des données dans la base de données Power BI.

Nom	Type	Description
ContentProviderType	string	Type de fournisseur de contenu pour le jeu de données
CreateReportEmbedURL	string	URL d’incorporation du jeu de données de création de rapport
CreatedDate	string	Date et heure de création du jeu de données
Encryption	Encryption	Informations de chiffrement de jeu de données. Applicable uniquement lorsque `$expand` est spécifié.
IsEffectiveIdentityRequired	boolean	Indique si le jeu de données nécessite une identité effective, que vous devez envoyer dans un appel d’API GenerateToken .
IsEffectiveIdentityRolesRequired	boolean	Indique si la sécurité au niveau des lignes est définie à l’intérieur du fichier .pbix Power BI. Si c’est le cas, vous devez spécifier un rôle.
IsInPlaceSharingEnabled	boolean	Si le jeu de données peut être partagé avec des utilisateurs externes à consommer dans leur propre locataire
IsOnPremGatewayRequired	boolean	Indique si le jeu de données nécessite une passerelle de données locale
IsRefreshable	boolean	Indique si le jeu de données peut être actualisé ou non. Un jeu de données actualisable Power BI est un jeu de données qui a été actualisé au moins une fois ou pour lequel une planification d’actualisation valide existe.
QnaEmbedURL	string	L’URL incorporée Q&A du jeu de données
addRowsAPIEnabled	boolean	Si le jeu de données autorise l’ajout de nouvelles lignes
configuredBy	string	Propriétaire du jeu de données
description	string	Description du jeu de données
id	string	ID du jeu de données
name	string	Nom du jeu de données
queryScaleOutSettings	DatasetQueryScaleOutSettings	Paramètres de scale-out de requête d’un jeu de données
targetStorageMode	string	Mode de stockage du jeu de données
upstreamDataflows	DependentDataflow[]	La liste de tous les flux de données dont dépend cet élément
users	DatasetUser[]	(Valeur vide) Détails de l’accès de l’utilisateur au jeu de données. Cette propriété sera supprimée de la réponse de charge utile dans une version à venir. Vous pouvez récupérer des informations utilisateur sur un élément Power BI (tel qu’un rapport ou un tableau de bord) à l’aide de l’API Get Dataset Users as Administration ou de l’API PostWorkspaceInfo avec le `getArtifactUsers` paramètre .
webUrl	string	URL web du jeu de données

DatasetMode

Mode ou type de jeu de données

Nom	Type	Description
AsAzure	string	Jeu de données avec une connexion active à Azure Analysis Services
AsOnPrem	string	Un jeu de données avec une connexion active à des Azure Analysis Services locales
Push	string	Jeu de données qui autorise l’accès par programmation pour envoyer des données dans Power BI
PushStreaming	string	Jeu de données qui prend en charge la diffusion en continu des données et autorise l’accès par programmation pour envoyer des données dans Power BI
Streaming	string	Jeu de données qui prend en charge le streaming de données. Pour plus d’informations, voir Streaming en temps réel dans Power BI.

DatasetQueryScaleOutSettings

Interroger les paramètres de scale-out d’un jeu de données

Nom	Type	Description
autoSyncReadOnlyReplicas	boolean	Indique si le jeu de données synchronise automatiquement les réplicas en lecture seule
maxReadOnlyReplicas	integer	Nombre maximal de réplicas en lecture seule pour le jeu de données (0-64, -1 pour le nombre automatique de réplicas)

DatasetUser

Entrée de droit d’accès utilisateur Power BI pour un jeu de données

Nom	Type	Description
datasetUserAccessRight	DatasetUserAccessRight	Droit d’accès dont dispose l’utilisateur pour le jeu de données (niveau d’autorisation)
displayName	string	Nom d’affichage du principal
emailAddress	string	Adresse e-mail de l’utilisateur
graphId	string	Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
identifier	string	Identificateur du principal
principalType	PrincipalType	Type principal
profile	ServicePrincipalProfile	Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.
userType	string	Type de l’utilisateur.

DatasetUserAccessRight

Droit d’accès dont dispose l’utilisateur pour le jeu de données (niveau d’autorisation)

Nom	Type	Description
None	string	Supprime l’autorisation d’accès au contenu dans le jeu de données
Read	string	Octroie l’accès en lecture au contenu dans le jeu de données
ReadExplore	string	Octroie l’accès lecture et exploration au contenu du jeu de données
ReadReshare	string	Octroie l’accès en lecture et repartage au contenu du jeu de données
ReadReshareExplore	string	Octroie l’accès en lecture, repartage et exploration au contenu du jeu de données
ReadWrite	string	Octroie l’accès en lecture et en écriture au contenu du jeu de données
ReadWriteExplore	string	Octroie l’accès en lecture, écriture et exploration au contenu du jeu de données
ReadWriteReshare	string	Octroie l’accès en lecture, écriture et repartage au contenu du jeu de données
ReadWriteReshareExplore	string	Octroie l’accès en lecture, écriture, repartage et exploration au contenu du jeu de données

Datasource

Une source de données Power BI

Nom	Type	Description
connectionDetails	DatasourceConnectionDetails	Détails de connexion à la source de données
connectionString	string	(Déconseillé) La source de données chaîne de connexion. Disponible uniquement pour DirectQuery.
datasourceId	string	ID de source de données liée, qui est vide lorsqu’il n’est pas lié à une passerelle
datasourceType	string	Type de source de données
gatewayId	string	ID de passerelle liée, qui est vide lorsqu’il n’est pas lié à une passerelle. Lors de l’utilisation d’un cluster de passerelle, l’ID de passerelle fait référence à la passerelle principale (première) du cluster et est similaire à l’ID de cluster de passerelle.
name	string	(Déconseillé) Nom de la source de données. Disponible uniquement pour DirectQuery.

DatasourceConnectionDetails

Détails de connexion à la source de données Power BI. Consultez des exemples dans Obtenir des sources de données ou Obtenir des sources de données dans un groupe.

Nom	Type	Description
account	string	Compte de connexion
classInfo	string	Informations sur la classe de connexion
database	string	Base de données de connexion
domain	string	Domaine de connexion
emailAddress	string	Adresse e-mail de connexion
kind	string	Type de connexion
loginServer	string	Serveur de connexion
path	string	Chemin de connexion
server	string	Serveur de connexion
url	string	URL de connexion

DefaultRetentionPolicy

Stratégie de rétention par défaut

Nom	Type	Description
None	string	None
basicFIFO	string	basicFIFO

DependentDataflow

Un flux de données dépendant de Power BI

Nom	Type	Description
groupId	string	ID du groupe cible
targetDataflowId	string	ID de flux de données cible

Encryption

Informations de chiffrement pour un jeu de données

Nom	Type	Description
EncryptionStatus	EncryptionStatus	status de chiffrement de jeu de données

EncryptionStatus

status de chiffrement de jeu de données

Nom	Type	Description
InSyncWithWorkspace	string	Le chiffrement est pris en charge et est synchronisé avec les paramètres de chiffrement
NotInSyncWithWorkspace	string	Le chiffrement est pris en charge, mais n’est pas synchronisé avec les paramètres de chiffrement
NotSupported	string	Le chiffrement n’est pas pris en charge pour ce jeu de données
Unknown	string	Le status de chiffrement est inconnu en raison d’une altération du jeu de données

Measure

Une mesure Power BI

Nom	Type	Description
description	string	facultatif. Description de la mesure.
expression	string	Expression DAX valide
formatString	string	facultatif. Chaîne décrivant comment la valeur doit être mise en forme lorsqu’elle est affichée comme spécifié dans FORMAT_STRING.
isHidden	boolean	facultatif. Indique si la mesure est masquée.
name	string	Nom de la mesure

PrincipalType

Type principal

Nom	Type	Description
App	string	Type de principal de service
Group	string	Type de principal de groupe
None	string	Aucun type de principal. Utilisez pour un accès entier organization niveau.
User	string	Type de principal d’utilisateur

Relationship

Relation entre les tables d’un jeu de données

Nom	Type	Valeur par défaut	Description
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	Direction de filtre de la relation
fromColumn	string		Nom de la colonne de clé étrangère
fromTable	string		Nom de la table de clés étrangères
name	string		Nom et identificateur de la relation
toColumn	string		Nom de la colonne de clé primaire
toTable	string		Nom de la table de clé primaire

Row

Ligne de données dans un jeu de données

Nom	Type	Description
id	string	ID de ligne unique

ServicePrincipalProfile

Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.

Nom	Type	Description
displayName	string	Nom du profil de principal de service
id	string	ID de profil du principal de service

Table

Table de jeu de données

Nom	Type	Description
columns	Column[]	Schéma de colonne pour cette table
description	string	Description de la table
isHidden	boolean	facultatif. Indique si cette table de jeu de données est masquée.
measures	Measure[]	Mesures de cette table
name	string	Le nom de la table
rows	Row[]	Lignes de données de cette table
source	ASMashupExpression[]	Source de la table