Items - Create Data Pipeline

Service:: DataPipeline

Version d'API:: v1

Crée un pipeline de données dans l’espace de travail spécifié.
Cette API prend en charge opérations longues (LRO).

Autorisations

L’appelant doit avoir un rôle d’espace de travail contributeur .

Étendues déléguées requises

DataPipeline.ReadWrite.All ou Item.ReadWrite.All

Limites

Pour créer un pipeline de données, l’espace de travail doit se trouver sur une capacité Fabric prise en charge.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Soutien
Utilisateur	Oui
principal de service et identités managées	Oui

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string (uuid)	ID de l’espace de travail.

Corps de la demande

Nom	Obligatoire	Type	Description
displayName	True	string	Nom complet du pipeline de données.
definition		DataPipelineDefinition	Définition publique du pipeline de données.
description		string	Description du pipeline de données. La longueur maximale est de 256 caractères.
folderId		string (uuid)	ID du dossier. S’il n’est pas spécifié ou null, le pipeline de données est créé avec l’espace de travail en tant que dossier.

Réponses

Nom	Type	Description
201 Created	DataPipeline	Création réussie
202 Accepted		Demande acceptée, approvisionnement de pipeline de données en cours En-têtes Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : InvalidItemType - Le type d’élément n’est pas valide ItemDisplayNameAlreadyInUse : le nom d’affichage de l’élément est déjà utilisé CorruptedPayload : la charge utile fournie est endommagée. WorkspaceItemsLimitExceededed : limite d’élément d’espace de travail dépassée.

Nom

Type

Description

201 Created

DataPipeline

Création réussie

202 Accepted

Demande acceptée, approvisionnement de pipeline de données en cours

En-têtes

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

InvalidItemType - Le type d’élément n’est pas valide
ItemDisplayNameAlreadyInUse : le nom d’affichage de l’élément est déjà utilisé
CorruptedPayload : la charge utile fournie est endommagée.
WorkspaceItemsLimitExceededed : limite d’élément d’espace de travail dépassée.

Exemples

Create data pipeline example

Create data pipeline with item definition example

Create data pipeline example

Exemple de requête

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataPipelines

{
  "displayName": "DataPipeline 1",
  "description": "A data pipeline description"
}

Exemple de réponse

Code d’état:: 201

