Jaa kautta

Microsoft Fabric peilaa julkista REST-ohjelmointirajapintaa

Fabric-peilauksen julkiset ohjelmointirajapinnat koostuvat kahdesta luokasta: (1) Fabric-peilatun tietokantakohteen CRUD-toiminnot ja (2) Käynnistys-/pysäytys- ja valvontatoiminnot. Microsoft Fabric REST -ohjelmointirajapintojen ensisijainen online-viitedokumentaatio löytyy Microsoft Fabric REST -ohjelmointirajapinnan viitteistä.

Note

Nämä REST-ohjelmointirajapinnat eivät koske Azure Databricksin peilattua tietokantaa.

Luo peilattu tietokanta

REST API - Kohteet - Luo peilattu tietokanta

Ennen peilatun tietokannan luomista tarvitaan vastaava tietolähdeyhteys. Jos sinulla ei vielä ole yhteyttä, katso Uuden yhteyden luominen portaalin avulla ja käytä kyseistä yhteystunnusta seuraavassa määrityksessä. Voit myös katsoa uuden yhteyden REST-ohjelmointirajapinnan luomista Fabric REST -ohjelmointirajapintojen avulla.

Esimerkki:

POST https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases

Keho:

{
    "displayName": "Mirrored database 1",
    "description": "A mirrored database description",
    "definition": {
        "parts": [
            {
                "path": "mirroring.json",
                "payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
                "payloadType": "InlineBase64"
            }
        ]
    }
}

Edellisen payload JSON-rungon ominaisuus on Base64-koodattu. Voit käyttää koodaamiseen Base64-koodausta ja dekoodausta .

Alkuperäiset JSON-määrittelyesimerkit ovat seuraavat. Lisätietoja peilatun tietokantakohteen määrityksestä, mukaan lukien määritysrakenteen erittely, on kohdassa Peilatun tietokantakohteen määritys. Voit myös viitata aiemmin luodun peilatun tietokannan määritykseen kutsumalla Hae peilatun tietokannan määritys API:ta.

Tärkeää

Jos haluat peilata tietoja Azure SQL Databasesta, Azure SQL Managed Instancesta, Azure Database for PostgreSQL:stä tai SQL Server 2025:stä, sinun on myös tehtävä seuraavat toimet ennen peilauksen aloittamista:

  1. Ota käyttöön Azure SQL -loogisen palvelimesi, Azure SQL Managed Instance, Azure Database for PostgreSQL tai SQL Serverin hallittu identiteetti.
  2. Myönnä hallinnoidun identiteetin luku- ja kirjoitusoikeudet peilatulle tietokannalle. Tällä hetkellä sinun on tehtävä tämä Fabric-portaalissa. Vaihtoehtoisesti voit myöntää hallitetun identiteetin työtilan roolin Add Workspace Role Assignment API:n avulla.

Note

Määritä deafultSchema ominaisuus säilyttämään lähderakennehierarkia peilatussa tietokannassa.

JSON-määritelmäesimerkki koko tietokannan replikoinnista

Voit peilata kaikki lähdetietokannan taulukot seuraavasti:

{
    "properties": {
        "source": {
            "type": "<your source type>",
            "typeProperties": {
                "connection": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
                "database": "xxxx"
            }
        },
        "target": {
            "type": "MountedRelationalDatabase",
            "typeProperties": {
                "defaultSchema": "xxxx",
                "format": "Delta"
            }
        }
    }
}

JSON-määritysesimerkki määritettyjen taulukoiden replikoinnista

Jos haluat peilata valikoituja taulukoita lähdetietokannasta, voit määrittää ominaisuuden mountedTables seuraavassa esimerkissä esitetyllä tavalla.

{
    "properties": {
        "source": {
            "type": "<your source type>",
            "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 API - Kohteet - Poista peilattu tietokanta

Esimerkki:

DELETE https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>

Vastaus 200: (Ei ruumista)

Hanki peilattu tietokanta

REST API - 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"
    }
}

Hanki peilattu tietokannan määritys

REST API - Kohteet - Hae peilattu tietokannan mää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" 
            } 
        ] 
    } 
}

Peilattujen tietokantojen luettelointi

REST API - Kohteet - Peilattujen tietokantojen luettelo

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 API - Kohteet - Päivitä peilattu tietokanta

Esimerkki:

PATCH https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>

Keho:

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

Peilatun tietokannan määrityksen päivittäminen

REST API - Kohteet - Päivitä peilatun tietokannan määritys

Esimerkki:

POST https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>/updateDefinition

Keho:

{ 
  "definition": { 
    "parts": [ 
      { 
        "path": "mirroring.json", 
        "payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0", 
        "payloadType": "InlineBase64" 
      } 
    ] 
  } 
}

Vastaus 200: (Ei ruumista)

Edellisen JSON-rungon hyötykuormaominaisuus on Base64-koodattu. Voit käyttää koodaamiseen Base64-koodausta ja dekoodausta .

Note

Tämä ohjelmointirajapinta tukee taulukoiden lisäämistä/poistamista päivittämällä mountedTables ominaisuus. Se tukee myös lähdeyhteyden tunnuksen, tietokannan nimen ja oletusrakenteen päivittämistä (nämä kolme ominaisuutta voidaan päivittää vain, kun Hae peilaustila API palauttaa ).Initialized/Stopped

Tietojen säilyttämisen määrittäminen

Voit määrittää peilatun datan säilytysajan ominaisuuden retentionInDays avulla. Oletusarvo on seitsemän päivää. Sallitut arvot ovat kokonaislukuja väliltä 1–30.

JSON-määritysesimerkki ennen Base64-koodausta:

{
    "properties": {
        "source": {...},
        "target": {
            "type": "MountedRelationalDatabase",
            "typeProperties": {
                "defaultSchema": "xxxx",
                "format": "Delta",
                "retentionInDays": 1
            }
        }
    }
}

Hanki peilauksen tila

REST API - Peilaus - Hae peilauksen tila

Tämä ohjelmointirajapinta palauttaa peilatun tietokantaesiintymän tilan. Käytettävissä olevien tilojen luettelo on 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 API - Peilaus - Aloita peilaus

Esimerkki:

POST https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>/startMirroring

Vastaus 200: (Ei ruumista)

Note

Peilausta ei voi aloittaa, kun yllä oleva Hae peilaustila -ohjelmointirajapinta palauttaa Initializing tilan.

Hae taulukoiden peilaustila

REST API - Peilaus - Hae taulukoiden peilaustila

Jos peilaus on aloitettu ja Hae peilaustila -ohjelmointirajapinta palauttaa Running tilan, tämä ohjelmointirajapinta palauttaa taulukoiden replikoinnin tilan ja mittarit.

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

Peilauksen lopettaminen

REST API - Peilaus - Lopeta peilaus

Esimerkki:

POST https://api.fabric.microsoft.com/v1/workspaces/<your workspace ID>/mirroredDatabases/<mirrored database ID>/stopMirroring

Vastaus 200: (Ei ruumista)

Note

Kun peilaus on lopetettu, voit kutsua Hae peilauksen tila -ohjelmointirajapintaa ja kysyä peilauksen tilaa.

Microsoft Fabric .NET SDK

Kankaan peilausta tukeva .NET SDK on saatavilla Microsoft Fabric .NET SDK:ssa. Version on oltava >= 1.0.0-beta.11.

Liittyvä sisältö

  • Last updated on