Öffentliche APIs-Funktionen für Dataflows Gen2 in Fabric Data Factory

Fabric Data Factory bietet einen robusten Satz von APIs, mit denen Benutzer ihre Datenflüsse effizient automatisieren und verwalten können. Diese APIs ermöglichen eine nahtlose Integration in verschiedene Datenquellen und Dienste, sodass Benutzer ihre Datenworkflows programmgesteuert erstellen, aktualisieren und überwachen können. Die APIs unterstützen eine breite Palette von Vorgängen, einschließlich Dataflows CRUD (Create, Read, Update und Delete), Planung und Überwachung, wodurch Benutzer ihre Datenintegrationsprozesse einfacher verwalten können.

APIs-Anwendungsfälle für Dataflows

Die APIs für Datenflüsse in Fabric Data Factory können in verschiedenen Szenarien verwendet werden:

Automatisierte Bereitstellung: Automatisieren Sie die Bereitstellung von Datenflüssen in verschiedenen Umgebungen (Entwicklung, Test, Produktion) mithilfe von CI/CD-Praktiken.
Überwachung und Warnungen: Richten Sie automatisierte Überwachungs- und Alarmsysteme ein, um den Status von Datenflüssen nachzuverfolgen und Benachrichtigungen bei Fehlern oder Leistungsproblemen zu empfangen.
Datenintegration: Integrieren von Daten aus mehreren Quellen, z. B. Datenbanken, Datenseen und Clouddiensten, in einen einheitlichen Datenfluss zur Verarbeitung und Analyse.
Fehlerbehandlung: Implementieren Sie benutzerdefinierte Fehlerbehandlungs- und Wiederholungsmechanismen, um sicherzustellen, dass Datenflüsse reibungslos ausgeführt und von Fehlern wiederhergestellt werden.

Grundlegendes zu APIs

Um die APIs für Datenflüsse in Fabric Data Factory effektiv zu nutzen, ist es wichtig, die wichtigsten Konzepte und Komponenten zu verstehen:

Endpunkte: Die API-Endpunkte bieten Zugriff auf verschiedene Datenflussvorgänge, z. B. Erstellen, Aktualisieren und Löschen von Datenflüssen.
Authentifizierung: Sicherer Zugriff auf die APIs mithilfe von Authentifizierungsmechanismen wie OAuth oder API-Schlüsseln.
Anforderungen und Antworten: Verstehen der Struktur von API-Anforderungen und -Antworten, einschließlich der erforderlichen Parameter und der erwarteten Ausgabe.
Ratenbeschränkungen: Beachten Sie die für die API-Nutzung auferlegten Ratenbeschränkungen, um zu vermeiden, dass die zulässige Anzahl von Anforderungen überschritten wird.

CRUD-Unterstützung

CRUD steht für Create, Read, Update und Delete, bei denen es sich um die vier grundlegenden Vorgänge handelt, die für Daten ausgeführt werden können. In Fabric Data Factory werden die CRUD-Vorgänge über die Fabric-API für Data Factory unterstützt. Mit diesen APIs können Benutzer ihre Datenflüsse programmgesteuert verwalten. Hier sind einige wichtige Punkte zur CRUD-Unterstützung:

Erstellen: Erstellen Sie neue Datenflüsse mit der API. Dazu gehört die Definition der Datenflussstruktur, das Angeben von Datenquellen, Transformationen und Zielen.
Lesen: Abrufen von Informationen zu vorhandenen Datenflüssen. Dazu gehören Details zu konfiguration, Status und Ausführungsverlauf.
Update: Aktualisieren vorhandener Datenflüsse. Dies kann das Ändern der Datenflussstruktur, das Ändern von Datenquellen oder das Aktualisieren der Transformationslogik umfassen.
Löschen: Löschen Sie Datenflüsse, die nicht mehr benötigt werden. Dies hilft beim Verwalten und Bereinigen von Ressourcen.

Die primäre Online-Referenzdokumentation für Microsoft Fabric-REST-APIs finden Sie in Microsoft Fabric-REST-API-Referenzen .

