Freigeben über

Items - Update Data Pipeline Definition

Dienst:
DataPipeline
API-Version:
v1

Überschreibt die Definition für die angegebene Datenpipeline.
Diese API unterstützt LRO-.

Das Aktualisieren der DataPipeline-Definition wirkt sich nicht auf die Vertraulichkeitsbezeichnung aus.

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}/updateDefinition
Mit optionalen Parametern: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/updateDefinition?updateMetadata={updateMetadata}

URI-Parameter

Name In Erforderlich Typ Beschreibung
dataPipelineId
 path True

string (uuid)

Die Datenpipeline-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.
updateMetadata
 query

boolean

Wenn sie auf "true" festgelegt ist und die PLATTFORM-Datei als Teil der Definition bereitgestellt wird, werden die Metadaten des Elements mithilfe der Metadaten in der PLATTFORM-Datei aktualisiert.

Anforderungstext

Name Erforderlich Typ Beschreibung
definition True

DataPipelineDefinition

Öffentliches Definitionsobjekt der Datenpipeline.

Antworten

Name Typ Beschreibung
200 OK

Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted

Anforderung angenommen. Die Updatedefinition 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.

  • CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Beispiele

Update a data pipeline public definition example

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
200
Statuscode:
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

Definitionen

Name Beschreibung
DataPipelineDefinition

Öffentliches Definitionsobjekt der Datenpipeline.
DataPipelineDefinitionPart

Datenpipelinedefinitionsteilobjekt.
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.
UpdateDataPipelineDefinitionRequest

Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung für die Datenpipeline.

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.

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.

UpdateDataPipelineDefinitionRequest

Objekt

Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung für die Datenpipeline.

Name Typ Beschreibung
definition

DataPipelineDefinition

Öffentliches Definitionsobjekt der Datenpipeline.