Push Datasets - Datasets PostDataset

Service:: Power BI REST APIs

Version d'API:: 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 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

Avec des paramètres facultatifs:

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 jeux de données
datasources		Datasource[]	Sources de données associées à ce jeu de données
defaultMode		DatasetMode	Mode ou type du jeu de données
relationships		Relationship[]	Relations de jeu de données

Réponses

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

Exemples

Push example

Exemple de requête

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

Corps de la demande

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

Exemple de réponse

Code d’état:: 201

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

Définitions

Nom	Description
ASMashupExpression	Source d’une table de jeux de données
Column	Colonne de jeu de données
CreateDatasetRequest	Un jeu de données Power BI
CrossFilteringBehavior	Direction du filtre de la relation
Dataset	Jeu de données Power BI. L’API retourne un sous-ensemble de la liste suivante des propriétés du jeu de données. Le sous-ensemble dépend de l’API appelée, des autorisations d’appelant et de la disponibilité des données dans la base de données Power BI.
DatasetMode	Mode ou type du 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 que l’utilisateur a pour le jeu de données (niveau d’autorisation)
Datasource	Source de données Power BI
DatasourceConnectionDetails	Détails de la 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 lede groupe.
DefaultRetentionPolicy	Stratégie de rétention par défaut
DependentDataflow	Flux de données dépendant de Power BI
Encryption	Informations de chiffrement pour un jeu de données
EncryptionStatus	État du chiffrement du jeu de données
Measure	Une mesure Power BI
PrincipalType	Type de principal
Relationship	Relation entre les tables d’un jeu de données
Row	Une ligne de données dans un jeu de données
ServicePrincipalProfile	Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
Table	Table de jeux de données

ASMashupExpression

Object

Source d’une table de jeux de données

Nom	Type	Description
expression	string	Expression source

Column

Object

Colonne de jeu de données

Nom	Type	Description
dataCategory	string	Optionnel. Valeur de chaîne à utiliser pour la catégorie de données qui décrit les données de cette colonne.
dataType	string	Type de données de colonne
formatString	string	Optionnel. Format de la colonne comme spécifié dans FORMAT_STRING.
isHidden	boolean	Optionnel. Indique si la colonne est masquée. La valeur par défaut est `false`.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Nom de la colonne
sortByColumn	string	Optionnel. Nom de chaîne d’une colonne dans la même table à utiliser pour classer la colonne active.
summarizeBy	string	Optionnel. Fonction d’agrégation à utiliser pour résumer cette colonne.

CreateDatasetRequest

Object

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 du jeu de données
name	string	Nom du jeu de données
relationships	Relationship[]	Relations de jeu de données
tables	Table[]	Tables de jeux de données

CrossFilteringBehavior

Énumération

Direction du filtre de la relation

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

Dataset

Object

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

Nom	Type	Description
ContentProviderType	string	Propriété déconseillée qui doit être ignorée.
Encryption	Encryption	Informations de chiffrement du 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. Dans ce cas, vous devez spécifier un rôle.
IsInPlaceSharingEnabled	boolean	Indique 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	Ce champ retourne `true` lorsque le jeu de données est récemment actualisé ou configuré pour l’actualisation automatique, avec le mode de connexion spécifiquement défini sur « Importer ». La valeur retourne `false` pour d’autres modes de connexion, tels que « DirectQuery » et « LiveConnection », que le jeu de données soit actualisé manuellement ou configuré pour l’actualisation automatique.
addRowsAPIEnabled	boolean	Indique si le jeu de données autorise l’ajout de nouvelles lignes
configuredBy	string	Propriétaire du jeu de données
createReportEmbedURL	string	Le jeu de données crée une URL d’incorporation de rapport
createdDate	string (date-time)	Date et heure de création 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
qnaEmbedURL	string	Le jeu de données Q&UNE URL incorporée
queryScaleOutSettings	DatasetQueryScaleOutSettings	Interroger les paramètres de scale-out 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 prochaine version. 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 du Obtenir des utilisateurs de jeu de données en tant qu’API d’administration, ou de l’API PostWorkspaceInfo avec le paramètre `getArtifactUsers`.
webUrl	string	URL web du jeu de données

DatasetMode

Énumération

Mode ou type du jeu de données

Valeur	Description
AsAzure	Jeu de données avec une connexion active à Azure Analysis Services
AsOnPrem	Jeu de données avec une connexion dynamique à Azure Analysis Services local
Push	Jeu de données qui autorise l’accès par programmation pour envoyer (push) des données dans Power BI
Streaming	Jeu de données qui prend en charge la diffusion en continu des données. Pour plus d’informations, voir Streaming en temps réel dans Power BI.
PushStreaming	Jeu de données prenant en charge le streaming des données et autorisant l’accès par programmation pour envoyer (push) des données dans Power BI

DatasetQueryScaleOutSettings

Object

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 minimum: -1 maximum: 64	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