Dataflow-Lebenszyklus

Beim Arbeiten mit Datenflüssen ist es wichtig, den Lebenszyklus eines Datenflusses zu verstehen, um reibungslose und effiziente Datenintegrationsprozesse sicherzustellen. Die wichtigsten Phasen des Datenflusslebenszyklus umfassen

Definition: Dies ist die erste Phase, in der Sie die Definition eines Datenflusses erstellen oder ändern. Dazu gehören die Angabe der Datenquellen, Transformationen und Definitionen.
Veröffentlichen: Nachdem Sie die Definition eines Datenflusses geändert haben, müssen Sie den Veröffentlichungsvorgang aufrufen. Dies ist ein wichtiger Schritt, da die an der Definition des Datenflusses vorgenommenen Änderungen gespeichert und zur Ausführung zur Verfügung gestellt werden.
Auffrischen: Nachdem der Datenfluss veröffentlicht wurde, können Sie den Aktualisierungsvorgang aufrufen. Dadurch wird der auszuführende Datenfluss ausgelöst, Daten aus den angegebenen Quellen abgerufen, die definierten Transformationen angewendet und die Daten in das Ziel geladen.

Erste Schritte mit öffentlichen APIs für Datenflüsse

In diesem Abschnitt behandeln wir alle folgenden Themen:

Abrufen eines Autorisierungstokens
Erstellen eines Datenflusses
Erstellen eines Datenflusses mit Definition
Datenflow abrufen
Datenfluss mit Definition abrufen
Datenfluss aktualisieren
Aktualisieren des Datenflusses mit Definition
Datenfluss löschen
On-Demand-Datenflussauftrag ausführen (Aktualisieren)
On-Demand Dataflow-Veröffentlichungsauftrag ausführen
Datenfluss-Job-Instanz abrufen
Datenflussauftragsinstanz abbrechen

Ein Autorisierungstoken holen

Sie müssen über das Bearertoken für alle REST-API-Aufrufe verfügen, und Sie können es mit einer der folgenden Optionen abrufen:

MSAL.Net
Fabric-Portal

MSAL.Net

Fabric-API – Schnellstart : Microsoft Fabric-REST-APIs

Verwenden Sie MSAL.Net, um ein Microsoft Entra ID-Token für den Fabric-Dienst mit den folgenden Berechtigungen abzurufen: Workspace.ReadWrite.All, Item.ReadWrite.All. Weitere Informationen zum Tokenerwerb mithilfe von MSAL.Net finden Sie unter Tokenerwerb – Microsoft Authentication Library für .NET.

Fügen Sie die zuvor kopierte Anwendungs-ID (Client-ID) für die ClientId-Variable ein.

Gewebeportal

Melden Sie sich beim Fabric-Portal für den Mandanten an, auf dem Sie testen möchten.. Drücken Sie F12, um den Entwicklermodus des Browsers aufzurufen. Führen Sie in der Konsole dort Folgendes aus:

powerBIAccessToken

Kopieren Sie das Token, und fügen Sie es für die ClientId-Variable ein.

Erstellen eines Datenflusses

Erstellen Sie einen Datenfluss in einem angegebenen Arbeitsbereich.

Beispiel für eine Anforderung

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items)

Headers:

{
    "Authorization": "\<bearer-token>",
    "Content-Type": "application/json"
}

Payload:

{
    "displayName": "My dataflow",
    "description": "My dataflow description",
    "type": "Dataflow"
}

Beispielantwort

{
    "id": "\<itemId>",
    "type": "Dataflow",
    "displayName": "My dataflow",
    "description": "My dataflow description",
    "workspaceId": "\<workspaceId>"
}

Erstellen eines Datenflusses mit Definition

Erstellen Sie einen Datenfluss mit einer Base64-Definition in einem angegebenen Arbeitsbereich.

Mashup-Beispieldokument

