Offentlige API'ers kapaciteter for Dataflow Gen2 i Fabric Data Factory

Fabric Data Factory tilbyder et sæt API'er, som du kan bruge til at automatisere og administrere dine dataflows effektivt. Disse API'er integreres med forskellige datakilder og tjenester, så du kan oprette, opdatere og overvåge dine dataarbejdsgange programmatisk. API'erne understøtter en bred vifte af operationer, herunder dataflows CRUD (Create, Read, Update, and Delete), planlægning og overvågning.

API-anvendelsestilfælde for dataflows

Brug API'erne til dataflows i Fabric Data Factory i forskellige scenarier:

Automatiseret implementering: Automatiser udrulning af dataflows på tværs af forskellige miljøer (udvikling, test, produktion) ved brug af CI/CD-praksisser.
Overvågning og alarmer: Opsæt automatiserede overvågnings- og varslingssystemer til at spore status på dataflows og modtage notifikationer i tilfælde af fejl eller ydelsesproblemer.
Dataintegration: Integrer data fra flere kilder, såsom databaser, datalakes og cloud-tjenester, i et samlet dataflow til behandling og analyse.
Fejlhåndtering: Implementer brugerdefinerede fejlhåndterings- og genforsøgsmekanismer for at sikre, at dataflows kører gnidningsfrit og kommer sig efter fejl.

Forstå API'er

For effektivt at bruge API'erne til dataflows i Fabric Data Factory, skal du forstå nøglebegreberne og komponenterne:

Slutpunkter: API-slutpunkterne giver adgang til forskellige dataflowhandlinger, f.eks. oprettelse, opdatering og sletning af dataflow.
Godkendelse: Sikker adgang til API'erne ved hjælp af godkendelsesmekanismer som OAuth eller API-nøgler.
Anmodninger og svar: Forstå strukturen af API-anmodninger og -svar, herunder de påkrævede parametre og det forventede output.
Satsgrænser: Vær opmærksom på de hastighedsgrænser, der er pålagt API-brug, for at undgå at overskride det tilladte antal anmodninger.

CRUD-understøttelse

CRUD står for Create, Read, Update og Delete – de fire grundlæggende operationer, du kan udføre på data. Fabric API for Data Factory understøtter CRUD-operationer, så du kan styre dine dataflows programmatisk. Nøglepunkter om støtte til CRUD:

Opret: Opret nye dataflow ved hjælp af API'en. Dette omfatter definition af dataflowstrukturen, angivelse af datakilder, transformationer og destinationer.
Læs: Hent oplysninger om eksisterende dataflow. Dette omfatter oplysninger om deres konfiguration, status og udførelseshistorik.
Opdatering: Opdater eksisterende dataflow. Dette kan omfatte ændring af dataflowstrukturen, ændring af datakilder eller opdatering af transformationslogik.
Slet: Slet dataflow, der ikke længere er nødvendige. Dette hjælper med at administrere og rydde op i ressourcer.

For den primære online referencedokumentation for Microsoft Fabric REST API'er, se Microsoft Fabric REST API-dokumentationen.

Dataflow-livscyklus

Når du arbejder med dataflow, er det vigtigt at forstå livscyklussen for et dataflow for at sikre glatte og effektive dataintegrationsprocesser. De vigtigste faser i dataflowets livscyklus omfatter:

Definition: Dette trin er, hvor du opretter eller ændrer definitionen af et dataflow. Denne proces indebærer at specificere datakilder, transformationer og destinationer.
Udgive: Når du har ændret definitionen af et dataflow, skal du aktivere publiceringshandlingen . Dette er et afgørende trin, da de ændringer, der er foretaget i dataflowets definition, gemmes og gøres tilgængelige til udførelse.
Opdater: Efter dataflowet er offentliggjort, kan du aktivere Refresh-operationen . Denne operation udløser dataflowet til at køre, hvor data hentes fra de angivne kilder, de definerede transformationer anvendes og indlæses dataene i destinationen.

