Microsoft Fabric-adatfolyam nyilvános REST API (előzetes verzió)

Cikk
04/02/2024

Fontos

A Data Factory-hez készült Microsoft Fabric API létrehozási/olvasási/frissítési/törlési (CRUD) verziója jelenleg előzetes verzióban érhető el. Ezek az információk egy előzetes termékre vonatkoznak, amely a kiadás előtt jelentősen módosítható. A Microsoft nem vállal kifejezett vagy hallgatólagos szavatosságot az itt megadott információkra vonatkozóan.

A Microsoft Fabricben a Data Factory API-k kizárólag folyamatokhoz és adatfolyamokhoz tartozó CRUD-műveletekből állnak. Jelenleg csak az adatfolyamok támogatottak. Az adatfolyamok API-k később jelennek meg. Az adatintegrációs projektek egyéb gyakori területei külön API-kban találhatók: ütemezések, monitorozás, kapcsolatok, saját API-k a Fabricben. A Microsoft Fabric REST API-k elsődleges online referenciadokumentációja a Microsoft Fabric REST API-referenciákban található. Tekintse meg a Core items API-t és a Feladatütemezőt is.

Engedélyezési jogkivonat beszerzése

1. lehetőség: A MSAL.Net használata

A Fabric API rövid útmutatója – Microsoft Fabric REST API-k

A MSAL.Net használatával microsoft Entra-azonosító jogkivonatot szerezhet be a Fabric szolgáltatáshoz a következő hatókörökkel: Workspace.ReadWrite.All, Item.ReadWrite.All. A jogkivonatok MSAL.Net történő beszerzésével kapcsolatos további információkért lásd : Token Acquisition – Microsoft Authentication Library for .NET.

Illessze be a korábban másolt alkalmazás-(ügyfél-) azonosítót, és illessze be a ClientId változóhoz.

2. lehetőség: A Háló portál használata

Jelentkezzen be a tesztelni kívánt bérlő hálóportáljára, és nyomja le az F12 billentyűt a böngésző fejlesztői módjának megadásához. A konzolon futtassa a következőt:

powerBIAccessToken

Másolja ki a jogkivonatot, és illessze be a ClientId változóhoz.

Elemdefiníció hasznos adatbázis64 kódolással

A JSON kódolásához használja a Base64 Kódolás és dekódolás parancsot.
Győződjön meg arról, hogy az URL-cím biztonságos kódolásának végrehajtása jelölőnégyzet nincs bejelölve.
A folyamatdefiníciókat a Fabric felhasználói felületén található Nézet –-JSON-kód> lapról szerezheti be.

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

Vegye át a tulajdonságok objektumát, és vegye körül őket kapcsos zárójelben – { } – így a REST-elem definíciójának hasznos adata a következő:

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

Elem létrehozása

REST API – Elemek – Elem létrehozása

Példa:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items

Törzs:

{ 
  "displayName": "pipeline_1", 
  "type": "DataPipeline" 
}

Feljegyzés

A dokumentáció azt állítja, hogy csak 2 szükséges tulajdonság létezik – displayName és type. A Workload-DI jelenleg nem támogatja a definíció nélküli létrehozást is. Ennek a hibás követelménynek a javítása jelenleg üzembe van helyezve. Egyelőre ugyanazt az alapértelmezett definíciót küldheti el, amelyet a Háló felhasználói felülete használ: ‘{"properties":{"activities":[]}}’

Módosított JSON, beleértve a definíciót:

{ 
  "displayName": "pipeline_1", 
  "type": "DataPipeline", 
  "definition": { 
    "parts": [ 
      { 
        "path": "pipeline-content.json", 
        "payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=", 
        "payloadType": "InlineBase64" 
      } 
    ] 
  } 
}

Válasz 201:

{ 
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
    "type": "DataPipeline", 
    "displayName": "Pipeline_1", 
    "description": "", 
    "workspaceId": "<Your WS Id>" 
}

Elem törlése

REST API – Elemek – Elem törlése

Példa:

DELETE https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>

200. válasz: (Nincs törzs)

Elem lekérése

REST API – Elemek – Elem lekérése

Példa:

GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>

Válasz 200:

{ 
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
    "type": "DataPipeline", 
    "displayName": "Pipeline_1", 
    "workspaceId": "<your WS Id>" 
}

Elemdefiníció lekérése

REST API – Elemek – Elemdefiníció lekérése

Példa:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/getDefinition

Válasz 200:

{ 
    "definition": { 
        "parts":[ 
            { 
                "path": "pipeline-content.json", 
                "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==", 
                "payloadType": "InlineBase64" 
            } 
        ] 
    } 
}

Listaelemek

REST API – Elemek – Elemek listázása

Példa:

GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items

Válasz 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" 
        } 
    ] 
}

Elem frissítése

REST API – Elemek – Elem frissítése

Példa:

PATCH https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>

Törzs:

{ 
  "displayName": "Pipeline_1_updated", 
  "description": "This is the description." 
}

Válasz 200:

{ 
    "id": "<pipeline id>", 
    "type": "DataPipeline", 
    "displayName": "Pipeline_1_updated", 
    "description": "This is the description.", 
    "workspaceId": "<Your WS id>" 
}

Elemdefiníció frissítése

REST API – Elemek – Elemdefiníció frissítése

Példa:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/updateDefinition

Törzs:

{ 
  "definition": { 
    "parts": [ 
      { 
        "path": "pipeline-content.json", 
        "payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=", 
        "payloadType": "InlineBase64" 
      } 
    ] 
  } 
}

200. válasz: (Nincs törzs)

Igény szerinti elemfeladat futtatása

REST API – Elemek – Igény szerinti elemfeladat futtatása

Példa:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline

202. válasz: (Nincs törzs)

Példa két paraméterértékkel:

Itt van egy várakozási tevékenység egy param_waitsec nevű paraméterrel a várakozási másodpercek számának megadásához.

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline

Törzs:

{ 
  "executionData": { 
    "parameters": {
      "param_waitsec": 10" 
    } 
  } 
}

202. válasz: (Nincs törzs)

Feljegyzés

Jelenleg nincs visszaadott törzs, de a feladatazonosítót vissza kell adni. Az előzetes verzióban a visszaadott fejlécekben, a "Hely" tulajdonságban található.

Elemfeladat-példány lekérése

REST API – Elemek – Elemfeladat-példány lekérése

Példa:

GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>dotnetcli

Válasz 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" 
}

Elemfeladat-példány megszakítása

REST API – Elemek – Elemfeladat-példány megszakítása

Példa:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>/cancel

202. válasz: (Nincs törzs)

Feljegyzés

A feladat megszakítása után ellenőrizheti az állapotot az Elem lekérése feladatpéldány meghívásával, vagy a Futtatási előzmények megtekintése a Háló felhasználói felületén.

Ismert korlátozások

A szolgáltatásnév hitelesítése (SPN) jelenleg nem támogatott

Megosztás a következőn keresztül:

Microsoft Fabric-adatfolyam nyilvános REST API (előzetes verzió)

Engedélyezési jogkivonat beszerzése

1. lehetőség: A MSAL.Net használata

2. lehetőség: A Háló portál használata

Elemdefiníció hasznos adatbázis64 kódolással

Elem létrehozása

Elem törlése

Elem lekérése

Elemdefiníció lekérése

Listaelemek

Elem frissítése

Elemdefiníció frissítése

Igény szerinti elemfeladat futtatása

Elemfeladat-példány lekérése

Elemfeladat-példány megszakítása

Ismert korlátozások

Következő lépések

Visszajelzés

Visszajelzés

További források