{
  "displayName": "DataPipeline 1",
  "description": "A data pipeline description",
  "type": "DataPipeline",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Code d’état:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create data pipeline with item definition example

Exemple de requête

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataPipelines

{
  "displayName": "DataPipeline 1",
  "description": "A data pipeline description",
  "definition": {
    "parts": [
      {
        "path": "pipeline-content.json",
        "payload": "ewogICAgInByb3BlcnRpZXMiOiB7IAogICAgICAgICJkZXNjcmlwdGlvbiI6ICJEYXRhIHBpcGVsaW5lIGRlc2NyaXB0aW9uIiwgCiAgICAgICAgImFjdGl2aXRpZXMiOiBbIAogICAgICAgICAgICB7IAogICAgICAgICAgICAgICAgIm5hbWUiOiAiV2FpdF9BY3Rpdml0eV8xIiwgCiAgICAgICAgICAgICAgICAidHlwZSI6ICJXYWl0IiwgCiAgICAgICAgICAgICAgICAiZGVwZW5kc09uIjogW10sIAogICAgICAgICAgICAgICAgInR5cGVQcm9wZXJ0aWVzIjogeyAKICAgICAgICAgICAgICAgICAgICAid2FpdFRpbWVJblNlY29uZHMiOiAyNDAgCiAgICAgICAgICAgICAgICB9IAogICAgICAgICAgICB9LAogICAgICAgICAgICB7CiAgICAgICAgICAgICAgICAibmFtZSI6ICJXYWl0X0FjdGl2aXR5XzIiLAogICAgICAgICAgICAgICAgInR5cGUiOiAiV2FpdCIsCiAgICAgICAgICAgICAgICAiZGVwZW5kc09uIjogWwogICAgICAgICAgICAgICAgICAgIHsKICAgICAgICAgICAgICAgICAgICAgICAgImFjdGl2aXR5IjogIldhaXRfQWN0aXZpdHlfMSIsCiAgICAgICAgICAgICAgICAgICAgICAgICJkZXBlbmRlbmN5Q29uZGl0aW9ucyI6IFsgIlN1Y2NlZWRlZCIgXQogICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgIF0sCiAgICAgICAgICAgICAgICAidHlwZVByb3BlcnRpZXMiOiB7CiAgICAgICAgICAgICAgICAgICAgIndhaXRUaW1lSW5TZWNvbmRzIjogMjQwCiAgICAgICAgICAgICAgICB9CiAgICAgICAgICAgIH0KICAgICAgICBdCiAgICB9IAp9IA==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 201

{
  "displayName": "DataPipeline 1",
  "description": "A data pipeline description",
  "type": "DataPipeline",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Code d’état:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Définitions

Nom	Description
CreateDataPipelineRequest	Créez une charge utile de demande de pipeline de données.
DataPipeline	Objet de pipeline de données.
DataPipelineDefinition	Objet de définition publique du pipeline de données.
DataPipelineDefinitionPart	Objet de partie de définition de pipeline de données.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
ItemTag	Représente une balise appliquée à un élément.
ItemType	Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.
PayloadType	Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

CreateDataPipelineRequest

Objet

Créez une charge utile de demande de pipeline de données.

Nom	Type	Description
definition	DataPipelineDefinition	Définition publique du pipeline de données.
description	string	Description du pipeline de données. La longueur maximale est de 256 caractères.
displayName	string	Nom complet du pipeline de données.
folderId	string (uuid)	ID du dossier. S’il n’est pas spécifié ou null, le pipeline de données est créé avec l’espace de travail en tant que dossier.

DataPipeline

Objet

Objet de pipeline de données.

Nom	Type	Description
description	string	Description de l’élément.
displayName	string	Nom complet de l’élément.
folderId	string (uuid)	ID du dossier.
id	string (uuid)	ID d’élément.
tags	ItemTag[]	Liste des balises appliquées.
type	ItemType	Type d’élément.
workspaceId	string (uuid)	ID de l’espace de travail.

DataPipelineDefinition

Objet

Objet de définition publique du pipeline de données.

Nom	Type	Description
format	string	Format de la définition d’élément.
parts	DataPipelineDefinitionPart[]	Liste des parties de définition.

DataPipelineDefinitionPart

Objet

Objet de partie de définition de pipeline de données.

Nom	Type	Description
path	string	Chemin d’accès de la partie de pipeline de données.
payload	string	Charge utile de partie du pipeline de données.
payloadType	PayloadType	Type de charge utile.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

ItemTag

Objet

Représente une balise appliquée à un élément.

Nom	Type	Description
displayName	string	Nom de la balise.
id	string (uuid)	ID de balise.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Dashboard	Tableau de bord PowerBI.
Report	Rapport PowerBI.
SemanticModel	Modèle sémantique PowerBI.
PaginatedReport	Rapport paginé PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Un lac.
Eventhouse	Un eventhouse.
Environment	Environnement.
KQLDatabase	Base de données KQL.
KQLQueryset	Ensemble de requêtes KQL.
KQLDashboard	Tableau de bord KQL.
DataPipeline	Un pipeline de données.
Notebook	Un bloc-notes.
SparkJobDefinition	Définition d’un travail Spark.
MLExperiment	Une expérience de Machine Learning.
MLModel	Modèle Machine Learning.
Warehouse	Un entrepôt.
Eventstream	Flux d’événements.
SQLEndpoint	Point de terminaison SQL.
MirroredWarehouse	Un entrepôt mis en miroir.
MirroredDatabase	Une base de données mise en miroir.
Reflex	Un réflexe.
GraphQLApi	API pour l’élément GraphQL.
MountedDataFactory	Un MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Tâche de copie.
VariableLibrary	A VariableLibrary.
Dataflow	Flux de données.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Capture instantanée de l’entrepôt.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flux de générateur de jumeaux numériques.
MirroredAzureDatabricksCatalog	Catalogue Azure databricks mis en miroir.
Map	Carte.
AnomalyDetector	Détecteur d’anomalies.
UserDataFunction	Fonction de données utilisateur.
GraphModel	A GraphModel.
GraphQuerySet	Ensemble de requêtes Graph.
SnowflakeDatabase	Une base de données Snowflake pour stocker les tables Iceberg créées à partir du compte Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Base de données Cosmos DB.
Ontology	Une ontologie.
EventSchemaSet	An EventSchemaSet.

PayloadType

Énumération

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
InlineBase64	Base 64 inline.

Partager via

Items - Create Data Pipeline

Autorisations

Étendues déléguées requises

Limites

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Corps de la demande

Réponses

Exemples

Create data pipeline example

Exemple de requête

Exemple de réponse

Create data pipeline with item definition example

Exemple de requête

Exemple de réponse

Définitions

CreateDataPipelineRequest

DataPipeline

DataPipelineDefinition

DataPipelineDefinitionPart

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType