Items - Create Data Pipeline

Servicio:
DataPipeline
Versión de la API:
v1

Crea una canalización de datos en el área de trabajo especificada.
Esta API admite operaciones de larga duración (LRO).

Permisos

El autor de la llamada debe tener un rol de área de trabajo colaborador .

Ámbitos delegados necesarios

DataPipeline.ReadWrite.All o Item.ReadWrite.All

Limitaciones

  • Para crear una canalización de datos, el área de trabajo debe estar en una capacidad de Fabric compatible.

Microsoft Entra identidades admitidas

Esta API admite los Microsoft identities enumerados en esta sección.

Identidad Apoyo
Usuario Sí
Entidad de servicio e Identidades administradas Sí

Interfaz

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
 path True

string (uuid)

Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
displayName True

string

Nombre para mostrar de la canalización de datos.
definition

DataPipelineDefinition

Definición pública de la canalización de datos.
description

string

Descripción de la canalización de datos. La longitud máxima es de 256 caracteres.
folderId

string (uuid)

Identificador de carpeta. Si no se especifica o null, la canalización de datos se crea con el área de trabajo como carpeta.
sensitivityLabelSettings

SensitivityLabelSettings

Configuración de la etiqueta de confidencialidad para la canalización de datos.

Respuestas

Nombre Tipo Description
201 Created

DataPipeline

Creado correctamente
202 Accepted

Solicitud aceptada, aprovisionamiento de canalización de datos en curso

Encabezados

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • InvalidItemType: el tipo de elemento no es válido

  • ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento

  • CorruptedPayload: la carga proporcionada está dañada.

  • WorkspaceItemsLimitExceeded: se superó el límite de elementos del área de trabajo.

Ejemplos

Create data pipeline example
Create data pipeline with item definition example

Create data pipeline example

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
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"
  }
}
status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
  }
}
status code:
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

Definiciones

Nombre Description
CreateDataPipelineRequest

Cree una carga de solicitud de canalización de datos.
DataPipeline

Objeto de canalización de datos.
DataPipelineDefinition

Objeto de definición pública de canalización de datos. Consulte este artículo para obtener más información sobre la estructura de la definición de canalización de datos.
DataPipelineDefinitionPart

Objeto de elemento de definición de canalización de datos.
EntireTenantPrincipal

Representa una entidad de seguridad de inquilino
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
GroupDetails

Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es Group.
GroupPrincipal

Representa un grupo de seguridad.
GroupType

Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.
ItemTag

Representa una etiqueta aplicada en un elemento.
ItemType

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
PayloadType

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.
PrincipalType

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.
SensitivityLabel

Representa una etiqueta de confidencialidad aplicada a un elemento.
SensitivityLabelApplyStrategy

Estrategia para aplicar la etiqueta de confidencialidad. El valor predeterminado es ApplyOrFail. Se pueden agregar tipos adicionales a lo largo del tiempo.
SensitivityLabelSettings

Configuración de la etiqueta de confidencialidad.
ServicePrincipalDetails

Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipal.
ServicePrincipalPrincipal

Representa una entidad de servicio de Microsoft Entra.
ServicePrincipalProfileDetails

Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Representa un perfil de entidad de servicio.
UserDetails

Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es User.
UserPrincipal

Representa una entidad de seguridad de usuario Microsoft Entra.

CreateDataPipelineRequest

Objeto

Cree una carga de solicitud de canalización de datos.

Nombre Tipo Description
definition

DataPipelineDefinition

Definición pública de la canalización de datos.
description

string

Descripción de la canalización de datos. La longitud máxima es de 256 caracteres.
displayName

string

Nombre para mostrar de la canalización de datos.
folderId

string (uuid)

Identificador de carpeta. Si no se especifica o null, la canalización de datos se crea con el área de trabajo como carpeta.
sensitivityLabelSettings

SensitivityLabelSettings

Configuración de la etiqueta de confidencialidad para la canalización de datos.

DataPipeline

Objeto

Objeto de canalización de datos.

Nombre Tipo Description
defaultIdentity Principal:

Identidad predeterminada del elemento.
description

string

Descripción del elemento.
displayName

string

Nombre para mostrar del elemento.
folderId

string (uuid)

Identificador de carpeta.
id

string (uuid)

Identificador del elemento.
sensitivityLabel

SensitivityLabel

Etiqueta de confidencialidad del elemento.
tags

ItemTag[]

Lista de etiquetas aplicadas.
type

ItemType

Tipo de elemento.
workspaceId

string (uuid)

Identificador del área de trabajo.

DataPipelineDefinition

Objeto

Objeto de definición pública de canalización de datos. Consulte este artículo para obtener más información sobre la estructura de la definición de canalización de datos.

Nombre Tipo Description
format

string

Formato de la definición de elemento.
parts

DataPipelineDefinitionPart[]

Lista de elementos de definición.

DataPipelineDefinitionPart

Objeto

Objeto de elemento de definición de canalización de datos.

Nombre Tipo Description
path

string

Ruta de acceso del elemento de canalización de datos.
payload

string

Carga del elemento de canalización de datos.
payloadType

PayloadType

Tipo de carga.

EntireTenantPrincipal

Objeto

Representa una entidad de seguridad de inquilino

Nombre Tipo Description
displayName

string

Nombre para mostrar de la entidad de seguridad.
id

string (uuid)

Identificador de la entidad de seguridad.
type string:

EntireTenant

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string (uuid)

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

GroupDetails

Objeto

Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es Group.

Nombre Tipo Description
groupType

GroupType

Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

GroupPrincipal

Objeto

Representa un grupo de seguridad.

Nombre Tipo Description
displayName

string

