Items - Update Dataflow Definition

Servicio:: Dataflow

Versión de la API:: v1

Invalida la definición del flujo de datos especificado.
Esta API admite operaciones de larga duración (LRO).

La actualización de la definición del flujo de datos no afecta a su etiqueta de confidencialidad.

Permisos

El autor de la llamada debe tener permisos de lectura y escritura para el flujo de datos.

Ámbitos delegados necesarios

Dataflow.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í
Entidad de servicio e Identidades administradas	Sí

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/updateDefinition

Con parámetros opcionales:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/updateDefinition?updateMetadata={updateMetadata}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
dataflowId	path	True	string (uuid)	Identificador de flujo de datos.
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.
updateMetadata	query		boolean	Cuando se establece en true y el archivo .platform se proporciona como parte de la definición, los metadatos del elemento se actualizan mediante los metadatos del archivo .platform.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
definition	True	DataflowDefinition	Objeto de definición pública de flujo de datos. Consulte este artículo para obtener más información sobre la estructura de la definición de flujo de datos.

Respuestas

Nombre	Tipo	Description
200 OK		Solicitud completada correctamente.
202 Accepted		Solicitud aceptada. La definición de actualización está 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: OperationNotSupportedForItem: no se admite la operación para el elemento solicitado. CorruptedPayload: la carga proporcionada está dañada.

Ejemplos

Update a Dataflow public definition example

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataflows/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "queryMetadata.json",
        "payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfSwKICAgICJNREYgdHJhbnNmb3JtIjogewogICAgICAicXVlcnlJZCI6ICI5YzZkN2M4Ny04M2RiLTQ3MTgtYjM4Mi1jMGMxYWExNjM2ZDciLAogICAgICAicXVlcnlOYW1lIjogIk1ERiB0cmFuc2Zvcm0iLAogICAgICAibG9hZEVuYWJsZWQiOiBmYWxzZQogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "mashup.pq",
        "payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwpbSXRlbVR5cGUgPSAiTURGIl0Kc2hhcmVkICMiTURGIHRyYW5zZm9ybSIgPSAiX19fRXh0ZXJuYWxSZXNvdXJjZS1QbGFjZWhvbGRlcl9fXyI7Cg==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "MDF transform.mdf",
        "payload": "ewogICAgIm5hbWUiOiAiTURGIiwKICAgICJwcm9wZXJ0aWVzIjogewogICAgICAgICJ0eXBlIjogIk1hcHBpbmdEYXRhRmxvdyIsCiAgICAgICAgInR5cGVQcm9wZXJ0aWVzIjogewogICAgICAgICAgICAic291cmNlcyI6IFsKICAgICAgICAgICAgICAgIHsKICAgICAgICAgICAgICAgICAgICAibmFtZSI6ICJzb3VyY2UxIiwKICAgICAgICAgICAgICAgICAgICAiZXh0ZXJuYWxSZWZlcmVuY2VzIjogewogICAgICAgICAgICAgICAgICAgICAgICAiY29ubmVjdGlvbiI6ICI8c291cmNlMUNvbm5lY3Rpb25JZD4iCiAgICAgICAgICAgICAgICAgICAgfQogICAgICAgICAgICAgICAgfQogICAgICAgICAgICBdLAogICAgICAgICAgICAic2lua3MiOiBbCiAgICAgICAgICAgICAgICB7CiAgICAgICAgICAgICAgICAgICAgIm5hbWUiOiAic2luazEiLAogICAgICAgICAgICAgICAgICAgICJleHRlcm5hbFJlZmVyZW5jZXMiOiB7CiAgICAgICAgICAgICAgICAgICAgICAgICJjb25uZWN0aW9uIjogIjxzaW5rMUNvbm5lY3Rpb25JZD4iCiAgICAgICAgICAgICAgICAgICAgfQogICAgICAgICAgICAgICAgfQogICAgICAgICAgICBdLAogICAgICAgICAgICAidHJhbnNmb3JtYXRpb25zIjogWwogICAgICAgICAgICAgICAgewogICAgICAgICAgICAgICAgICAgICJuYW1lIjogImRlcml2ZWRDb2x1bW4xIgogICAgICAgICAgICAgICAgfQogICAgICAgICAgICBdLAogICAgICAgICAgICAic2NyaXB0TGluZXMiOiBbCiAgICAgICAgICAgICAgICAic291cmNlKG91dHB1dCgiLAogICAgICAgICAgICAgICAgIiAgICAgICAgICBDb2x1bW4xIGFzIHNob3J0LCIsCiAgICAgICAgICAgICAgICAiICAgICAgICAgIENvbHVtbjIgYXMgc3RyaW5nLCIsCiAgICAgICAgICAgICAgICAiICAgICAgICAgIENvbHVtbjMgYXMgZGF0ZSwiLAogICAgICAgICAgICAgICAgIiAgICAgICAgICBDb2x1bW40IGFzIGJvb2xlYW4sIiwKICAgICAgICAgICAgICAgICIgICAgICAgICAgQ29sdW1uNSBhcyBzdHJpbmcsIiwKICAgICAgICAgICAgICAgICIgICAgICAgICAgQ29sdW1uNiBhcyBkb3VibGUiLAogICAgICAgICAgICAgICAgIiAgICAgKSwiLAogICAgICAgICAgICAgICAgIiAgICAgdXNlU2NoZW1hOiBmYWxzZSwiLAogICAgICAgICAgICAgICAgIiAgICAgYWxsb3dTY2hlbWFEcmlmdDogdHJ1ZSwiLAogICAgICAgICAgICAgICAgIiAgICAgdmFsaWRhdGVTY2hlbWE6IGZhbHNlLCIsCiAgICAgICAgICAgICAgICAiICAgICBpZ25vcmVOb0ZpbGVzRm91bmQ6IGZhbHNlLCIsCiAgICAgICAgICAgICAgICAiICAgICBmb3JtYXQ6ICdkZWxpbWl0ZWQnLCIsCiAgICAgICAgICAgICAgICAiICAgICBmaWxlU3lzdGVtOiAnZm9sZGVyMScsIiwKICAgICAgICAgICAgICAgICIgICAgIGZpbGVOYW1lOiAnZmlsZTEuY3N2JywiLAogICAgICAgICAgICAgICAgIiAgICAgY29sdW1uRGVsaW1pdGVyOiAnLCcsIiwKICAgICAgICAgICAgICAgICIgICAgIGVzY2FwZUNoYXI6ICdcXFxcJywiLAogICAgICAgICAgICAgICAgIiAgICAgcXVvdGVDaGFyOiAnXFxcIicsIiwKICAgICAgICAgICAgICAgICIgICAgIGNvbHVtbk5hbWVzQXNIZWFkZXI6IHRydWUpIH4+IHNvdXJjZTEiLAogICAgICAgICAgICAgICAgInNvdXJjZTEgZGVyaXZlKGlzQ29sdW1uNkdyZWF0ZXJUaGFuMTAgPSBDb2x1bW42PjEwKSB+PiBkZXJpdmVkQ29sdW1uMSIsCiAgICAgICAgICAgICAgICAiZGVyaXZlZENvbHVtbjEgc2luayhhbGxvd1NjaGVtYURyaWZ0OiB0cnVlLCIsCiAgICAgICAgICAgICAgICAiICAgICB2YWxpZGF0ZVNjaGVtYTogZmFsc2UsIiwKICAgICAgICAgICAgICAgICIgICAgIGZvcm1hdDogJ2pzb24nLCIsCiAgICAgICAgICAgICAgICAiICAgICBmaWxlU3lzdGVtOiAnb3V0cHV0MScsIiwKICAgICAgICAgICAgICAgICIgICAgIHVtYXNrOiAwMDIyLCIsCiAgICAgICAgICAgICAgICAiICAgICBwcmVDb21tYW5kczogW10sIiwKICAgICAgICAgICAgICAgICIgICAgIHBvc3RDb21tYW5kczogW10sIiwKICAgICAgICAgICAgICAgICIgICAgIHNraXBEdXBsaWNhdGVNYXBJbnB1dHM6IHRydWUsIiwKICAgICAgICAgICAgICAgICIgICAgIHNraXBEdXBsaWNhdGVNYXBPdXRwdXRzOiB0cnVlKSB+PiBzaW5rMSIKICAgICAgICAgICAgXQogICAgICAgIH0KICAgIH0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Respuesta de muestra

