Items - Get Data Pipeline Definition

Serviço:

DataPipeline

Versão da API:

v1

Retorna a definição pública do pipeline de dados especificada.
Essa API dá suporte a LRO (operações de execução longa).

Quando você obtém a definição pública de um DataPipeline, o rótulo de confidencialidade não faz parte da definição.

Permissões

O chamador deve ter permissões de leitura e gravação para o pipeline de dados.

Escopos delegados necessários

DataPipeline.ReadWrite.All ou Item.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Sim
Entidade de serviço e identidades gerenciadas	Sim

Interfase

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
dataPipelineId	path	True	string (uuid)	A ID do pipeline de dados.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.
format	query		string	O formato da definição pública do pipeline de dados.

Respostas

Nome	Tipo	Description
200 OK	DataPipelineDefinitionResponse	Solicitação concluída com êxito.
202 Accepted		Solicitação aceita. A recuperação da definição está em andamento. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: OperationNotSupportedForItem – Operação sem suporte para o item solicitado.

Exemplos

Get a data pipeline public definition example

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

{
  "definition": {
    "parts": [
      {
        "path": "pipeline-content.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Código de status:

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

Definições

Nome	Description
DataPipelineDefinition	Objeto de definição pública do pipeline de dados.
DataPipelineDefinitionPart	Objeto de parte da definição do pipeline de dados.
DataPipelineDefinitionResponse	Resposta de definição pública do pipeline de dados.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
PayloadType	O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

DataPipelineDefinition

Objeto

Objeto de definição pública do pipeline de dados.

Nome	Tipo	Description
format	string	O formato da definição do item.
parts	DataPipelineDefinitionPart[]	Uma lista de partes de definição.

DataPipelineDefinitionPart

Objeto

Objeto de parte da definição do pipeline de dados.

Nome	Tipo	Description
path	string	O caminho da parte do pipeline de dados.
payload	string	O conteúdo da parte do pipeline de dados.
payloadType	PayloadType	O tipo de conteúdo.

DataPipelineDefinitionResponse

Objeto

Resposta de definição pública do pipeline de dados.

Nome	Tipo	Description
definition	DataPipelineDefinition	Objeto de definição pública do pipeline de dados.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

PayloadType

Enumeração

O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
InlineBase64	Base 64 embutida.