Object

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 que l’utilisateur a pour le jeu de données (niveau d’autorisation)
displayName	string	Nom complet 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 de principal
profile	ServicePrincipalProfile	Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType	string	Type de l’utilisateur.

DatasetUserAccessRight

Énumération

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

Valeur	Description
None	Supprime l’autorisation du contenu dans le jeu de données
Read	Octroie l’accès en lecture au contenu dans le jeu de données
ReadWrite	Octroie l’accès en lecture et écriture au contenu du jeu de données
ReadReshare	Accorde l’accès en lecture et repartage au contenu du jeu de données
ReadWriteReshare	Accorde l’accès en lecture, écriture et partage à nouveau au contenu du jeu de données
ReadExplore	Octroie l’accès en lecture et explorer au contenu du jeu de données
ReadReshareExplore	Accorde l’accès en lecture, repartage et exploration du contenu dans le jeu de données
ReadWriteExplore	Accorde l’accès en lecture, écriture et exploration au contenu du jeu de données
ReadWriteReshareExplore	Accorde l’accès en lecture, écriture, partage et exploration du contenu dans le jeu de données

Datasource

Object

Source de données Power BI

Nom	Type	Description
connectionDetails	DatasourceConnectionDetails	Détails de la connexion à la source de données
connectionString	string	(Déconseillé) Chaîne de connexion à la source de données. Disponible uniquement pour DirectQuery.
datasourceId	string (uuid)	ID de source de données lié, qui est vide lorsqu’il n’est pas lié à une passerelle
datasourceType	string	Type de source de données
gatewayId	string (uuid)	ID de passerelle lié, qui est vide lorsqu’il n’est pas lié à une passerelle. Lorsque vous utilisez 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

Object

Détails de la 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 lede 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	Le serveur de connexion de connexion
path	string	Chemin d’accès de connexion
server	string	Le serveur de connexion
url	string	URL de connexion

DefaultRetentionPolicy

Énumération

Stratégie de rétention par défaut

Valeur	Description
None	Aucun
basicFIFO	basicFIFO

DependentDataflow

Object

Flux de données dépendant de Power BI

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

Encryption

Object

Informations de chiffrement pour un jeu de données

Nom	Type	Description
EncryptionStatus	EncryptionStatus	État du chiffrement du jeu de données

EncryptionStatus

Énumération

État du chiffrement du jeu de données

Valeur	Description
Unknown	L’état du chiffrement est inconnu en raison de l’altération du jeu de données
NotSupported	Le chiffrement n’est pas pris en charge pour ce jeu de données
InSyncWithWorkspace	Le chiffrement est pris en charge et est synchronisé avec les paramètres de chiffrement
NotInSyncWithWorkspace	Le chiffrement est pris en charge, mais n’est pas synchronisé avec les paramètres de chiffrement

Measure

Object

Une mesure Power BI

Nom	Type	Description
description	string	Optionnel. Description de la mesure.
expression	string	Expression DAX valide
formatString	string	Optionnel. Chaîne décrivant la façon dont la valeur doit être mise en forme lorsqu’elle est affichée comme spécifié dans FORMAT_STRING.
isHidden	boolean	Optionnel. Indique si la mesure est masquée.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Nom de la mesure

PrincipalType

Énumération

Type de principal

Valeur	Description
None	Aucun type de principal. Utiliser pour l’ensemble de l’accès au niveau de l’organisation.
User	Type de principal de l’utilisateur
Group	Type de principal de groupe
App	Type de principal de service

Relationship

Object

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

Nom	Type	Valeur par défaut	Description
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	Direction du filtre de la relation
fromColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		Nom de la colonne de clé étrangère
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}$		Nom de la table de clés étrangères
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}$		Nom et identificateur de la relation
toColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		Nom de la colonne de clé primaire
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}$		Nom de la table de clés primaires

Row

Object

Une ligne de données dans un jeu de données

Nom	Type	Description
id	string	ID de ligne unique

ServicePrincipalProfile

Object

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.

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

Table

Object

Table de jeux de données

Nom	Type	Description
columns	Column[]	Schéma de colonne pour cette table
description	string	Description du tableau
isHidden	boolean	Optionnel. Indique si cette table de jeu de données est masquée.
measures	Measure[]	Mesures contenues dans ce tableau
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}$	Nom de la table
rows	Row[]	Lignes de données de cette table
source	ASMashupExpression[]	Source de la table

Partager via

Push Datasets - Datasets PostDataset

Étendue requise

Limites

Paramètres URI

Corps de la demande

Réponses

Exemples

Push example

Exemple de requête

Exemple de réponse

Définitions

ASMashupExpression

Column

CreateDatasetRequest

CrossFilteringBehavior

Dataset

DatasetMode

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

Datasource

DatasourceConnectionDetails

DefaultRetentionPolicy

DependentDataflow

Encryption

EncryptionStatus

Measure

PrincipalType

Relationship

Row

ServicePrincipalProfile

Table