status code:: 200

status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definiciones

Nombre	Description
DataflowDefinition	Objeto de definición pública de flujo de datos. Consulte este artículo para obtener más información sobre la estructura de la definición de flujo de datos.
DataflowDefinitionPart	Objeto de elemento de definición de flujo de datos.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
PayloadType	Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.
UpdateDataflowDefinitionRequest	Actualice la carga de la solicitud de definición pública del flujo de datos.

DataflowDefinition

Objeto

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

Nombre	Tipo	Description
format	string	Formato de la definición del flujo de datos.
parts	DataflowDefinitionPart[]	Lista de elementos de definición.

DataflowDefinitionPart

Objeto

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

Nombre	Tipo	Description
path	string	Ruta de acceso del elemento de definición pública del flujo de datos.
payload	string	Carga del elemento de definición pública de flujo de datos.
payloadType	PayloadType	Tipo de carga.

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.
isRetriable	boolean	Cuando es true, se puede reintentar la solicitud. Use el `Retry-After` encabezado de respuesta para determinar el retraso, si está disponible.
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.

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.

UpdateDataflowDefinitionRequest

Objeto

Actualice la carga de la solicitud de definición pública del flujo de datos.

Nombre	Tipo	Description
definition	DataflowDefinition	Objeto de definición pública de flujo de datos. Consulte este artículo para obtener más información sobre la estructura de la definición de flujo de datos.