{
    "editingSessionMashup": {
            "mashupName": "",
            "mashupDocument": "section Section1;\r\nshared Query = let\n Source = Table.FromRows(\n {\n {1, \"Bob\", \"123-4567\"},\n {2, \"Jim\", \"987-6543\"}\n },\n {\"CustomerID\", \"Name\", \"Phone\"})\nin\n Source;\r\n",
            "queryGroups": [],
            "documentLocale": "en-US",
            "gatewayObjectId": null,
            "queriesMetadata": null,
            "connectionOverrides": [],
            "trustedConnections": null,
            "useHostConnectionProvider": false,
            "fastCombine": false,
            "allowNativeQueries": true,
            "allowedModules": null,
            "skipAutomaticTypeAndHeaderDetection": false,
            "disableAutoAnonymousConnectionUpsert": null,
            "hostProperties": {
                    "DataflowRefreshOutputFileFormat": "Parquet",
                    "EnableDateTimeFieldsForStaging": "true",
                    "EnablePublishWithoutLoadedQueries": "true"
            },
            "defaultOutputDestinationConfiguration": null,
            "stagingDefinition": null
    }
}

Verwenden Sie Base64-Codieren und -Decodieren, um Ihren JSON zu codieren.

Achten Sie darauf, dass das Kästchen für eine URL-sichere Codierung nicht aktiviert ist.

Fügen Sie die Antwort Ihrer codierten Base64-Anforderungsnutzlast in die Nutzlastdefinition ein.

Beispiel für eine Anforderung

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items)

Headers:

{
    "Authorization": "\<bearer-token>",
    "Content-Type": "application/json"
}

Payload:

{
    "displayName": " My dataflow",
    "description": "My dataflow description",

    "type": "Dataflow",
    "definition": {  
        "parts": [  
            {  
                "path": "dataflow-content.json",  
                "payload": "ewogICAgImVkaXRpbmdTZXNzaW9uTWFzaHVwIjogewogICAgICAgICJtYXNodXBOYW1lIjogIiIsCiAgICAgICAgIm1hc2h1cERvY3VtZW50IjogInNlY3Rpb24gU2VjdGlvbjE7XHJcbnNoYXJlZCBRdWVyeSA9IGxldFxuIFNvdXJjZSA9IFRhYmxlLkZyb21Sb3dzKFxuIHtcbiB7MSwgXCJCb2JcIiwgXCIxMjMtNDU2N1wifSxcbiB7MiwgXCJKaW1cIiwgXCI5ODctNjU0M1wifVxuIH0sXG4ge1wiQ3VzdG9tZXJJRFwiLCBcIk5hbWVcIiwgXCJQaG9uZVwifSlcbmluXG4gU291cmNlO1xyXG4iLAogICAgICAgICJxdWVyeUdyb3VwcyI6IFtdLAogICAgICAgICJkb2N1bWVudExvY2FsZSI6ICJlbi1VUyIsCiAgICAgICAgImdhdGV3YXlPYmplY3RJZCI6IG51bGwsCiAgICAgICAgInF1ZXJpZXNNZXRhZGF0YSI6IG51bGwsCiAgICAgICAgImNvbm5lY3Rpb25PdmVycmlkZXMiOiBbXSwKICAgICAgICAidHJ1c3RlZENvbm5lY3Rpb25zIjogbnVsbCwKICAgICAgICAidXNlSG9zdENvbm5lY3Rpb25Qcm92aWRlciI6IGZhbHNlLAogICAgICAgICJmYXN0Q29tYmluZSI6IGZhbHNlLAogICAgICAgICJhbGxvd05hdGl2ZVF1ZXJpZXMiOiB0cnVlLAogICAgICAgICJhbGxvd2VkTW9kdWxlcyI6IG51bGwsCiAgICAgICAgInNraXBBdXRvbWF0aWNUeXBlQW5kSGVhZGVyRGV0ZWN0aW9uIjogZmFsc2UsCiAgICAgICAgImRpc2FibGVBdXRvQW5vbnltb3VzQ29ubmVjdGlvblVwc2VydCI6IG51bGwsCiAgICAgICAgImhvc3RQcm9wZXJ0aWVzIjogewogICAgICAgICAgICAiRGF0YWZsb3dSZWZyZXNoT3V0cHV0RmlsZUZvcm1hdCI6ICJQYXJxdWV0IiwKICAgICAgICAgICAgIkVuYWJsZURhdGVUaW1lRmllbGRzRm9yU3RhZ2luZyI6ICJ0cnVlIiwKICAgICAgICAgICAgIkVuYWJsZVB1Ymxpc2hXaXRob3V0TG9hZGVkUXVlcmllcyI6ICJ0cnVlIgogICAgICAgIH0sCiAgICAgICAgImRlZmF1bHRPdXRwdXREZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb24iOiBudWxsLAogICAgICAgICJzdGFnaW5nRGVmaW5pdGlvbiI6IG51bGwKICAgIH0KfQ==",
                "payloadType": "InlineBase64"  
            }  
        ]  
    }  
}

