Veřejné rozhraní REST API datového kanálu Microsoft Fabric (Preview)
Důležité
Rozhraní API Microsoft Fabric pro vytvoření, čtení, aktualizaci nebo odstranění (CRUD) služby Data Factory je aktuálně ve verzi Preview. Tyto informace se týkají předběžné verze produktu, který může být podstatně změněn před vydáním. Společnost Microsoft neposkytuje žádné záruky, vyjádřené ani předpokládané, pokud jde o informace uvedené zde.
V Microsoft Fabric se rozhraní API služby Data Factory skládají výhradně z operací CRUD pro kanály a toky dat. V současné době se podporují jenom datové kanály. Rozhraní API toků dat budou vydána později. Další běžné oblasti pro projekty integrace dat jsou v samostatných rozhraních API: plány, monitorování, připojení a vlastní rozhraní API v prostředcích infrastruktury. Primární online referenční dokumentace k rozhraním REST API Microsoft Fabric najdete v referenčních materiálech k rozhraní REST API Microsoft Fabric. Projděte si také rozhraní API základních položek a plánovač úloh.
Získání autorizačního tokenu
Možnost 1: Použití MSAL.Net
Rychlý start k rozhraní FABRIC API – Rozhraní REST API Microsoft Fabric
Pomocí MSAL.Net získejte token ID Microsoft Entra pro službu Fabric s následujícími obory: Workspace.ReadWrite.All, Item.ReadWrite.All. Další informace o získávání tokenů pomocí MSAL.Net naleznete v tématu Získání tokenu – Microsoft Authentication Library pro .NET.
Vložte ID aplikace (klienta), které jste zkopírovali dříve, a vložte ho pro proměnnou ClientId.
Možnost 2: Použití portálu Fabric
Přihlaste se k portálu Fabric pro tenanta, kterého chcete otestovat, a stisknutím klávesy F12 přejděte do vývojářského režimu prohlížeče. V konzole spusťte:
powerBIAccessToken
Zkopírujte token a vložte ho pro proměnnou ClientId.
Definice položky s kódováním base64 datové části
- K kódování JSON použijte kódování a dekódování Base64.
- Ujistěte se, že není zaškrtnuté políčko Provést bezpečné kódování adresy URL.
- Definice kanálu můžete získat prostřednictvím karty Zobrazit -->View JSON v uživatelském rozhraní Fabric.
{
"name": "Pipeline_1_updated",
"objectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"properties": {
"description": "this is the description",
"activities": [
{
"name": "Wait1",
"type": "Wait",
"dependsOn": [],
"typeProperties": {
"waitTimeInSeconds": 240
}
}
],
"annotations": [],
"lastModifiedByObjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"lastPublishTime": "2024-02-01T17:28:02Z"
}
}
Vezměte objekt vlastností a obklopte je do složených závorek – { } – proto by datová část definice položky REST byla:
{
"properties": {
"description": "this is the description",
"activities": [
{
"name": "Wait1",
"type": "Wait",
"dependsOn": [],
"typeProperties": {
"waitTimeInSeconds": 240
}
}
],
"annotations": [],
"lastModifiedByObjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"lastPublishTime": "2024-02-01T17:28:02Z"
}
}
Vytvořit položku
REST API – Položky – Vytvoření položky
Příklad:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items
Text:
{
"displayName": "pipeline_1",
"type": "DataPipeline"
}
Poznámka:
Dokumentace uvádí, že existují pouze 2 požadované vlastnosti – displayName a typ. V současné době úloha-DI nepodporuje vytváření bez definice . Oprava tohoto chybného požadavku se právě nasazuje. Prozatím můžete odeslat stejnou výchozí definici, kterou používá uživatelské rozhraní Fabric: ‘{"properties":{"activities":[]}}’
Upravený JSON včetně definice:
{
"displayName": "pipeline_1",
"type": "DataPipeline",
"definition": {
"parts": [
{
"path": "pipeline-content.json",
"payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=",
"payloadType": "InlineBase64"
}
]
}
}
Odpověď 201:
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "DataPipeline",
"displayName": "Pipeline_1",
"description": "",
"workspaceId": "<Your WS Id>"
}
Odstranit položku
REST API – Položky – Odstranění položky
Příklad:
DELETE https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>
Odpověď 200: (Bez textu)
Získat položku
REST API – Položky – Získání položky
Příklad:
GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>
Odpověď 200:
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "DataPipeline",
"displayName": "Pipeline_1",
"workspaceId": "<your WS Id>"
}
Získání definice položky
REST API – Položky – Získání definice položky
Příklad:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/getDefinition
Odpověď 200:
{
"definition": {
"parts":[
{
"path": "pipeline-content.json",
"payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==",
"payloadType": "InlineBase64"
}
]
}
}
Položky seznamu
REST API – Položky – Položky seznamu
Příklad:
GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items
Odpověď 200:
{
"value": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "SemanticModel",
"displayName": "deata_lh",
"description": "",
"workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "SQLEndpoint",
"displayName": "deata_lh",
"description": "",
"workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "Lakehouse",
"displayName": "deata_lh",
"description": "",
"workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "DataPipeline",
"displayName": "Pipeline_1",
"description": "",
"workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
]
}
Aktualizovat položku
REST API – Položky – Aktualizace položky
Příklad:
PATCH https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>
Text:
{
"displayName": "Pipeline_1_updated",
"description": "This is the description."
}
Odpověď 200:
{
"id": "<pipeline id>",
"type": "DataPipeline",
"displayName": "Pipeline_1_updated",
"description": "This is the description.",
"workspaceId": "<Your WS id>"
}
Aktualizace definice položky
REST API – Položky – Aktualizace definice položky
Příklad:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/updateDefinition
Text:
{
"definition": {
"parts": [
{
"path": "pipeline-content.json",
"payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=",
"payloadType": "InlineBase64"
}
]
}
}
Odpověď 200: (Bez textu)
Spuštění úlohy položky na vyžádání
REST API – Položky – Spuštění úlohy položek na vyžádání
Příklad:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline
Odpověď 202: (Bez textu)
Příklad se dvěma hodnotami parametrů:
Tady máme aktivitu Wait s parametrem s názvem param_waitsec , který určuje počet sekund čekání.
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline
Text:
{
"executionData": {
"parameters": {
"param_waitsec": 10"
}
}
}
Odpověď 202: (Bez textu)
Poznámka:
V současné době není vráceno žádné tělo, ale mělo by se vrátit ID úlohy. Během náhledu ji najdete ve vrácené hlavičce ve vlastnosti Umístění.
Získání instance úlohy položky
REST API – Položky – Získání instance úlohy položky
Příklad:
GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>dotnetcli
Odpověď 200:
{
"id": "4511ffcd-a9f6-4f75-91a9-9ceab08d7539",
"itemId": "2bb9fe4a-0a84-4725-a01f-7ac4e6850259",
"jobType": "Pipeline",
"invokeType": "Manual",
"status": "Completed",
"failureReason": null,
"rootActivityId": "f14bdd95-2cff-4451-b839-bea81509126d",
"startTimeUtc": "2024-02-01T03:03:19.8361605",
"endTimeUtc": "2024-02-01T03:05:00.3433333"
}
Zrušení instance úlohy položky
REST API – Položky – Zrušení instance úlohy položky
Příklad:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>/cancel
Odpověď 202: (Bez textu)
Poznámka:
Po zrušení úlohy můžete stav zkontrolovat voláním instance úlohy Získat položku nebo zobrazením historie spuštění v uživatelském rozhraní Fabric.
Známá omezení
- Ověřování instančního objektu (SPN) se aktuálně nepodporuje.
Související obsah
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro