Items - Update Dataflow Definition

Dienst:: Dataflow

API-Version:: v1

Überschreibt die Definition für den angegebenen Dataflow.
Diese API unterstützt LRO-.

Das Aktualisieren der Datenflussdefinition wirkt sich nicht auf die Vertraulichkeitsbezeichnung aus.

Erlaubnisse

Der Aufrufer muss Lese- und Schreibberechtigungen für den Datenfluss besitzen.

Erforderliche delegierte Bereiche

Dataflow.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}/dataflows/{dataflowId}/updateDefinition

Mit optionalen Parametern:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/updateDefinition?updateMetadata={updateMetadata}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dataflowId	path	True	string (uuid)	Die Datenfluss-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	DataflowDefinition	Öffentliches Dataflow-Definitionsobjekt. Weitere Informationen zur Struktur der Dataflow-Definition finden Sie in diesem Artikel .

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
429 Too Many Requests	ErrorResponse	Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header 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 Dataflow public definition example

Beispielanforderung

HTTP

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

{
  "definition": {
    "parts": [
      {
        "path": "queryMetadata.json",
        "payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "mashup.pq",
        "payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwo=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
        "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
DataflowDefinition	Öffentliches Dataflow-Definitionsobjekt. Weitere Informationen zur Struktur der Dataflow-Definition finden Sie in diesem Artikel .
DataflowDefinitionPart	Dataflow Definition Part-Objekt.
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.
UpdateDataflowDefinitionRequest	Aktualisieren sie die Nutzlast der öffentlichen Datenflussdefinitionsanforderung.

DataflowDefinition

Objekt

Öffentliches Dataflow-Definitionsobjekt. Weitere Informationen zur Struktur der Dataflow-Definition finden Sie in diesem Artikel .

Name	Typ	Beschreibung
format	string	Das Format der Datenflussdefinition.
parts	DataflowDefinitionPart[]	Eine Liste der Definitionsteile.

DataflowDefinitionPart

Objekt

Dataflow Definition Part-Objekt.

Name	Typ	Beschreibung
path	string	Der Datenfluss-Teilpfad für öffentliche Definition.
payload	string	Die Nutzlast des öffentlichen Dataflow-Definitionsteils.
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.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den `Retry-After` Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	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.

UpdateDataflowDefinitionRequest

Objekt

Aktualisieren sie die Nutzlast der öffentlichen Datenflussdefinitionsanforderung.

Name	Typ	Beschreibung
definition	DataflowDefinition	Öffentliches Dataflow-Definitionsobjekt. Weitere Informationen zur Struktur der Dataflow-Definition finden Sie in diesem Artikel .