Items - Update Data Pipeline

Servicio:

DataPipeline

Versión de la API:

v1

Actualiza las propiedades de la canalización de datos especificada.

Permisos

El autor de la llamada debe tener rol de colaborador o superior.

Ámbitos delegados necesarios

DataPipeline.ReadWrite.All o Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identidad	Apoyo
Usuario	Sí
de entidad de servicio y identidades administradas	Sí

Interfaz

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
dataPipelineId	path	True	string uuid	Identificador de canalización de datos.
workspaceId	path	True	string uuid	Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre	Tipo	Description
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. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.

Respuestas

Nombre	Tipo	Description
200 OK	DataPipeline	Solicitud completada correctamente.
Other Status Codes	ErrorResponse	Códigos de error comunes: ItemNotFound: no se encontró el elemento solicitado. InvalidRequest: solicitud de actualización no válida

Ejemplos

Update a data pipeline example

Solicitud de ejemplo

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataPipelines/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "A new name for the DataPipeline",
  "description": "A new description for the data pipeline."
}

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
DataPipeline	Objeto de canalización de datos.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
UpdateDataPipelineRequest	Actualice la solicitud de canalización de datos.

DataPipeline

Object

Objeto de canalización de datos.

Nombre	Tipo	Description
description	string	Descripción del elemento.
displayName	string	Nombre para mostrar del elemento.
id	string uuid	Identificador del elemento.
type	ItemType	Tipo de elemento.
workspaceId	string uuid	Identificador del área de trabajo.

ErrorRelatedResource

Object

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

Object

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	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

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.

ItemType

Enumeración

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

Valor	Description
Dashboard	Panel de PowerBI.
DataPipeline	Una canalización de datos.
Datamart	Datamart de PowerBI.
Environment	Un entorno.
Eventhouse	Un centro de eventos.
Eventstream	Una secuencia de eventos.
GraphQLApi	Una API para el elemento GraphQL.
KQLDashboard	Un panel de KQL.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
Lakehouse	Una casa de lago.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
MirroredDatabase	Una base de datos reflejada.
MirroredWarehouse	Un almacén reflejado.
MountedDataFactory	A MountedDataFactory.
Notebook	Un cuaderno.
PaginatedReport	Informe paginado de PowerBI.
Reflex	Un reflejo.
Report	Informe de PowerBI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Un punto de conexión de SQL.
SemanticModel	Modelo semántico de PowerBI.
SparkJobDefinition	Una definición de trabajo de Spark.
Warehouse	Un almacén.

UpdateDataPipelineRequest

Object

Actualice la solicitud de canalización de datos.

Nombre	Tipo	Description
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. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.