Push Datasets - Datasets PostDatasetInGroup
Crée un jeu de données dans l’espace de travail spécifié.
É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/groups/{groupId}/datasets
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets?defaultRetentionPolicy={defaultRetentionPolicy}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
group
|
path | True |
string uuid |
L’ID de l’espace de travail |
default
|
query |
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 |
Sources de données associées à ce jeu de données |
||
defaultMode |
Mode ou type de jeu de données |
||
relationships |
Relations du jeu de données |
Réponses
Nom | Type | Description |
---|---|---|
201 Created |
Date de création |
|
202 Accepted |
Accepté |
Exemples
Push example
Sample Request
POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets?defaultRetentionPolicy=basicFIFO
{
"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
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"defaultRetentionPolicy": "basicFIFO"
}
Définitions
Nom | Description |
---|---|
ASMashup |
Une source de table de jeu de données |
Column |
Colonne d’un jeu de données |
Create |
Un jeu de données Power BI |
Cross |
Direction du filtre de la relation |
Dataset |
Un jeu de données Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés de 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. |
Dataset |
Mode ou type de jeu de données |
Dataset |
Paramètres de scale-out de requête d’un jeu de données |
Dataset |
Entrée de droit d’accès utilisateur Power BI pour un jeu de données |
Dataset |
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 |
Datasource |
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 en groupe. |
Default |
Stratégie de rétention par défaut |
Dependent |
Un flux de données dépendant de Power BI |
Encryption |
Informations de chiffrement pour un jeu de données |
Encryption |
status de chiffrement de jeu de données |
Measure |
Une mesure Power BI |
Principal |
Type principal |
Relationship |
Relation entre les tables d’un jeu de données |
Row |
Ligne de données dans un jeu de données |
Service |
Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire. |
Table |
Table d’un 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 de 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 |
name |
string |
Nom de 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 |
Sources de données associées à ce jeu de données |
|
defaultMode |
Mode ou type de jeu de données |
|
name |
string |
Nom du jeu de données |
relationships |
Relations du jeu de données |
|
tables |
Table[] |
Tables de jeu de données |
CrossFilteringBehavior
Direction du 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 seule table. |
OneDirection |
string |
À des fins de filtrage, le filtre est appliqué sur la table où les valeurs sont agrégées. |
Dataset
Un jeu de données Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés de 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 |
Informations de chiffrement du jeu de données. Applicable uniquement lorsque |
|
IsEffectiveIdentityRequired |
boolean |
Indique si le jeu de données nécessite une identité efficace, que vous devez envoyer dans un appel d’API GenerateToken . |
IsEffectiveIdentityRolesRequired |
boolean |
Indique si la sécurité au niveau des lignes est définie dans le 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 est actualisable 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 |
URL incorporée du jeu de données Q&A |
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 |
Interroger les paramètres de scale-out d’un jeu de données |
|
targetStorageMode |
string |
Mode de stockage du jeu de données |
upstreamDataflows |
La liste de tous les flux de données dont dépend cet élément |
|
users |
(Valeur vide) Détails de l’accès 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 de l’API Get Dataset Users as Administration ou de l’API PostWorkspaceInfo avec le |
|
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 dynamique à Azure Analysis Services |
AsOnPrem |
string |
Jeu de données avec une connexion dynamique à 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 le streaming de 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
Paramètres de scale-out de requête 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 |
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 |
Type principal |
|
profile |
Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire. |
|
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 sur le 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 dans le jeu de données |
ReadReshare |
string |
Octroie l’accès en lecture et en partage au contenu dans le jeu de données |
ReadReshareExplore |
string |
Octroie l’accès en lecture, partage 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, partage et exploration au contenu du jeu de données |
Datasource
Une source de données Power BI
Nom | Type | Description |
---|---|---|
connectionDetails |
Détails de la connexion à la source de données |
|
connectionString |
string |
(Déconseillé) Source de données chaîne de connexion. Disponible uniquement pour DirectQuery. |
datasourceId |
string |
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 |
ID de passerelle lié, 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 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 en 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 |
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 principal. Utilisez pour un accès de niveau organization entier. |
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 | OneDirection |
Direction du 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. Ne concerne que Power BI Embedded solution multilocataire.
Nom | Type | Description |
---|---|---|
displayName |
string |
Nom du profil principal de service |
id |
string |
ID de profil du principal de service |
Table
Table d’un 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 dans cette table |
source |
Source de la table |