Nombre para mostrar de la entidad de seguridad.
groupDetails

GroupDetails

Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es Group.
id

string (uuid)

Identificador de la entidad de seguridad.
type string:

Group

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

GroupType

Enumeración

Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

Valor Description
Unknown

El tipo de grupo principal es desconocido.
SecurityGroup

La entidad de seguridad es un grupo de seguridad.
DistributionList

La entidad de seguridad es una lista de distribución.

ItemTag

Objeto

Representa una etiqueta aplicada en un elemento.

Nombre Tipo Description
displayName

string

Nombre de la etiqueta.
id

string (uuid)

Identificador de etiqueta.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor Description
Dashboard

Panel de PowerBI.
Report

Informe de PowerBI.
SemanticModel

Modelo semántico de PowerBI.
PaginatedReport

Informe paginado de PowerBI.
Datamart

Datamart de PowerBI.
Lakehouse

Una casa de lago.
Eventhouse

Un centro de eventos.
Environment

Un entorno.
KQLDatabase

Una base de datos KQL.
KQLQueryset

Un conjunto de consultas KQL.
KQLDashboard

Un panel de KQL.
DataPipeline

Una canalización de datos.
Notebook

Un cuaderno.
SparkJobDefinition

Una definición de trabajo de Spark.
MLExperiment

Un experimento de aprendizaje automático.
MLModel

Un modelo de aprendizaje automático.
Warehouse

Un almacén.
Eventstream

Una secuencia de eventos.
SQLEndpoint

Un punto de conexión de SQL.
MirroredWarehouse

Un almacén reflejado.
MirroredDatabase

Una base de datos reflejada.
Reflex

Un reflejo.
GraphQLApi

Una API para el elemento GraphQL.
MountedDataFactory

A MountedDataFactory.
SQLDatabase

A SQLDatabase.
CopyJob

Un trabajo de copia.
VariableLibrary

A VariableLibrary.
Dataflow

Flujo de datos.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Una instantánea de almacenamiento.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Un flujo de Digital Twin Builder.
MirroredAzureDatabricksCatalog

Un catálogo de Azure Databricks reflejado.
Map

Un mapa.
AnomalyDetector

An Anomaly Detector.
UserDataFunction

Una función de datos de usuario.
GraphModel

Un GraphModel.
GraphQuerySet

Un conjunto de consultas de Graph.
SnowflakeDatabase

Una base de datos de Snowflake para almacenar tablas de Cosmos creadas a partir de la cuenta de Snowflake.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Una base de datos de Cosmos DB.
Ontology

Una ontología.
EventSchemaSet

An EventSchemaSet.
DataAgent

A DataAgent.
MirroredCatalog

A MirroredCatalog.

PayloadType

Enumeración

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

Valor Description
InlineBase64

Base 64 insertada.

PrincipalType

Enumeración

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

Valor Description
User

La entidad de seguridad es una entidad de seguridad de usuario Microsoft Entra.
ServicePrincipal

La entidad de seguridad es una entidad de servicio Microsoft Entra.
Group

La entidad de seguridad es un grupo de seguridad.
ServicePrincipalProfile

La entidad de servicio es un perfil de entidad de servicio.
EntireTenant

La entidad de seguridad representa todos los usuarios de inquilinos.

SensitivityLabel

Objeto

Representa una etiqueta de confidencialidad aplicada a un elemento.

Nombre Tipo Description
id

string (uuid)

Identificador de etiqueta de confidencialidad.

SensitivityLabelApplyStrategy

Enumeración

Estrategia para aplicar la etiqueta de confidencialidad. El valor predeterminado es ApplyOrFail. Se pueden agregar tipos adicionales a lo largo del tiempo.

Valor Description
ApplyOrFail

Aplique la etiqueta de confidencialidad o produzca un error en la operación si no se puede aplicar.
Ignore

Omita la etiqueta de confidencialidad si no se puede aplicar y continúe con la operación sin aplicar la etiqueta.

SensitivityLabelSettings

Objeto

Configuración de la etiqueta de confidencialidad.

Nombre Tipo Description
labelId

string (uuid)

Identificador de etiqueta de confidencialidad.
sensitivityLabelApplyStrategy

SensitivityLabelApplyStrategy

Estrategia para aplicar la etiqueta de confidencialidad.

ServicePrincipalDetails

Objeto

Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipal.

Nombre Tipo Description
aadAppId

string (uuid)

AppId de Microsoft Entra de la entidad de servicio.

ServicePrincipalPrincipal

Objeto

Representa una entidad de servicio de Microsoft Entra.

Nombre Tipo Description
displayName

string

Nombre para mostrar de la entidad de seguridad.
id

string (uuid)

Identificador de la entidad de seguridad.
servicePrincipalDetails

ServicePrincipalDetails

Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipal.
type string:

ServicePrincipal

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

ServicePrincipalProfileDetails

Objeto

Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipalProfile.

Nombre Tipo Description
parentPrincipal Principal:

La entidad de seguridad principal del perfil de la entidad de servicio.

ServicePrincipalProfilePrincipal

Objeto

Representa un perfil de entidad de servicio.

Nombre Tipo Description
displayName

string

Nombre para mostrar de la entidad de seguridad.
id

string (uuid)

Identificador de la entidad de seguridad.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

UserDetails

Objeto

Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es User.

Nombre Tipo Description
userPrincipalName

string

Nombre principal de usuario.

UserPrincipal

Objeto

Representa una entidad de seguridad de usuario Microsoft Entra.

Nombre Tipo Description
displayName

string

Nombre para mostrar de la entidad de seguridad.
id

string (uuid)

Identificador de la entidad de seguridad.
type string:

User

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.
userDetails

UserDetails

Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es User.