Beispielantwort

{
    "id": "\<itemId>",
    "type": "Dataflow",
    "displayName": "My dataflow",
    "description": "My dataflow description",
    "workspaceId": "\<workspaceId>"
}

Dataflow abrufen

Gibt Eigenschaften des angegebenen Datenflusses zurück.

Beispiel für eine Anforderung

URI: GET [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d)

Headers:

{
    "Authorization": "\<bearer-token>"
}

Beispielantwort

{
    "id": "\<itemId>",
    "type": "Dataflow",
    "displayName": "My dataflow",
    "description": "My dataflow description",
    "workspaceId": "\<workspaceId>"
}

Datenfluss mit Definition abrufen

Gibt die Datenflusselementdefinition zurück.

Beispiel für eine Anforderung

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/getDefinition](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/getDefinition)

Headers:

{
    "Authorization": "\<bearer-token>"
}

Beispielantwort

{ 

    "definition": { 

        "parts": [ 

            { 

                "path": "dataflow-content.json", 

                "payload": " ewogICAgImVkaXRpbmdTZXNzaW9uTWFzaHVwIjogewogICAgICAgICJtYXNodXBOYW1lIjogIiIsCiAgICAgICAgIm1hc2h1cERvY3VtZW50IjogInNlY3Rpb24gU2VjdGlvbjE7XHJcbnNoYXJlZCBRdWVyeSA9IGxldFxuIFNvdXJjZSA9IFRhYmxlLkZyb21Sb3dzKFxuIHtcbiB7MSwgXCJCb2JcIiwgXCIxMjMtNDU2N1wifSxcbiB7MiwgXCJKaW1cIiwgXCI5ODctNjU0M1wifVxuIH0sXG4ge1wiQ3VzdG9tZXJJRFwiLCBcIk5hbWVcIiwgXCJQaG9uZVwifSlcbmluXG4gU291cmNlO1xyXG4iLAogICAgICAgICJxdWVyeUdyb3VwcyI6IFtdLAogICAgICAgICJkb2N1bWVudExvY2FsZSI6ICJlbi1VUyIsCiAgICAgICAgImdhdGV3YXlPYmplY3RJZCI6IG51bGwsCiAgICAgICAgInF1ZXJpZXNNZXRhZGF0YSI6IG51bGwsCiAgICAgICAgImNvbm5lY3Rpb25PdmVycmlkZXMiOiBbXSwKICAgICAgICAidHJ1c3RlZENvbm5lY3Rpb25zIjogbnVsbCwKICAgICAgICAidXNlSG9zdENvbm5lY3Rpb25Qcm92aWRlciI6IGZhbHNlLAogICAgICAgICJmYXN0Q29tYmluZSI6IGZhbHNlLAogICAgICAgICJhbGxvd05hdGl2ZVF1ZXJpZXMiOiB0cnVlLAogICAgICAgICJhbGxvd2VkTW9kdWxlcyI6IG51bGwsCiAgICAgICAgInNraXBBdXRvbWF0aWNUeXBlQW5kSGVhZGVyRGV0ZWN0aW9uIjogZmFsc2UsCiAgICAgICAgImRpc2FibGVBdXRvQW5vbnltb3VzQ29ubmVjdGlvblVwc2VydCI6IG51bGwsCiAgICAgICAgImhvc3RQcm9wZXJ0aWVzIjogewogICAgICAgICAgICAiRGF0YWZsb3dSZWZyZXNoT3V0cHV0RmlsZUZvcm1hdCI6ICJQYXJxdWV0IiwKICAgICAgICAgICAgIkVuYWJsZURhdGVUaW1lRmllbGRzRm9yU3RhZ2luZyI6ICJ0cnVlIiwKICAgICAgICAgICAgIkVuYWJsZVB1Ymxpc2hXaXRob3V0TG9hZGVkUXVlcmllcyI6ICJ0cnVlIgogICAgICAgIH0sCiAgICAgICAgImRlZmF1bHRPdXRwdXREZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb24iOiBudWxsLAogICAgICAgICJzdGFnaW5nRGVmaW5pdGlvbiI6IG51bGwKICAgIH0KfQ==" 

                "payloadType": "InlineBase64" 

            }, 

            { 

                "path": ".platform", 

                "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJEYXRhZmxvdyAzIgogIH0sCiAgImNvbmZpZyI6IHsKICAgICJ2ZXJzaW9uIjogIjIuMCIsCiAgICAibG9naWNhbElkIjogIjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCIKICB9Cn0=", 

                "payloadType": "InlineBase64" 

            } 

        ] 

    } 

}