Forudsætninger

For at bruge Dataflow Gen2 offentlige API'er skal du:

Et Microsoft Fabric-arbejdsområde med mindst en bidragyderrolle.
Et Microsoft Entra ID-token med scopes Workspace.ReadWrite.All og Item.ReadWrite.All. Se Få en autorisationstoken for detaljer.
Arbejdsområdets ID, hvor du vil oprette eller administrere dataflows.

Kom i gang med offentlige API'er til dataflows

Følgende tabel opsummerer alle tilgængelige Dataflow Gen2 API-operationer:

Operation	HTTP-metode	Slutpunkt
Oprette et dataflow	INDLÆG	`/v1/workspaces/{workspaceId}/items`
Opret et dataflow med definition	INDLÆG	`/v1/workspaces/{workspaceId}/items` (med `definition` i nyttelast)
Få dataflow	FÅ	`/v1/workspaces/{workspaceId}/items/{itemId}`
Få dataflow med definition	INDLÆG	`/v1/workspaces/{workspaceId}/items/{itemId}/getDefinition`
Opdater dataflow	PATCH	`/v1/workspaces/{workspaceId}/items/{itemId}`
Opdater dataflow med definition	INDLÆG	`/v1/workspaces/{workspaceId}/items/{itemId}/updateDefinition`
Slet dataflow	SLET	`/v1/workspaces/{workspaceId}/items/{itemId}`
Kør on-demand opdatering	INDLÆG	`/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances?jobType=Refresh`
Kør on-demand udgivelse	INDLÆG	`/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances?jobType=Publish`
Få jobinstans	FÅ	`/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances/{jobInstanceId}`
Annuller jobinstans	INDLÆG	`/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances/{jobInstanceId}/cancel`

Dette afsnit dækker følgende emner:

Hent et godkendelsestoken
Opret et dataflow
Opret et dataflow med definition
Få dataflow
Få dataflow med definition
Opdater dataflow
Opdater dataflow med definition
Slet dataflow
Kør on-demand dataflow-job (opdatering)
Kør on-demand dataflow publiceringsjob
Få dataflow-jobinstans
Annuller dataflow-jobinstans

Hent et godkendelsestoken

Du skal bruge en bærertoken til alle REST API-kald. Få det ved at bruge en af disse muligheder:

MSAL.NET
Stofportal

MSAL.NET

Hurtig start til Fabric API – Microsoft Fabric REST API'er

Brug MSAL.NET til at erhverve et Microsoft Entra ID-token til Fabric-tjenesten med følgende scopes: Workspace.ReadWrite.All, Item.ReadWrite.All. For mere information om tokenanskaffelse med MSAL.NET, se Token Acquisition - Microsoft Authentication Library for .NET.

Indsæt applikations-ID'et, som du kopierede tidligere, ind i ClientId-variablen .

Fabric-portal

Log ind på Fabric-portalen for den lejer, du vil teste, og vælg F12 for at åbne browserens udviklerværktøjer. I konsollen, kør:

powerBIAccessToken

Kopier tokenet og indsæt det i ClientId-variablen .

Oprette et dataflow

Opret et dataflow i et angivet arbejdsområde. Send en POST-anmodning til items-endpointet med , displayNamedescription, og type sæt til Dataflow. Svaret inkluderer det oprettede element med dets id.

Eksempel på anmodning

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

Eksempel på svar

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

Opret et dataflow med definition

Opret et dataflow med en Base64-definition i et specificeret arbejdsområde. Send en POST-anmodning til items-endpointet med et indbygget Base64-kodet mashup-dokument i arrayet definition.parts .

Eksempel på mashup-dokument

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

Brug Base64 Encode og Decode til at kode din JSON.

Kontrollér, at afkrydsningsfeltet Udfør sikker kodning af URL-adressen ikke er markeret.

