Items - Create Data Pipeline

Servizio:: DataPipeline

Versione API:: v1

Crea una pipeline di dati nell'area di lavoro specificata.
Questa API supporta operazioni con esecuzione prolungata (LRO).

Autorizzazioni

Il chiamante deve avere un ruolo di area di lavoro collaboratore .

Ambiti delegati obbligatori

DataPipeline.ReadWrite.All o Item.ReadWrite.All

Limitazioni

Per creare una pipeline di dati, l'area di lavoro deve avere una capacità di Fabric supportata.

Microsoft Entra identità supportate

Questa API supporta i Microsoft identities elencati in questa sezione.

Identità	Appoggiare
Utente	Sì
Principale del servizio e Identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	ID dell'area di lavoro.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
displayName	True	string	Nome visualizzato della pipeline di dati.
definition		DataPipelineDefinition	Definizione pubblica della pipeline di dati.
description		string	Descrizione della pipeline di dati. La lunghezza massima è di 256 caratteri.
folderId		string (uuid)	ID cartella. Se non specificato o null, la pipeline di dati viene creata con l'area di lavoro come cartella.
sensitivityLabelSettings		SensitivityLabelSettings	Impostazioni dell'etichetta di riservatezza per la pipeline di dati.

Risposte

Nome	Tipo	Descrizione
201 Created	DataPipeline	Creazione completata
202 Accepted		Richiesta accettata, provisioning della pipeline di dati in corso Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: InvalidItemType - Tipo di elemento non valido ItemDisplayNameAlreadyInUse - Nome visualizzato dell'elemento già usato CorruptedPayload: il payload fornito è danneggiato. WorkspaceItemsLimitExceeded - Limite di elementi dell'area di lavoro superato.

Esempio

Create data pipeline example

Create data pipeline with item definition example

Create data pipeline example

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:: 201

