Funkcje publicznych interfejsów API dla przepływów danych Gen2 w usłudze Fabric Data Factory

Usługa Fabric Data Factory udostępnia niezawodny zestaw interfejsów API, które umożliwiają użytkownikom wydajne automatyzowanie przepływów danych i zarządzanie nimi. Te interfejsy API umożliwiają bezproblemową integrację z różnymi źródłami danych i usługami, umożliwiając użytkownikom programowe tworzenie, aktualizowanie i monitorowanie przepływów pracy danych. Interfejsy API obsługują szeroką gamę operacji, w tym przepływów danych CRUD (tworzenie, odczytywanie, aktualizowanie i usuwanie), planowanie i monitorowanie, co ułatwia użytkownikom zarządzanie procesami integracji danych.

Przypadki użycia interfejsów API dla przepływów danych

Interfejsy API dla przepływów danych w usłudze Fabric Data Factory mogą być używane w różnych scenariuszach:

Automatyczne wdrażanie: Zautomatyzuj wdrażanie przepływów danych w różnych środowiskach (rozwojowe, testowanie, produkcyjne) przy użyciu zasad CI/CD.
Monitorowanie i alerty: skonfiguruj zautomatyzowane systemy monitorowania i alertów, aby śledzić stan przepływów danych i otrzymywać powiadomienia w przypadku awarii lub problemów z wydajnością.
Integracja danych: integrowanie danych z wielu źródeł, takich jak bazy danych, magazyny danych i usługi w chmurze, w ujednolicony przepływ danych do przetwarzania i analizy.
Obsługa błędów: Zaimplementuj niestandardowe mechanizmy obsługi błędów i ponawiania prób, aby zapewnić bezproblemowe uruchamianie przepływów danych i odzyskiwanie po awariach.

Opis interfejsów API

Aby efektywnie korzystać z interfejsów API dla przepływów danych w usłudze Fabric Data Factory, ważne jest zrozumienie kluczowych pojęć i składników:

Punkty końcowe: punkty końcowe interfejsu API zapewniają dostęp do różnych operacji przepływu danych, takich jak tworzenie, aktualizowanie i usuwanie przepływów danych.
Uwierzytelnianie: bezpieczny dostęp do interfejsów API przy użyciu mechanizmów uwierzytelniania, takich jak OAuth lub klucze interfejsu API.
Żądania i odpowiedzi: omówienie struktury żądań i odpowiedzi interfejsu API, w tym wymaganych parametrów i oczekiwanych danych wyjściowych.
Limity szybkości: należy pamiętać o limitach szybkości nakładanych na użycie interfejsu API, aby uniknąć przekroczenia dozwolonej liczby żądań.

Obsługa operacji CRUD

CRUD oznacza tworzenie, odczytywanie, aktualizowanie i usuwanie, które są czterema podstawowymi operacjami, które można wykonać na danych. W usłudze Fabric Data Factory operacje CRUD są obsługiwane za pośrednictwem Fabric API dla Data Factory. Te interfejsy API umożliwiają użytkownikom programowe zarządzanie przepływami danych. Oto kilka kluczowych kwestii dotyczących obsługi operacji CRUD:

Tworzenie: tworzenie nowych przepływów danych przy użyciu interfejsu API. Obejmuje to definiowanie struktury przepływu danych, określanie źródeł danych, przekształceń i miejsc docelowych.
Przeczytaj: Pobieranie informacji o istniejących przepływach danych. Obejmuje to szczegółowe informacje o ich konfiguracji, stanie i historii wykonywania.
Aktualizacja: Zaktualizuj istniejące przepływy danych. Może to obejmować modyfikowanie struktury przepływu danych, zmienianie źródeł danych lub aktualizowanie logiki przekształcania.
Usuń: usuń przepływy danych, które nie są już potrzebne. Pomaga to w zarządzaniu zasobami i czyszczeniu ich.

Podstawowa dokumentacja referencyjna online dla interfejsów API REST usługi Microsoft Fabric znajduje się w dokumentacji interfejsu API REST usługi Microsoft Fabric.

Cykl życia przepływu danych

Podczas pracy z przepływami danych ważne jest zrozumienie cyklu życia przepływu danych w celu zapewnienia bezproblemowych i wydajnych procesów integracji danych. Kluczowe etapy cyklu życia przepływu danych obejmują

Definicja: Jest to etap początkowy, w którym tworzysz lub modyfikujesz definicję przepływu danych. Obejmuje to określenie źródeł danych, przekształceń i definicji.
Publikować: Po zmodyfikowaniu definicji przepływu danych należy wywołać operację Publikuj . Jest to kluczowy krok, ponieważ zapisuje zmiany wprowadzone w definicji przepływu danych i udostępnia je do wykonania.
Odświeżyć: Po opublikowaniu przepływu danych można wywołać operację Odświeżanie . Spowoduje to uruchomienie przepływu danych, ściąganie danych z określonych źródeł, stosowanie zdefiniowanych przekształceń i ładowanie danych do miejsca docelowego.

