Compartir a través de

Items - Get Data Pipeline Definition

Servicio:
DataPipeline
Versión de la API:
v1

Devuelve la definición pública de canalización de datos especificada.
Esta API admite operaciones de larga duración (LRO).

Cuando se obtiene la definición pública de DataPipeline, la etiqueta de confidencialidad no forma parte de la definición.

Permisos

El autor de la llamada debe tener permisos de lectura y escritura para la canalización de datos.

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

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition
Con parámetros opcionales: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition?format={format}

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)

El identificador del área de trabajo.
format
 query

string

Formato de la definición pública de la canalización de datos.

Respuestas

Nombre Tipo Description
200 OK

DataPipelineDefinitionResponse

Solicitud completada correctamente.
202 Accepted

Solicitud aceptada. La recuperación de la definición está en curso.

Encabezados

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • OperationNotSupportedForItem: no se admite la operación para el elemento solicitado.

Ejemplos

Get a data pipeline public definition example

Solicitud de ejemplo

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/dataPipelines/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Respuesta de muestra

status code:
200 
{
  "definition": {
    "parts": [
      {
        "path": "pipeline-content.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
status code:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definiciones

Nombre Description
DataPipelineDefinition

Objeto de definición pública de canalización de datos.
DataPipelineDefinitionPart

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

Respuesta de definición pública 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.
PayloadType

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

DataPipelineDefinition

Object

Objeto de definición pública 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

Object

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.

DataPipelineDefinitionResponse

Object

Respuesta de definición pública de canalización de datos.

Nombre Tipo Description
definition

DataPipelineDefinition

Objeto de definición pública de canalización de datos.

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.

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.