{
  "displayName": "DataPipeline 1",
  "description": "A data pipeline description",
  "type": "DataPipeline",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 201

{
  "displayName": "DataPipeline 1",
  "description": "A data pipeline description",
  "type": "DataPipeline",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Codice di stato:: 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

Definizioni

Nome	Descrizione
CreateDataPipelineRequest	Creare il payload della richiesta della pipeline di dati.
DataPipeline	Oggetto pipeline di dati.
DataPipelineDefinition	Oggetto definizione pubblica della pipeline di dati. Per altre informazioni sulla struttura della definizione della pipeline di dati, vedere questo articolo .
DataPipelineDefinitionPart	Oggetto parte della definizione della pipeline di dati.
EntireTenantPrincipal	Rappresenta un'entità tenant
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
GroupDetails	Dettagli specifici del gruppo. Applicabile quando il tipo di entità è `Group`.
GroupPrincipal	Rappresenta un gruppo di sicurezza.
GroupType	Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.
ItemTag	Rappresenta un tag applicato a un elemento.
ItemType	Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.
PayloadType	Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.
PrincipalType	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.
SensitivityLabel	Rappresenta un'etichetta di riservatezza applicata a un elemento.
SensitivityLabelApplyStrategy	Strategia per l'applicazione dell'etichetta di riservatezza. Il valore predefinito è ApplyOrFail. È possibile aggiungere altri tipi nel tempo.
SensitivityLabelSettings	Impostazioni dell'etichetta di riservatezza.
ServicePrincipalDetails	Dettagli specifici dell'entità servizio. Applicabile quando il tipo di entità è `ServicePrincipal`.
ServicePrincipalPrincipal	Rappresenta un'entità servizio Microsoft Entra.
ServicePrincipalProfileDetails	Dettagli del profilo dell'entità servizio. Applicabile quando il tipo di entità è `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Rappresenta un profilo dell'entità servizio.
UserDetails	Dettagli specifici dell'entità utente. Applicabile quando il tipo di entità è `User`.
UserPrincipal	Rappresenta un'entità utente Microsoft Entra.

CreateDataPipelineRequest

Oggetto

Creare il payload della richiesta della pipeline di dati.

Nome	Tipo	Descrizione
definition	DataPipelineDefinition	Definizione pubblica della pipeline di dati.
description	string	Descrizione della pipeline di dati. La lunghezza massima è di 256 caratteri.
displayName	string	Nome visualizzato della pipeline di dati.
folderId	string (uuid)	ID cartella. Se non specificato o null, la pipeline di dati viene creata con l'area di lavoro come cartella.
sensitivityLabelSettings	SensitivityLabelSettings	Impostazioni dell'etichetta di riservatezza per la pipeline di dati.

DataPipeline

Oggetto

Oggetto pipeline di dati.

Nome	Tipo	Descrizione
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Identità predefinita dell'elemento.
description	string	Descrizione dell'elemento.
displayName	string	Nome visualizzato dell'elemento.
folderId	string (uuid)	ID cartella.
id	string (uuid)	ID elemento.
sensitivityLabel	SensitivityLabel	Etichetta di riservatezza dell'elemento.
tags	ItemTag[]	Elenco di tag applicati.
type	ItemType	Tipo di elemento.
workspaceId	string (uuid)	ID dell'area di lavoro.

DataPipelineDefinition

Oggetto

Oggetto definizione pubblica della pipeline di dati. Per altre informazioni sulla struttura della definizione della pipeline di dati, vedere questo articolo .

Nome	Tipo	Descrizione
format	string	Formato della definizione dell'elemento.
parts	DataPipelineDefinitionPart[]	Elenco di parti di definizione.

DataPipelineDefinitionPart

Oggetto

Oggetto parte della definizione della pipeline di dati.

Nome	Tipo	Descrizione
path	string	Percorso della parte della pipeline di dati.
payload	string	Payload della parte della pipeline di dati.
payloadType	PayloadType	Tipo di payload.

EntireTenantPrincipal

Oggetto

Rappresenta un'entità tenant

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
type	string: EntireTenant	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

GroupDetails

Oggetto

Dettagli specifici del gruppo. Applicabile quando il tipo di entità è Group.

Nome	Tipo	Descrizione
groupType	GroupType	Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.

GroupPrincipal

Oggetto

Rappresenta un gruppo di sicurezza.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
groupDetails	GroupDetails	Dettagli specifici del gruppo. Applicabile quando il tipo di entità è `Group`.
id	string (uuid)	ID dell'entità.
type	string: Group	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

GroupType

Enumerazione

Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.

Valore	Descrizione
Unknown	Il tipo di gruppo principale è sconosciuto.
SecurityGroup	Principal è un gruppo di sicurezza.
DistributionList	Principal è una lista di distribuzione.

ItemTag

Oggetto

Rappresenta un tag applicato a un elemento.

Nome	Tipo	Descrizione
displayName	string	Nome del tag.
id	string (uuid)	ID tag.

ItemType

Enumerazione

Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.

Valore	Descrizione
Dashboard	Dashboard di Power BI.
Report	Report di Power BI.
SemanticModel	Modello semantico di PowerBI.
PaginatedReport	Report impaginato di Power BI.
Datamart	Datamart di PowerBI.
Lakehouse	Una lakehouse.
Eventhouse	Una casa eventi.
Environment	Un ambiente.
KQLDatabase	Un database KQL.
KQLQueryset	Set di query KQL.
KQLDashboard	Dashboard KQL.
DataPipeline	Una pipeline di dati.
Notebook	Un notebook.
SparkJobDefinition	Definizione di processo Spark.
MLExperiment	Esperimento di Machine Learning.
MLModel	Modello di Machine Learning.
Warehouse	Un magazzino.
Eventstream	Flusso di eventi.
SQLEndpoint	Endpoint SQL.
MirroredWarehouse	Magazzino con mirroring.
MirroredDatabase	Database con mirroring.
Reflex	Un riflesso.
GraphQLApi	API per l'elemento GraphQL.
MountedDataFactory	Oggetto MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Processo di copia.
VariableLibrary	VariabileLibrary.
Dataflow	Flusso di dati.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Uno snapshot del warehouse.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flusso di Generatore di gemelli digitali.
MirroredAzureDatabricksCatalog	Catalogo di Azure databricks con mirroring.
Map	Una mappa.
AnomalyDetector	Rilevamento anomalie.
UserDataFunction	Funzione dati utente.
GraphModel	A GraphModel.
GraphQuerySet	Oggetto Graph QuerySet.
SnowflakeDatabase	Un database Snowflake per archiviare le tabelle Iceberg create dall'account Snowflake.
OperationsAgent	Oggetto OperationsAgent.
CosmosDBDatabase	Un database Cosmos DB.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.
DataAgent	Oggetto DataAgent.
MirroredCatalog	Oggetto MirroredCatalog.

PayloadType

Enumerazione

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

Valore	Descrizione
InlineBase64	Inline Base 64.

PrincipalType

Enumerazione

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

Valore	Descrizione
User	Principal è un'entità utente Microsoft Entra.
ServicePrincipal	Principal è un'entità servizio Microsoft Entra.
Group	Principal è un gruppo di sicurezza.
ServicePrincipalProfile	Principal è un profilo dell'entità servizio.
EntireTenant	Principal rappresenta tutti gli utenti tenant.

SensitivityLabel

Oggetto

Rappresenta un'etichetta di riservatezza applicata a un elemento.

Nome	Tipo	Descrizione
id	string (uuid)	ID etichetta di riservatezza.

SensitivityLabelApplyStrategy

Enumerazione

Strategia per l'applicazione dell'etichetta di riservatezza. Il valore predefinito è ApplyOrFail. È possibile aggiungere altri tipi nel tempo.

Valore	Descrizione
ApplyOrFail	Applicare l'etichetta di riservatezza o non eseguire l'operazione se non può essere applicata.
Ignore	Ignorare l'etichetta di riservatezza se non può essere applicata e procedere con l'operazione senza applicare l'etichetta.

SensitivityLabelSettings

Oggetto

Impostazioni dell'etichetta di riservatezza.

Nome	Tipo	Descrizione
labelId	string (uuid)	ID etichetta di riservatezza.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Strategia per l'applicazione dell'etichetta di riservatezza.

ServicePrincipalDetails

Oggetto

Dettagli specifici dell'entità servizio. Applicabile quando il tipo di entità è ServicePrincipal.

Nome	Tipo	Descrizione
aadAppId	string (uuid)	L'entità servizio Microsoft Entra AppId.

ServicePrincipalPrincipal

Oggetto

Rappresenta un'entità servizio Microsoft Entra.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
servicePrincipalDetails	ServicePrincipalDetails	Dettagli specifici dell'entità servizio. Applicabile quando il tipo di entità è `ServicePrincipal`.
type	string: ServicePrincipal	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

ServicePrincipalProfileDetails

Oggetto

Dettagli del profilo dell'entità servizio. Applicabile quando il tipo di entità è ServicePrincipalProfile.

Nome	Tipo	Descrizione
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Entità padre del profilo dell'entità servizio.

ServicePrincipalProfilePrincipal

Oggetto

Rappresenta un profilo dell'entità servizio.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Dettagli del profilo dell'entità servizio. Applicabile quando il tipo di entità è `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

UserDetails

Oggetto

Dettagli specifici dell'entità utente. Applicabile quando il tipo di entità è User.

Nome	Tipo	Descrizione
userPrincipalName	string	Nome principale utente.

UserPrincipal

Oggetto

Rappresenta un'entità utente Microsoft Entra.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
type	string: User	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.
userDetails	UserDetails	Dettagli specifici dell'entità utente. Applicabile quando il tipo di entità è `User`.