Rozpocznij pracę z publicznymi interfejsami API dla przepływów danych

W tej sekcji omówiono wszystkie następujące tematy:

Uzyskiwanie tokenu autoryzacji
Tworzenie przepływu danych
Tworzenie przepływu danych z definicją
Uzyskaj przepływ danych
Uzyskaj przepływ danych z definicją
Aktualizowanie przepływu danych
Aktualizowanie przepływu danych przy użyciu definicji
Usuwanie przepływu danych
Uruchamianie zadania przepływu danych na żądanie (odświeżanie)
Uruchom zadanie publikowania Dataflow na żądanie
Pobierz instancję zadania Dataflow
Anuluj wystąpienie zadania przepływu danych

Uzyskiwanie tokenu autoryzacji

Musisz mieć token elementu nośnego dla wszystkich wywołań interfejsu API REST i można go pobrać przy użyciu jednej z następujących opcji:

MSAL.Net
Portal Fabric

MSAL.Net

Szybki start z Fabric API — interfejsy API REST Microsoft Fabric

Użyj MSAL.Net, aby uzyskać token Microsoft Entra ID dla usługi Fabric z następującymi zakresami: Workspace.ReadWrite.All, Item.ReadWrite.All. Aby uzyskać więcej informacji na temat pozyskiwania tokenów za pomocą MSAL.Net, zobacz Token Acquisition — Microsoft Authentication Library for .NET (Pozyskiwanie tokenów — biblioteka uwierzytelniania firmy Microsoft dla platformy .NET).

Wklej skopiowany wcześniej identyfikator aplikacji (klienta) i wklej go jako zmienną ClientId.

Portal sieci tkaniny

Zaloguj się do portalu Fabric dla dzierżawy, na której chcesz przeprowadzić test, i naciśnij F12, aby przejść do trybu dewelopera przeglądarki. W konsoli tam uruchom:

powerBIAccessToken

Skopiuj token i wklej go dla zmiennej ClientId.

Tworzenie przepływu danych

Utwórz przepływ danych w określonym obszarze roboczym.

Przykładowe żądanie

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"
}

Przykładowa odpowiedź

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

Tworzenie przepływu danych z definicją

Utwórz przepływ danych z definicją base64 w określonym obszarze roboczym.

Przykładowy dokument mashupu

{
    "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
    }
}

Użyj Base64 Encode and Decode do kodowania swojego JSON-a.

Upewnij się, że pole Wykonaj bezpieczne kodowanie adresu URL nie jest zaznaczone.

Wklej odpowiedź ładunku żądania zakodowanego w Base64 do definicji tego ładunku

Przykładowe żądanie

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"  
            }  
        ]  
    }  
}

Przykładowa odpowiedź

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

Uzyskaj Dataflow

Zwraca właściwości określonego przepływu danych.

Przykładowe żądanie

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>"
}

Przykładowa odpowiedź

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

Uzyskaj przepływ danych z definicją

Zwraca definicję elementu przepływu danych.

Przykładowe żądanie

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>"
}

Przykładowa odpowiedź

{ 

    "definition": { 

        "parts": [ 

            { 

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

                "payload": " ewogICAgImVkaXRpbmdTZXNzaW9uTWFzaHVwIjogewogICAgICAgICJtYXNodXBOYW1lIjogIiIsCiAgICAgICAgIm1hc2h1cERvY3VtZW50IjogInNlY3Rpb24gU2VjdGlvbjE7XHJcbnNoYXJlZCBRdWVyeSA9IGxldFxuIFNvdXJjZSA9IFRhYmxlLkZyb21Sb3dzKFxuIHtcbiB7MSwgXCJCb2JcIiwgXCIxMjMtNDU2N1wifSxcbiB7MiwgXCJKaW1cIiwgXCI5ODctNjU0M1wifVxuIH0sXG4ge1wiQ3VzdG9tZXJJRFwiLCBcIk5hbWVcIiwgXCJQaG9uZVwifSlcbmluXG4gU291cmNlO1xyXG4iLAogICAgICAgICJxdWVyeUdyb3VwcyI6IFtdLAogICAgICAgICJkb2N1bWVudExvY2FsZSI6ICJlbi1VUyIsCiAgICAgICAgImdhdGV3YXlPYmplY3RJZCI6IG51bGwsCiAgICAgICAgInF1ZXJpZXNNZXRhZGF0YSI6IG51bGwsCiAgICAgICAgImNvbm5lY3Rpb25PdmVycmlkZXMiOiBbXSwKICAgICAgICAidHJ1c3RlZENvbm5lY3Rpb25zIjogbnVsbCwKICAgICAgICAidXNlSG9zdENvbm5lY3Rpb25Qcm92aWRlciI6IGZhbHNlLAogICAgICAgICJmYXN0Q29tYmluZSI6IGZhbHNlLAogICAgICAgICJhbGxvd05hdGl2ZVF1ZXJpZXMiOiB0cnVlLAogICAgICAgICJhbGxvd2VkTW9kdWxlcyI6IG51bGwsCiAgICAgICAgInNraXBBdXRvbWF0aWNUeXBlQW5kSGVhZGVyRGV0ZWN0aW9uIjogZmFsc2UsCiAgICAgICAgImRpc2FibGVBdXRvQW5vbnltb3VzQ29ubmVjdGlvblVwc2VydCI6IG51bGwsCiAgICAgICAgImhvc3RQcm9wZXJ0aWVzIjogewogICAgICAgICAgICAiRGF0YWZsb3dSZWZyZXNoT3V0cHV0RmlsZUZvcm1hdCI6ICJQYXJxdWV0IiwKICAgICAgICAgICAgIkVuYWJsZURhdGVUaW1lRmllbGRzRm9yU3RhZ2luZyI6ICJ0cnVlIiwKICAgICAgICAgICAgIkVuYWJsZVB1Ymxpc2hXaXRob3V0TG9hZGVkUXVlcmllcyI6ICJ0cnVlIgogICAgICAgIH0sCiAgICAgICAgImRlZmF1bHRPdXRwdXREZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb24iOiBudWxsLAogICAgICAgICJzdGFnaW5nRGVmaW5pdGlvbiI6IG51bGwKICAgIH0KfQ==" 

                "payloadType": "InlineBase64" 

            }, 

            { 

                "path": ".platform", 

                "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJEYXRhZmxvdyAzIgogIH0sCiAgImNvbmZpZyI6IHsKICAgICJ2ZXJzaW9uIjogIjIuMCIsCiAgICAibG9naWNhbElkIjogIjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCIKICB9Cn0=", 

                "payloadType": "InlineBase64" 

            } 

        ] 

    } 

}