ANTWORT VON API

{ 
    'definition':  
    { 
        'parts': [ 
            { 
                'path': 'queryMetadata.json', 'payload': '<super long entry>', 'payloadType': 'InlineBase64' 
            }, 
            { 
                'path': 'mashup.pq', 'payload': '<super long entry>', 'payloadType': 'InlineBase64' 
            }, 
            { 
                'path': '.platform', 'payload': '<super long entry>', 'payloadType': 'InlineBase64' 
            } 
        ] 
    } 
}

Datenfluss aktualisieren

Aktualisiert die Eigenschaften des Datenflusses.

Beispiel für eine Anforderung

URI: PATCH [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d)  

Headers: 

{ 
  "Authorization": "\<bearer-token>", 
  "Content-Type": "application/json" 
} 

Payload: 
{ 
  "displayName": "My dataflow updated", 
  "description": "My dataflow description updated", 
  "type": "Dataflow" 
}

Beispielantwort

{ 
    "id": "\<itemId>", 
    "type": "Dataflow", 
    "displayName": "My dataflow updated", 
    "description": "My dataflow description updated", 
    "workspaceId": "\<workspaceId>" 
}

Aktualisieren des Datenflusses mit Definition

Aktualisiert die Datenflusselementdefinition.

Beispiel für eine Anforderung

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/updateDefinition](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/updateDefinition) 

Headers: 

{ 
  "Authorization": "\<bearer-token>", 
  "Content-Type": "application/json" 
} 

Payload: 

