Microsoft Fabric peilaa julkisen REST-ohjelmointirajapinnan
Fabric-peilauksen julkiset ohjelmointirajapinnat koostuvat kahdesta luokasta: (1) CRUD-toiminnot Fabric-peilattu tietokantakohteelle ja (2) käynnistys- ja pysäytys- ja valvontatoiminnot. Microsoft Fabric REST -ohjelmointirajapintojen ensisijaiset online-viitetiedot löytyvät Microsoft Fabricin REST-ohjelmointirajapintaviittauksista.
Muistiinpano
Nämä REST-ohjelmointirajapinnat eivät koske Azure Databricksin peilattua tietokantaa.
Peilatun tietokannan luominen
REST-ohjelmointirajapinta – kohteet – peilatun tietokannan luominen
Ennen kuin luot peilatun tietokannan, tarvitset vastaavan tietolähdeyhteyden. Jos sinulla ei vielä ole yhteyttä, katso luo uusi yhteys portaalin avulla ja käytä kyseistä yhteystunnusta seuraavassa määrityksessä. Voit luoda uuden yhteyden Fabric REST -ohjelmointirajapintojen avulla myös luomalla uuden yhteyden REST-ohjelmointirajapinnalla .
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases
Teksti:
{
"displayName": "Mirrored database 1",
"description": "A mirrored database description",
"definition": {
"parts": [
{
"path": "mirroring.json",
"payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
"payloadType": "InlineBase64"
}
]
}
}
Edellisen JSON-leipätekstin hyötykuormaominaisuus on Base64-koodattu. Voit koodata base64-koodauksen ja decoden avulla. Seuraavat alkuperäiset JSON-määritysesimerkit eri lähdetyypeille ovat seuraavat:
- Esimerkki Snowflaken JSON-määritelmästä
- Esimerkki JSON-määrityksestä Azuren SQL-tietokannasta
- JSON-määritelmäesimerkki Azure SQL:n hallitusta esiintymästä
- Esimerkki Azure Cosmos DB:n JSON-määritelmästä
- JSON-määritelmäesimerkki avoimesta peilaamisesta
Jos haluat replikoida valikoivat taulukot kaikkien määritetyn tietokannan taulukoiden sijaan, katso JSON-määritysesimerkki määritettyjen taulukoiden replikoimisesta.
Tärkeä
Jos haluat peilata Tietoja Azure SQL -tietokannasta tai Azure SQL:n hallitusta esiintymästä, sinun on myös tehtävä seuraavat toimet ennen peilauksen aloittamista:
- Ota käyttöön Järjestelmän määrittämä hallittu käyttäjätieto (SAMI) Azure SQL:n loogisella palvelimella tai Azure SQL:n hallitulla esiintymällä.
- Myönnä SAMI :n luku- ja kirjoitusoikeus peilattuun tietokantaan. Tämä on tehtävä tällä hetkellä Fabric-portaalissa. Alternativley, voit myöntää SAMI-työtilan roolin lisäämistyötilan roolimäärityksen ohjelmointirajapinnan avulla.
Esimerkki Snowflaken JSON-määritelmästä
{
"properties": {
"source": {
"type": "Snowflake",
"typeProperties": {
"connection": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
"database": "xxxx"
}
},
"target": {
"type": "MountedRelationalDatabase",
"typeProperties": {
"defaultSchema": "xxxx",
"format": "Delta"
}
}
}
}
Esimerkki JSON-määrityksestä Azuren SQL-tietokannasta
{
"properties": {
"source": {
"type": "AzureSqlDatabase",
"typeProperties": {
"connection": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1"
}
},
"target": {
"type": "MountedRelationalDatabase",
"typeProperties": {
"defaultSchema": "xxxx",
"format": "Delta"
}
}
}
}
JSON-määritelmäesimerkki Azure SQL:n hallitusta esiintymästä
{
"properties": {
"source": {
"type": "AzureSqlMI",
"typeProperties": {
"connection": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1"
}
},
"target": {
"type": "MountedRelationalDatabase",
"typeProperties": {
"defaultSchema": "xxxx",
"format": "Delta"
}
}
}
}
Esimerkki Azure Cosmos DB:n JSON-määritelmästä
{
"properties": {
"source": {
"type": "CosmosDb",
"typeProperties": {
"connection": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
"database": "xxxx"
}
},
"target": {
"type": "MountedRelationalDatabase",
"typeProperties": {
"defaultSchema": "xxxx",
"format": "Delta"
}
}
}
}
JSON-määritelmäesimerkki avoimesta peilaamisesta
{
"properties": {
"source": {
"type": "GenericMirror",
"typeProperties": {}
},
"target": {
"type": "MountedRelationalDatabase",
"typeProperties": {
"format": "Delta"
}
}
}
}
JSON-määritysesimerkki määritettyjen taulukoiden replikoimisesta
Edelliset esimerkit koskevat skenaariota, joka replikoi automaattisesti kaikki määritetyn tietokannan taulukot. Jos haluat määrittää replikoidut taulukot, voit määrittää ominaisuuden mountedTables
seuraavassa esimerkissä esitetyllä tavalla.
{
"properties": {
"source": {
"type": "Snowflake",
"typeProperties": {
"connection": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
"database": "xxxx"
}
},
"target": {
"type": "MountedRelationalDatabase",
"typeProperties": {
"defaultSchema": "xxxx",
"format": "Delta"
}
},
"mountedTables": [
{
"source": {
"typeProperties": {
"schemaName": "xxxx",
"tableName": "xxxx"
}
}
}
]
}
}
Vastaus 201:
{
"id": "<mirrored database ID>",
"type": "MirroredDatabase",
"displayName": "Mirrored database 1",
"description": "A mirrored database description",
"workspaceId": "<your workspace ID>"
}
Peilatun tietokannan poistaminen
REST-ohjelmointirajapinta – kohteet – poista peilattu tietokanta
Esimerkki:
DELETE https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>
Vastaus 200: (ei leipätekstiä)
Peilatun tietokannan hakeminen
REST-ohjelmointirajapinta – kohteet – hae peilattu tietokanta
Esimerkki:
GET https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>
Vastaus 200:
{
"displayName": "Mirrored database 1",
"description": "A mirrored database description.",
"type": "MirroredDatabase",
"workspaceId": "<your workspace ID>",
"id": "<mirrored database ID>",
"properties": {
"oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/<your workspace ID>/<mirrored database ID>/Tables",
"sqlEndpointProperties": {
"connectionString": "xxxx.xxxx.fabric.microsoft.com",
"id": "b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2",
"provisioningStatus": "Success"
},
"defaultSchema": "xxxx"
}
}
Peilatun tietokantamääritelmän hakeminen
REST-ohjelmointirajapinta – kohteet – hae peilattu tietokantamääritys
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>/getDefinition
Vastaus 200:
{
"definition": {
"parts":[
{
"path": "mirroring.json",
"payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
"payloadType": "InlineBase64"
}
]
}
}
Luettelo peilattu tietokannoista
REST-ohjelmointirajapinta – kohteet – luettelo peilatut tietokannat
Esimerkki:
GET https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases
Vastaus 200:
{
"value": [
{
"displayName": "Mirrored database 1",
"description": "A mirrored database description.",
"type": "MirroredDatabase",
"workspaceId": "<your workspace ID>",
"id": "<mirrored database ID>",
"properties": {
"oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/<your workspace ID>/<mirrored database ID>/Tables",
"sqlEndpointProperties": {
"connectionString": "xxxx.xxxx.fabric.microsoft.com",
"id": "b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2",
"provisioningStatus": "Success"
},
"defaultSchema": "xxxx"
}
}
]
}
Päivitä peilattu tietokanta
REST-ohjelmointirajapinta – kohteet – päivitä peilattu tietokanta
Esimerkki:
PATCH https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>
Teksti:
{
"displayName": "MirroredDatabase's New name",
"description": "A new description for mirrored database."
}
Vastaus 200:
{
"displayName": "MirroredDatabase's New name",
"description": "A new description for mirrored database.",
"type": "MirroredDatabase",
"workspaceId": "<your workspace ID>",
"id": "<mirrored database ID>"
}
Päivitä peilattu tietokantamääritys
REST-ohjelmointirajapinta – kohteet – päivitä peilattu tietokantamääritys
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>/updateDefinition
Teksti:
{
"definition": {
"parts": [
{
"path": "mirroring.json",
"payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
"payloadType": "InlineBase64"
}
]
}
}
Vastaus 200: (ei leipätekstiä)
Muistiinpano
Tämä ohjelmointirajapinta tukee taulukoiden lisäämistä/poistamista päivittämällä mountedTables
-ominaisuutta. Se tukee myös lähdeyhteyden tunnuksen, tietokannan nimen ja oletusrakenteen päivittämistä (nämä kolme ominaisuutta voidaan päivittää vain, kun Hae peilauksen tilan ohjelmointirajapinta palauttaa arvon Initialized
/Stopped
).
Hae peilauksen tila
REST-ohjelmointirajapinta – peilauksen tilan hakeminen
Tämä ohjelmointirajapinta palauttaa peilatun tietokantaesiintymän tilan. Käytettävissä olevien tilojen luettelo annetaan MirroringStatus-arvoilla.
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>/getMirroringStatus
Vastaus 200:
{
"status": "Running"
}
Aloita peilaus
REST-ohjelmointirajapinta – peilaus – aloita peilaus
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>/startMirroring
Vastaus 200: (ei leipätekstiä)
Muistiinpano
Peilaus ei ole käyntissä, kun Hae peilauksen tilan ohjelmointirajapinta palauttaa Initializing
tilan.
Tilapeivan taulukoiden hakeminen
REST-ohjelmointirajapinta – peilaus – Hae tila peilaavia taulukoita
Jos peilaus käynnistetään ja Hae peilauksen tilan ohjelmointirajapinta palauttaa Running
tilan, tämä ohjelmointirajapinta palauttaa taulukoiden replikoinnin tilan ja arvot.
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>/getTablesMirroringStatus
Vastaus 200:
{
"continuationToken": null,
"continuationUri": null,
"data": [
{
"sourceSchemaName": "dbo",
"sourceTableName": "test",
"status": "Replicating",
"metrics": {
"processedBytes": 1247,
"processedRows": 6,
"lastSyncDateTime": "2024-10-08T05:07:11.0663362Z"
}
}
]
}
Lopeta peilaus
REST-ohjelmointirajapinta - Peilaus - Lopeta peilaus
Esimerkki:
POST https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>/stopMirroring
Vastaus 200: (ei leipätekstiä)
Muistiinpano
Peilauksen lopettamisen jälkeen voit kutsua Hae peilauksen tilan ohjelmointirajapintaa peilauksen tilan kyselyksi.
Microsoft Fabric .NET SDK
Fabric-peilausta tukeva .NET SDK on saatavilla Microsoft Fabric .NET SDK:ssa. Version on oltava >= 1.0.0-beta.11.
Tunnetut rajoitukset
Tällä hetkellä palvelun päänimen/hallitun käyttäjätiedon todennusta ei tueta, jos vuokraajan kotialue on Yhdysvaltojen pohjoisosassa tai Itä-Yhdysvalloissa. Voit käyttää sitä muilla alueilla.