Indsæt svaret på din kodede Nyttedata for Base64-anmodning i nyttedatadefinitionen

Eksempel på anmodning

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

Eksempel på svar

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

Få dataflow

Returnerer egenskaberne for en specificeret dataflow. Send en GET-anmodning med og itemId sti-parametreneworkspaceId.

Eksempel på anmodning

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

Eksempel på svar

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

Få dataflow med definition

Returnerer definitionen af dataflowelementet. Send en POST-anmodning til endepunktet getDefinition . Svaret indeholder Base64-kodede dele, herunder mashup-dokumentet og platformmetadata.

Eksempel på anmodning

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

Eksempel på svar

{

    "definition": {

        "parts": [

            {

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

                "payload": " ewogICAgImVkaXRpbmdTZXNzaW9uTWFzaHVwIjogewogICAgICAgICJtYXNodXBOYW1lIjogIiIsCiAgICAgICAgIm1hc2h1cERvY3VtZW50IjogInNlY3Rpb24gU2VjdGlvbjE7XHJcbnNoYXJlZCBRdWVyeSA9IGxldFxuIFNvdXJjZSA9IFRhYmxlLkZyb21Sb3dzKFxuIHtcbiB7MSwgXCJCb2JcIiwgXCIxMjMtNDU2N1wifSxcbiB7MiwgXCJKaW1cIiwgXCI5ODctNjU0M1wifVxuIH0sXG4ge1wiQ3VzdG9tZXJJRFwiLCBcIk5hbWVcIiwgXCJQaG9uZVwifSlcbmluXG4gU291cmNlO1xyXG4iLAogICAgICAgICJxdWVyeUdyb3VwcyI6IFtdLAogICAgICAgICJkb2N1bWVudExvY2FsZSI6ICJlbi1VUyIsCiAgICAgICAgImdhdGV3YXlPYmplY3RJZCI6IG51bGwsCiAgICAgICAgInF1ZXJpZXNNZXRhZGF0YSI6IG51bGwsCiAgICAgICAgImNvbm5lY3Rpb25PdmVycmlkZXMiOiBbXSwKICAgICAgICAidHJ1c3RlZENvbm5lY3Rpb25zIjogbnVsbCwKICAgICAgICAidXNlSG9zdENvbm5lY3Rpb25Qcm92aWRlciI6IGZhbHNlLAogICAgICAgICJmYXN0Q29tYmluZSI6IGZhbHNlLAogICAgICAgICJhbGxvd05hdGl2ZVF1ZXJpZXMiOiB0cnVlLAogICAgICAgICJhbGxvd2VkTW9kdWxlcyI6IG51bGwsCiAgICAgICAgInNraXBBdXRvbWF0aWNUeXBlQW5kSGVhZGVyRGV0ZWN0aW9uIjogZmFsc2UsCiAgICAgICAgImRpc2FibGVBdXRvQW5vbnltb3VzQ29ubmVjdGlvblVwc2VydCI6IG51bGwsCiAgICAgICAgImhvc3RQcm9wZXJ0aWVzIjogewogICAgICAgICAgICAiRGF0YWZsb3dSZWZyZXNoT3V0cHV0RmlsZUZvcm1hdCI6ICJQYXJxdWV0IiwKICAgICAgICAgICAgIkVuYWJsZURhdGVUaW1lRmllbGRzRm9yU3RhZ2luZyI6ICJ0cnVlIiwKICAgICAgICAgICAgIkVuYWJsZVB1Ymxpc2hXaXRob3V0TG9hZGVkUXVlcmllcyI6ICJ0cnVlIgogICAgICAgIH0sCiAgICAgICAgImRlZmF1bHRPdXRwdXREZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb24iOiBudWxsLAogICAgICAgICJzdGFnaW5nRGVmaW5pdGlvbiI6IG51bGwKICAgIH0KfQ=="

                "payloadType": "InlineBase64"

            },

            {

                "path": ".platform",

                "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJEYXRhZmxvdyAzIgogIH0sCiAgImNvbmZpZyI6IHsKICAgICJ2ZXJzaW9uIjogIjIuMCIsCiAgICAibG9naWNhbElkIjogIjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCIKICB9Cn0=",

                "payloadType": "InlineBase64"

            }

        ]

    }

}