{ 
  "displayName": " My dataflow", 
  "type": "Dataflow", 
  "definition": { 
    "parts": [  
      {  
        "path": "dataflow-content.json",  
        "payload": " ewogICAgImVkaXRpbmdTZXNzaW9uTWFzaHVwIjogewogICAgICAgICJtYXNodXBOYW1lIjogIiIsCiAgICAgICAgIm1hc2h1cERvY3VtZW50IjogInNlY3Rpb24gU2VjdGlvbjE7XHJcbnNoYXJlZCBRdWVyeSA9IGxldFxuIFNvdXJjZSA9IFRhYmxlLkZyb21Sb3dzKFxuIHtcbiB7MSwgXCJCb2JcIiwgXCIxMjMtNDU2N1wifSxcbiB7MiwgXCJKaW1cIiwgXCI5ODctNjU0M1wifVxuIH0sXG4ge1wiQ3VzdG9tZXJJRFwiLCBcIk5hbWVcIiwgXCJQaG9uZVwifSlcbmluXG4gU291cmNlO1xyXG4iLAogICAgICAgICJxdWVyeUdyb3VwcyI6IFtdLAogICAgICAgICJkb2N1bWVudExvY2FsZSI6ICJlbi1VUyIsCiAgICAgICAgImdhdGV3YXlPYmplY3RJZCI6IG51bGwsCiAgICAgICAgInF1ZXJpZXNNZXRhZGF0YSI6IG51bGwsCiAgICAgICAgImNvbm5lY3Rpb25PdmVycmlkZXMiOiBbXSwKICAgICAgICAidHJ1c3RlZENvbm5lY3Rpb25zIjogbnVsbCwKICAgICAgICAidXNlSG9zdENvbm5lY3Rpb25Qcm92aWRlciI6IGZhbHNlLAogICAgICAgICJmYXN0Q29tYmluZSI6IGZhbHNlLAogICAgICAgICJhbGxvd05hdGl2ZVF1ZXJpZXMiOiB0cnVlLAogICAgICAgICJhbGxvd2VkTW9kdWxlcyI6IG51bGwsCiAgICAgICAgInNraXBBdXRvbWF0aWNUeXBlQW5kSGVhZGVyRGV0ZWN0aW9uIjogZmFsc2UsCiAgICAgICAgImRpc2FibGVBdXRvQW5vbnltb3VzQ29ubmVjdGlvblVwc2VydCI6IG51bGwsCiAgICAgICAgImhvc3RQcm9wZXJ0aWVzIjogewogICAgICAgICAgICAiRGF0YWZsb3dSZWZyZXNoT3V0cHV0RmlsZUZvcm1hdCI6ICJQYXJxdWV0IiwKICAgICAgICAgICAgIkVuYWJsZURhdGVUaW1lRmllbGRzRm9yU3RhZ2luZyI6ICJ0cnVlIiwKICAgICAgICAgICAgIkVuYWJsZVB1Ymxpc2hXaXRob3V0TG9hZGVkUXVlcmllcyI6ICJ0cnVlIgogICAgICAgIH0sCiAgICAgICAgImRlZmF1bHRPdXRwdXREZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb24iOiBudWxsLAogICAgICAgICJzdGFnaW5nRGVmaW5pdGlvbiI6IG51bGwKICAgIH0KfQ==",  
        "payloadType": "InlineBase64"  
      } 
    ] 
  } 
}

Beispielantwort

200 OK

Datenfluss löschen

Löscht den angegebenen Datenfluss.

Beispiel für eine Anforderung

URI: DELETE [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d)  

Headers: 

{ 
  "Authorization": "\<bearer-token>" 
}

Beispielantwort

200 OK

On-Demand-Datenflussauftrag ausführen (Erneuerung)

Führt den Datenflussauftrag bei Bedarf für die Aktualisierungsinstanz aus.

Beispiel für eine Anforderung

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances?jobType=Refresh](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/jobs/instances?jobType=Refresh)  

Headers: 

{ 
  "Authorization": "\<bearer-token>" 
} 

Payload: 

{ 
    "executionData": { 
        "DataflowName": "Dataflow", 
        "OwnerUserPrincipalName": "\<name@email.com>", 
        "OwnerUserObjectId": "\<ObjectId>" 
    } 
}

Beispielantwort

202 Accepted 
[ 
  { 
    "id": "\<jobId>", 
    "itemId": "\<dataflowItemId>", 
    "jobType": "Refresh", 
    "invokeType": "OnDemand", 
    "status": "Accepted", 
    "jobInstanceId": "\<uniqueJobInstanceId>", 
    "rootActivityId": "\<rootActivityId>", 
    "startTimeUtc": "2025-01-30T11:10:50Z", 
    "endTimeUtc": null, 
    "failureReason": null 
  } 
]

On-Demand Dataflow-Veröffentlichungsauftrag ausführen

