Microsoft Fabric -tietoputken julkinen REST-ohjelmointirajapinta (esikatselu)
Tärkeä
Microsoft Fabric -ohjelmointirajapinta Data Factorylle on tällä hetkellä julkisessa esikatselussa. Nämä tiedot liittyvät esijulkaisutuotteeseen, jota voidaan muuttaa huomattavasti ennen sen julkaisua. Microsoft ei myönnä tässä esitettyihin tietoihin liittyen mitään ilmaistuja tai epäsuoria takuita.
Microsoft Fabricissa Data Factory -ohjelmointirajapinnat koostuvat pelkästään putkien ja tietovoiden CRUD-toiminnoista. Tällä hetkellä tuetaan vain tietoputkia. Tietovoiden ohjelmointirajapinnat julkaistaan myöhemmin. Muita yleisiä tietojen integrointiprojektien osa-alueita ovat erilliset ohjelmointirajapinnat: aikataulut, valvonta, yhteydet, omat ohjelmointirajapinnat Fabricissa. Microsoft Fabric REST -ohjelmointirajapintojen ensisijaiset online-viitetiedot löytyvät Microsoft Fabricin REST-ohjelmointirajapintaviittauksista. Viittaa myös ydinkohteiden ohjelmointirajapintaan ja työn ajoitustoimintoon.
Kasvavat julkiset ohjelmointirajapinnat
Kasvava julkinen ohjelmointirajapinta on nyt käytettävissä. Näiden ohjelmointirajapintojen avulla voit integroida saumattomasti eri julkisia tietolähteitä ja käyttää niitä tietoputkissasi.
Valtuutustunnuksen hankkiminen
Vaihtoehto 1: MSAL.Net käyttäminen
Fabric-ohjelmointirajapinnan pika-aloitus – Microsoft Fabric REST -ohjelmointirajapinnat
hanki MSAL.Net avulla Microsoft Entra ID -tunnus Fabric-palvelulle käyttämällä seuraavia vaikutusalueita: Workspace.ReadWrite.All, Item.ReadWrite.All. Lisätietoja tunnuksen hankkimisesta MSAL.Net kohteeseen on kohdassa Tunnuksen hankinta – Microsoftin todentamiskirjasto .NET:lle.
Liitä aiemmin kopioimasi Sovellus (asiakas) -tunnus ja liitä se ClientId-muuttujaa varten.
Vaihtoehto 2: Fabric-portaalin käyttäminen
Kirjaudu testattavan vuokraajan Kangasportaaliin ja paina F12 siirtyäksesi selaimen kehittäjätilaan. Suorita konsolissa seuraava komento:
powerBIAccessToken
Kopioi tunnus ja liitä se ClientId-muuttujalle.
Kohteen määritelmä, jonka tietokanta64 on koodattu
- Käytä Base64-koodausta ja decodea JSON-koodaamiseen.
- Varmista, että Suorita URL-osoite turvallinen koodaus -ruutu ei ole valittuna.
- Voit saada putkimääritelmät Fabric-käyttöliittymän Näytä --Näytä JSON-koodi> -välilehdellä.
{
"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"
}
}
Ota ominaisuusobjekti ja ympäröi ne aaltosulkeilla - { } – REST-kohteen määrityksen hyötykuorma olisi seuraava:
{
"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"
}
}
Luo kohde
REST-ohjelmointirajapinta – Kohteet – Luo kohde
Esimerkki 1 - CreateDataPipeline:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items
Teksti:
{
"displayName": "pipeline_1",
"type": "DataPipeline"
}
Muistiinpano
Ohjeissa ilmoitetaan, että pakollisia ominaisuuksia on vain kaksi: displayName ja type. Tällä hetkellä workload-DI ei tue luomista myös ilman määritelmää. Tämän virheellisen vaatimuksen korjausta otetaan parhaillaan käyttöön. Nyt voit lähettää fabric-käyttöliittymän käyttämän oletusmäärityksen: ‘{"properties":{"activities":[]}}’
Muokattu JSON, mukaan lukien määritelmä:
{
"displayName": "pipeline_1",
"type": "DataPipeline",
"definition": {
"parts": [
{
"path": "pipeline-content.json",
"payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=",
"payloadType": "InlineBase64"
}
]
}
}
Vastaus 201:
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "DataPipeline",
"displayName": "Pipeline_1",
"description": "",
"workspaceId": "<Your WS Id>"
}
Esimerkki 2 – Luo MountedDataFactory
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items
Teksti:
Työkuorma:
{"DataFactoryResourceId":"/subscriptions/<ADF subscription Id>/resourceGroups/<ADF resource group name>/providers/Microsoft.DataFactory/factories/<ADF datafactory name>"}
Koodattu JSON:
{
"displayName": "pipeline_mdf",
"type": " MountedDataFactory ",
"definition": {
"parts": [
{
"path": "mountedDataFactory-content.json",
"payload": <base64 encoded value>,
"payloadType": "InlineBase64"
}
]
}
}
Vastaus 201:
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "MountedDataFactory",
"displayName": "Pipeline_mdf",
"description": "",
"workspaceId": "<Your WS Id>"
}
Poista kohde
REST-ohjelmointirajapinta – kohteet – Poista kohde
Esimerkki:
DELETE https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>
Vastaus 200: (ei leipätekstiä)
Hae kohde
REST-ohjelmointirajapinta – Kohteet – Nouda kohde
Esimerkki:
GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>
Vastaus 200:
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "DataPipeline",
"displayName": "Pipeline_1",
"workspaceId": "<your WS Id>"
}
Hae kohteen määritys
REST-ohjelmointirajapinta – Kohteet – Hae kohteen määritys
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/getDefinition
Vastaus 200:
{
"definition": {
"parts":[
{
"path": "pipeline-content.json",
"payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==",
"payloadType": "InlineBase64"
}
]
}
}
Luettelokohteet
REST-ohjelmointirajapinta – kohteet – luettelokohteet
Esimerkki:
GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items
Vastaus 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"
}
]
}
Päivitä kohde
REST-ohjelmointirajapinta – kohteet – päivityskohde
Esimerkki:
PATCH https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>
Teksti:
{
"displayName": "Pipeline_1_updated",
"description": "This is the description."
}
Vastaus 200:
{
"id": "<pipeline id>",
"type": "DataPipeline",
"displayName": "Pipeline_1_updated",
"description": "This is the description.",
"workspaceId": "<Your WS id>"
}
Kohteen määrityksen päivittäminen
REST-ohjelmointirajapinta – kohteet – päivitä kohteen määritys
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/updateDefinition
Teksti:
{
"definition": {
"parts": [
{
"path": "pipeline-content.json",
"payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=",
"payloadType": "InlineBase64"
}
]
}
}
Vastaus 200: (ei leipätekstiä)
Suorita pyydettäessä tehtävä kohdetyö
REST-ohjelmointirajapinta – Kohteet – Suorita pyydettäessä tehtävä kohdetyö
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline
Vastaus 202: (ei leipätekstiä)
Esimerkki, jossa on kaksi parametriarvoa:
Tässä on Odotus-aktiviteetti, jonka parametrin nimi on param_waitsec, joka määrittää odottavien sekuntien määrän.
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline
Teksti:
{
"executionData": {
"parameters": {
"param_waitsec": "10"
}
}
}
Vastaus 202: (ei leipätekstiä)
Muistiinpano
Tällä hetkellä ei palauteta leipätekstiä, mutta työtunnus tulisi palauttaa. Esikatselun aikana se löytyy palautetut otsikot Sijainti-ominaisuudesta.
Hae kohdetyön esiintymä
REST-ohjelmointirajapinta – Kohteet – Hae kohdetyön esiintymä
Esimerkki:
GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>
Vastaus 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"
}
Peruuta nimiketyön esiintymä
REST-ohjelmointirajapinta – kohteet – peruuta nimiketyön esiintymä
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>/cancel
Vastaus 202: (ei leipätekstiä)
Muistiinpano
Kun olet peruuttanut työn, voit tarkistaa tilan joko kutsumalla Hae kohdetyön esiintymä tai katsomalla Näytä suoritushistoria Fabric-käyttöliittymässä.
Kyselyn toimintojen suoritukset
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/datapipelines/pipelineruns/<job id>/queryactivityruns
Teksti:
{
"filters":[],
"orderBy":[{"orderBy":"ActivityRunStart","order":"DESC"}],
"lastUpdatedAfter":"2024-05-22T14:02:04.1423888Z",
"lastUpdatedBefore":"2024-05-24T13:21:27.738Z"
}
Muistiinpano
"työtunnus" on sama tunnus, joka on luotu ja jota käytetään julkisten työn ajoitustoimintojen ohjelmointirajapiimissa
Vastaus 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"
}
]
Tunnetut rajoitukset
- Palvelun päänimen todennusta (SPN) ei tällä hetkellä tueta.