Items - Get Data Pipeline Definition

Dienst:

DataPipeline

API-Version:

v1

Gibt die angegebene öffentliche Definition der Datenpipeline zurück.
Diese API unterstützt LRO-.

Wenn Sie die öffentliche Definition einer DataPipeline erhalten, ist die Vertraulichkeitsbezeichnung kein Bestandteil der Definition.

Erlaubnisse

Der Aufrufer muss Über Lese- und Schreibberechtigungen für die Datenpipeline verfügen.

Erforderliche delegierte Bereiche

DataPipeline.ReadWrite.All oder Item.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Unterstützung
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Ja

Schnittstelle

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dataPipelineId	path	True	string (uuid)	Die Datenpipeline-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
format	query		string	Das Format der öffentlichen Definition der Datenpipeline.

Antworten

Name	Typ	Beschreibung
200 OK	DataPipelineDefinitionResponse	Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted		Anforderung angenommen. Das Abrufen der Definition wird ausgeführt. Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt.

Beispiele

Get a data pipeline public definition example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

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

Statuscode:

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

Definitionen

Name	Beschreibung
DataPipelineDefinition	Öffentliches Definitionsobjekt der Datenpipeline.
DataPipelineDefinitionPart	Datenpipelinedefinitionsteilobjekt.
DataPipelineDefinitionResponse	Antwort auf öffentliche Definition der Datenpipeline.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

DataPipelineDefinition

Objekt

Öffentliches Definitionsobjekt der Datenpipeline.

Name	Typ	Beschreibung
format	string	Das Format der Elementdefinition.
parts	DataPipelineDefinitionPart[]	Eine Liste der Definitionsteile.

DataPipelineDefinitionPart

Objekt

Datenpipelinedefinitionsteilobjekt.

Name	Typ	Beschreibung
path	string	Der Datenpipelineteilpfad.
payload	string	Die Datenpipelineteilnutzlast.
payloadType	PayloadType	Der Nutzlasttyp.

DataPipelineDefinitionResponse

Objekt

Antwort auf öffentliche Definition der Datenpipeline.

Name	Typ	Beschreibung
definition	DataPipelineDefinition	Öffentliches Definitionsobjekt der Datenpipeline.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
InlineBase64	Inlinebasis 64.