Führt on-Demand-Datenflussauftrag für die Veröffentlichungsinstanz aus.

Beispiel für eine Anforderung

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances?jobType=Publish](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/jobs/instances?jobType=Publish) 

Headers: 

{ 
  "Authorization": "\<bearer-token>" 
} 

Payload: 

{ 
    "executionData": { 
        "DataflowName": "Dataflow", 
        "OwnerUserPrincipalName": "\<name@email.com>", 
        "OwnerUserObjectId": "\<ObjectId>" 
    }
}

Beispielantwort

202 Accepted 

[ 
  { 
    "id": "\<jobId>", 
    "itemId": "\<dataflowItemId>", 
    "jobType": "Publish", 
    "invokeType": "OnDemand", 
    "status": "Accepted", 
    "jobInstanceId": "\<uniqueJobInstanceId>", 
    "rootActivityId": "\<rootActivityId>", 
    "startTimeUtc": "2025-01-30T11:10:50Z", 
    "endTimeUtc": null, 
    "failureReason": null 
  } 
]

Datenflow-Jobinstanz abrufen

Ruft die Aufgabeninstanz des einzelnen Datenflusses ab.

Beispiel für eine Anforderung

URI: GET [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances/{jobInstanceId}](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/jobs/instances/%7bjobInstanceId%7d)  

Headers: 

{ 
  "Authorization": "\<bearer-token>" 
}

Beispielantwort

{ 
  "id": "\<id>", 
  "itemId": "<itemId?", 
  "jobType": "Refresh", 
  "invokeType": "Manual", 
  "status": "Completed", 
  "rootActivityId": "\<rootActivityId>", 
  "startTimeUtc": "2023-08-22T06:35:00.7812154", 
  "endTimeUtc": "2023-08-22T06:35:00.8033333", 
  "failureReason": null 
}

Instanz des Dataflow-Jobs abbrechen

Abbrechen einer Datenfluss-Auftragsinstanz

Beispiel für eine Anforderung

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances/{jobInstanceId}/cancel](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/jobs/instances/%7bjobInstanceId%7d/cancel)  

Headers: 

{ 
  "Authorization": "\<bearer-token>"
}

Beispielantwort

Location: https://api.fabric.microsoft.com/v1/workspaces/\<worksapceId>/items/\<itemId>/jobs/instances/\<jobInstanceId> 

Retry-After: 60

Aktuelle Einschränkungen

Die Dienstprinzipalauthentifizierung wird derzeit nicht unterstützt.
"Element abrufen" und "Details zum Listenelementzugriff" geben nicht die richtigen Informationen zurück, wenn Sie nach dem Datenflusselementtyp filtern.
Wenn Sie nicht den Typ angeben, gibt er die Dataflow Gen2 (CI/CD, Vorschau) zurück – die neue Dataflow Gen2 mit CI/CD und GIT-Unterstützung.
Run-APIs sind aufrufbar, aber der tatsächliche Lauf ist nie erfolgreich.

Freigeben über

Öffentliche APIs-Funktionen für Dataflows Gen2 in Fabric Data Factory

APIs-Anwendungsfälle für Dataflows

Grundlegendes zu APIs

CRUD-Unterstützung

Dataflow-Lebenszyklus

Erste Schritte mit öffentlichen APIs für Datenflüsse

Ein Autorisierungstoken holen

MSAL.Net

Gewebeportal

Erstellen eines Datenflusses

Erstellen eines Datenflusses mit Definition

Dataflow abrufen

Datenfluss mit Definition abrufen

Datenfluss aktualisieren

Aktualisieren des Datenflusses mit Definition

Datenfluss löschen

On-Demand-Datenflussauftrag ausführen (Erneuerung)

On-Demand Dataflow-Veröffentlichungsauftrag ausführen

Datenflow-Jobinstanz abrufen

Instanz des Dataflow-Jobs abbrechen

Aktuelle Einschränkungen

Verwandte Inhalte

Dokumentation

Anleitungen

Feedback

Zusätzliche Ressourcen