Offentlig REST-API for Microsoft Fabric-datasamlebånd (forhåndsversjon)
Viktig
Microsoft Fabric API for Data Factory er for øyeblikket i offentlig forhåndsversjon. Denne informasjonen er knyttet til et forhåndsutgitt produkt som kan endres vesentlig før den utgis. Microsoft gir ingen garantier, uttrykt eller underforstått, med hensyn til informasjonen som er oppgitt her.
I Microsoft Fabric består datafabrikk-API-er utelukkende av CRUD-operasjoner for datasamlebånd og dataflyter. Foreløpig støttes bare datasamlebånd. API-er for dataflyter er ennå ikke tilgjengelige. Andre fellesområder for dataintegreringsprosjekter er i separate API-er: tidsplaner, overvåking, tilkoblinger, har sine egne API-er i Fabric. Du finner den primære referansedokumentasjonen for Microsoft Fabric REST-API-er i Microsoft Fabric REST-API-referanser. Se også API-en for kjerneelementer og jobbplanlegging.
Elementdefinisjon med nyttelast base64 kodet
- Bruk Base64-kode og Dekode til å kode JSON.
- Kontroller at det ikke er merket av for Utfør url-klarert koding .
- Du kan få datasamlebånddefinisjonene via vis --Vis JSON-kodefanen>.
{
"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"
}
}
Ta egenskapsobjektet og omgi dem i klammeparenteser - { } - slik at REST Item definition payload ville være:
{
"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"
}
}
Opprett element
REST-API – Elementer – Opprett element
Eksempel – CreateDataPipeline:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items
Brødtekst:
{
"displayName": "pipeline_1",
"type": "DataPipeline"
}
Merk
I dokumentasjonen står det at det bare er to nødvendige egenskaper – displayName og type. For øyeblikket støtter ikke Workload-DI oppretting uten en definisjon også. Løsningen for dette feilaktige kravet distribueres for øyeblikket. Foreløpig kan du sende den samme standarddefinisjonen som brukes av Fabric-brukergrensesnittet: ‘{"properties":{"activities":[]}}’
Endret JSON inkludert definisjon:
{
"displayName": "pipeline_1",
"type": "DataPipeline",
"definition": {
"parts": [
{
"path": "pipeline-content.json",
"payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=",
"payloadType": "InlineBase64"
}
]
}
}
Svar 201:
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "DataPipeline",
"displayName": "Pipeline_1",
"description": "",
"workspaceId": "<Your WS Id>"
}
Slett element
REST-API – Elementer – Slett element
Eksempel:
DELETE https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>
Svar 200: (Ingen brødtekst)
Hent element
REST-API – Elementer – Hent element
Eksempel:
GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>
Svar 200:
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "DataPipeline",
"displayName": "Pipeline_1",
"workspaceId": "<your WS Id>"
}
Hent elementdefinisjon
REST-API – Elementer – Hent elementdefinisjon
Eksempel:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/getDefinition
Svar 200:
{
"definition": {
"parts":[
{
"path": "pipeline-content.json",
"payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==",
"payloadType": "InlineBase64"
}
]
}
}
Listeelementer
REST-API – Elementer – listeelementer
Eksempel:
GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items
Svar 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"
}
]
}
Oppdater element
REST-API – Elementer – Oppdater element
Eksempel:
PATCH https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>
Brødtekst:
{
"displayName": "Pipeline_1_updated",
"description": "This is the description."
}
Svar 200:
{
"id": "<pipeline id>",
"type": "DataPipeline",
"displayName": "Pipeline_1_updated",
"description": "This is the description.",
"workspaceId": "<Your WS id>"
}
Oppdater elementdefinisjon
REST-API – Elementer – Oppdater elementdefinisjon
Eksempel:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/updateDefinition
Brødtekst:
{
"definition": {
"parts": [
{
"path": "pipeline-content.json",
"payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=",
"payloadType": "InlineBase64"
}
]
}
}
Svar 200: (Ingen brødtekst)
Kjør behovsbetinget elementjobb
REST-API – Elementer – Kjør behovsbetinget elementjobb
Eksempel:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline
Svar 202: (Ingen brødtekst)
Eksempel med to parameterverdier:
Her har vi en venteaktivitet med en parameter med navnet param_waitsec for å angi antall sekunder å vente.
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline
Brødtekst:
{
"executionData": {
"parameters": {
"param_waitsec": "10"
}
}
}
Svar 202: (Ingen brødtekst)
Merk
Det er ingen kropp som returneres for øyeblikket, men jobb-ID-en skal returneres. Under forhåndsvisningen finner du den i de returnerte topptekstene, i Location-egenskapen.
Hent forekomst av elementjobb
REST-API – Elementer – Hent forekomst av elementjobb
Eksempel:
GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>
Svar 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"
}
Avbryt elementjobbforekomst
REST-API – Elementer – Avbryt forekomst av elementjobb
Eksempel:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>/cancel
Svar 202: (Ingen brødtekst)
Merk
Når du har avbrutt en jobb, kan du kontrollere statusen enten ved å ringe Få elementjobbforekomst eller se på Vis kjørelogg i Fabric-brukergrensesnittet.
Spørringsaktivitet kjører
Eksempel:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/datapipelines/pipelineruns/<Job ID>/queryactivityruns
Brødtekst:
{
"filters":[],
"orderBy":[{"orderBy":"ActivityRunStart","order":"DESC"}],
"lastUpdatedAfter":"2024-05-22T14:02:04.1423888Z",
"lastUpdatedBefore":"2024-05-24T13:21:27.738Z"
}
Merk
"jobb-ID" er den samme IDen som er opprettet og brukt i de offentlige API-ene for jobbplanlegging
Svar 200:
[
{
"pipelineName": "ca91f97e-5bdd-4fe1-b39a-1f134f26a701",
"pipelineRunId": "bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f",
"activityName": "Wait1",
"activityType": "Wait",
"activityRunId": "cccc2c2c-dd3d-ee4e-ff5f-aaaaaa6a6a6a",
"linkedServiceName": "",
"status": "Succeeded",
"activityRunStart": "2024-05-23T13:43:03.6397566Z",
"activityRunEnd": "2024-05-23T13:43:31.3906179Z",
"durationInMs": 27750,
"input": {
"waitTimeInSeconds": 27
},
"output": {},
"error": {
"errorCode": "",
"message": "",
"failureType": "",
"target": "Wait1",
"details": ""
},
"retryAttempt": null,
"iterationHash": "",
"userProperties": {},
"recoveryStatus": "None",
"integrationRuntimeNames": null,
"executionDetails": null,
"id": "/SUBSCRIPTIONS/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/RESOURCEGROUPS/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/PROVIDERS/MICROSOFT.TRIDENT/WORKSPACES/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/pipelineruns/bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f/activityruns/cccc2c2c-dd3d-ee4e-ff5f-aaaaaa6a6a6a"
}
]
Kjente begrensninger
- Tjenestekontohaver-godkjenning (SPN) støttes for øyeblikket ikke.