Items - Get Data Pipeline Definition

Tjeneste:

DataPipeline

API-version:

v1

Returnerer den angivne offentlige definition af datapipeline.
Denne API understøtter LRO-handlinger (Long Running Operations).

Når du får vist en offentlig definition af en DataPipeline, er følsomhedsmærkaten ikke en del af definitionen.

Tilladelser

Den, der ringer op, skal have læse- og skrivetilladelser til datapipelinen.

Påkrævede delegerede områder

DataPipeline.ReadWrite.All eller Item.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

Med valgfrie parametre:

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
dataPipelineId	path	True	string (uuid)	Datapipeline-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
format	query		string	Formatet af den offentlige definition af datapipelinen.

Svar

Name	Type	Beskrivelse
200 OK	DataPipelineDefinitionResponse	Anmodningen blev fuldført.
202 Accepted		Anmodningen blev accepteret. Hentning af definitionen er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: OperationNotSupportedForItem – Handlingen understøttes ikke for det ønskede element.

Eksempler

Get a data pipeline public definition example

Eksempelanmodning

HTTP

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

Eksempelsvar

Statuskode:

200

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

Statuskode:

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

Definitioner

Name	Beskrivelse
DataPipelineDefinition	Offentligt definitionsobjekt for datapipeline.
DataPipelineDefinitionPart	Delobjekt for definition af datapipeline.
DataPipelineDefinitionResponse	Svar på offentlig definition af datapipeline.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

DataPipelineDefinition

Object

Offentligt definitionsobjekt for datapipeline.

Name	Type	Beskrivelse
format	string	Formatet af elementdefinitionen.
parts	DataPipelineDefinitionPart[]	En liste over definitionsdele.

DataPipelineDefinitionPart

Object

Delobjekt for definition af datapipeline.

Name	Type	Beskrivelse
path	string	Stien til datapipelinedelen.
payload	string	Datapipelinedelens nyttedata.
payloadType	PayloadType	Nyttedatatypen.

DataPipelineDefinitionResponse

Object

Svar på offentlig definition af datapipeline.

Name	Type	Beskrivelse
definition	DataPipelineDefinition	Offentligt definitionsobjekt for datapipeline.

ErrorRelatedResource

Object

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Object

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.