ODPOWIEDŹ Z INTERFEJSU 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' 
            } 
        ] 
    } 
}

Aktualizowanie przepływu danych

Aktualizuje właściwości przepływu danych.

Przykładowe żądanie

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" 
}

Przykładowa odpowiedź

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

Aktualizowanie przepływu danych przy użyciu definicji

Aktualizuje definicję elementu przepływu danych.

Przykładowe żądanie

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"  
      } 
    ] 
  } 
}

Przykładowa odpowiedź

200 OK

Usuwanie przepływu danych

Usuwa określony przepływ danych.

Przykładowe żądanie

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>" 
}

Przykładowa odpowiedź

200 OK

Uruchamianie zadania przepływu danych na żądanie (odświeżanie)

Uruchamia zadanie przepływu danych na żądanie dla instancji aktualizacji.

Przykładowe żądanie

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>" 
    } 
}

Przykładowa odpowiedź

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 
  } 
]

Uruchom zadanie publikowania przepływu danych na żądanie

Uruchamia zadanie przepływu danych na żądanie dla instancji publikowania.

Przykładowe żądanie

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>" 
    }
}

Przykładowa odpowiedź

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 
  } 
]

Pobierz instancję zadania przepływu danych

Pobiera pojedyncze wystąpienie zadania przepływu danych.

Przykładowe żądanie

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>" 
}

Przykładowa odpowiedź

{ 
  "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 
}

Anuluj wystąpienie zadania przepływu danych

Anuluj instancję zadania przepływu danych

Przykładowe żądanie

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>"
}

Przykładowa odpowiedź

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

Retry-After: 60

Bieżące ograniczenia

Uwierzytelnianie jednostki usługi nie jest obecnie obsługiwane.
"Pobierz element" i "Szczegóły dostępu do elementu listy" nie zwraca prawidłowych informacji, jeśli filtrujesz typ elementu przepływu danych.
Jeśli nie określisz typu, zostanie zwrócony przepływ danych Gen2 (CI/CD, wersja preview) — nowy Dataflow Gen2 z obsługą CI/CD i GIT.
Interfejsy API uruchamiania można wywołać, ale rzeczywiste uruchomienie nigdy nie powiedzie się.

Udostępnij przez

Funkcje publicznych interfejsów API dla przepływów danych Gen2 w usłudze Fabric Data Factory

Przypadki użycia interfejsów API dla przepływów danych

Opis interfejsów API

Obsługa operacji CRUD

Cykl życia przepływu danych

Rozpocznij pracę z publicznymi interfejsami API dla przepływów danych

Uzyskiwanie tokenu autoryzacji

MSAL.Net

Portal sieci tkaniny

Tworzenie przepływu danych

Tworzenie przepływu danych z definicją

Uzyskaj Dataflow

Uzyskaj przepływ danych z definicją

Aktualizowanie przepływu danych

Aktualizowanie przepływu danych przy użyciu definicji

Usuwanie przepływu danych

Uruchamianie zadania przepływu danych na żądanie (odświeżanie)

Uruchom zadanie publikowania przepływu danych na żądanie

Pobierz instancję zadania przepływu danych

Anuluj wystąpienie zadania przepływu danych

Bieżące ograniczenia

Treści powiązane

Dokumentacja

Poradniki

Sprzężenie zwrotne

Dodatkowe źródła