Eksempelsvar (forenklet format)

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

Opdater dataflow

Opdaterer egenskaberne for et specificeret dataflow. Send en PATCH-anmodning med og itemId sti-parametreneworkspaceId. Inkluder den opdaterede displayName eller description i anmodningsteksten.

Eksempel på anmodning

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

Eksempel på svar

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

Opdater dataflow med definition

Opdaterer definitionen af dataflowelementet. Send en POST-anmodning til endepunktet updateDefinition med Base64-kodede definitionsdele i anmodningskroppen.

Eksempel på anmodning

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

Eksempel på svar

200 OK

Slet dataflow

Sletter det angivne dataflow. Send en DELETE-anmodning med workspaceId og itemId sti-parametrene. Afkast 200 OK ved succes.

Eksempel på anmodning

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

Eksempel på svar

200 OK

Kør on-demand dataflow-job (opdatering)

Udløser en on-demand opdatering for det specificerede dataflow. Send en POST-anmodning med jobType=Refresh som forespørgselsparameter. Inkluder DataflowName, OwnerUserPrincipalName, og OwnerUserObjectId i nyttelasten executionData . Returnerer 202 Accepted med en jobInstanceId til sporing.

Eksempel på anmodning

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

Eksempel på svar

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

Kør on-demand dataflow publiceringsjob

Udløser en on-demand publicering for den specificerede dataflow. Send en POST-anmodning med jobType=Publish som forespørgselsparameter. Returnerer 202 Accepted med en jobInstanceId til sporing.

Eksempel på anmodning

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

Eksempel på svar

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

Få dataflow-jobinstans

Henter status for en specifik jobinstans. Send en GET-anmodning med , itemId, og jobInstanceId stiparametreneworkspaceId. Returnerer jobstatus, starttidspunkt og fejlårsag (hvis relevant).

Eksempel på anmodning

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

Eksempel på svar

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

Annuller dataflow-jobinstans

Annullerer en kørende jobinstans. Send en POST-forespørgsel til endepunktet cancel med , itemId, og jobInstanceId stiparametreneworkspaceId. Returneres, 202 Accepted når annulleringen igangsættes.

Eksempel på anmodning

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

Eksempel på svar

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

Retry-After: 60

Aktuelle begrænsninger

Service principal-autentificering understøttes ikke.
"Find Item" og "List Item Access Details" returnerer ikke de korrekte oplysninger, hvis du filtrerer på dataflow-elementtype.
Når du ikke specificerer typen, returnerer API'en Dataflow Gen2 (CI/CD, preview)—den nye Dataflow Gen2 med CI/CD og Git-understøttelse.
Du kan aktivere Run API'er, men selve kørslen lykkes aldrig.

Feedback

Var denne side nyttig?

Last updated on 2026-06-25

Offentlige API'ers kapaciteter for Dataflow Gen2 i Fabric Data Factory

API-anvendelsestilfælde for dataflows

Forstå API'er

CRUD-understøttelse

Dataflow-livscyklus

Forudsætninger

Kom i gang med offentlige API'er til dataflows

Hent et godkendelsestoken

MSAL.NET

Fabric-portal

Oprette et dataflow

Opret et dataflow med definition

Få dataflow

Få dataflow med definition

Opdater dataflow

Opdater dataflow med definition

Slet dataflow

Kør on-demand dataflow-job (opdatering)

Kør on-demand dataflow publiceringsjob

Få dataflow-jobinstans

Annuller dataflow-jobinstans

Aktuelle begrænsninger

Relateret indhold

Feedback

Yderligere ressourcer