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

Nyilvános REST API tükrözése a Microsoft Fabricben

A Fabric-tükrözéshez használható nyilvános API-k két kategóriából állnak: (1) CRUD-műveletek a Háló tükrözött adatbáziselemhez , és (2) Indítási/leállítási és monitorozási műveletek. A Microsoft Fabric REST API-k elsődleges online referenciadokumentációja a Microsoft Fabric REST API-referenciákban található.

Megjegyzés:

Ezek a REST API-k nem vonatkoznak az Azure Databricks tükrözött adatbázisára.

Tükrözött adatbázis létrehozása

REST API – Elemek – Tükrözött adatbázis létrehozása

A tükrözött adatbázis létrehozása előtt a megfelelő adatforrás-kapcsolatra van szükség. Ha még nem rendelkezik kapcsolattal, a portál használatával hozzon létre új kapcsolatot , és használja ezt a kapcsolatazonosítót a következő definícióban. Az új kapcsolat REST API-k létrehozásával is létrehozhat új kapcsolatot a Fabric REST API-k használatával.

Példa:

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

Törzs:

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

Az payload előző JSON-törzs tulajdonsága Base64 kódolású. Kódoláshoz használhatja a Base64 Kódolás és dekódolás parancsot.

Az eredeti JSON-definíciós példák a következők. A tükrözött adatbáziselem-definícióról, beleértve a definícióstruktúra lebontását is, tekintse meg a tükrözött adatbáziselem-definíciót. A tükrözött adatbázis definíciójára is hivatkozhat a Get mirrored database definition API meghívásával.

Fontos

Az Azure SQL Database-ből, a felügyelt Azure SQL-példányból, az Azure Database for PostgreSQL-ből vagy az SQL Server 2025-ből származó adatok tükrözéséhez a tükrözés megkezdése előtt az alábbiakat is el kell végeznie:

  1. Engedélyezze az Azure SQL logikai kiszolgáló, az Azure SQL Managed Instance, az Azure Database for PostgreSQL vagy az SQL Server felügyelt identitását.
  2. Adjon olvasási és írási engedélyt a felügyelt identitásnak a tükrözött adatbázishoz. Ezt jelenleg a Háló portálon kell elvégeznie. Másik lehetőségként a felügyelt identitás-munkaterületi szerepkört is megadhatja a Munkaterület-szerepkör-hozzárendelési API hozzáadása használatával.

Megjegyzés:

Állítsa be a tulajdonságot, deafultSchema hogy megőrizze a forrássémahierarchiát a tükrözött adatbázisban.

JSON-definíciós példa a teljes adatbázis replikálására

A forrásadatbázis összes táblájának tükrözése:

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

JSON-definíciós példa a megadott táblák replikálására

A forrásadatbázisból származó szelektív táblák tükrözéséhez a tulajdonságot az alábbi példában leírtak szerint adhatja meg mountedTables .

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

Válasz 201:

{ 
    "id": "<mirrored database ID>", 
    "type": "MirroredDatabase", 
    "displayName": "Mirrored database 1", 
    "description": "A mirrored database description", 
    "workspaceId": "<your workspace ID>" 
}

Tükrözött adatbázis törlése

REST API – Elemek – Tükrözött adatbázis törlése

Példa:

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

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

Tükrözött adatbázis lekérése

REST API – Elemek – Tükrözött adatbázis lekérése

Példa:

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

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

Tükrözött adatbázis definíciójának lekérése

REST API – Elemek – Tükrözött adatbázis definíciójának lekérése

Példa:

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

Válasz 200:

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

Tükrözött adatbázisok listázása

REST API – Elemek – Tükrözött adatbázisok listázása

Példa:

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

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

Tükrözött adatbázis frissítése

REST API – Elemek – Tükrözött adatbázis frissítése

Példa:

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

Törzs:

{
    "displayName": "MirroredDatabase's New name",
    "description": "A new description for mirrored database."
}

Válasz 200:

{
    "displayName": "MirroredDatabase's New name",
    "description": "A new description for mirrored database.",
    "type": "MirroredDatabase",
    "workspaceId": "<your workspace ID>",
    "id": "<mirrored database ID>"
}

Tükrözött adatbázis definíciójának frissítése

REST API – Elemek – Tükrözött adatbázis definíciójának frissítése

Példa:

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

Törzs:

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

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

Az előző JSON-törzs hasznos adat tulajdonsága Base64 kódolású. Kódoláshoz használhatja a Base64 Kódolás és dekódolás parancsot.

Megjegyzés:

Ez az API támogatja a táblák hozzáadását/eltávolítását a mountedTables tulajdonság frissítésével. Emellett támogatja a forráskapcsolat azonosítójának, az adatbázis nevének és az alapértelmezett sémának a frissítését is (ez a három tulajdonság csak akkor frissíthető, ha a Get mirroring status API visszatér Initialized/Stopped).

Adatmegőrzés konfigurálása

A tükrözött adatok megőrzési idejét a retentionInDays tulajdonság használatával állíthatja be. Az alapértelmezett érték hét nap. Az engedélyezett értékek 1 és 30 közötti egész számok.

Példa JSON-definícióra a Base64 kódolása előtt:

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

Tükrözési állapot lekérése

REST API – Tükrözés – Tükrözési állapot lekérése

Ez az API a tükrözött adatbázispéldány állapotát adja vissza. Az elérhető állapotok listája a MirroringStatus értékeivel érhető el.

Példa:

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

Válasz 200:

{
    "status": "Running"
}

Tükrözés indítása

REST API – Tükrözés – Tükrözés indítása

Példa:

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

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

Megjegyzés:

A tükrözés nem indítható el, ha a fenti Get mirroring status API állapotot ad Initializing vissza.

Táblák tükrözési állapotának lekérése

REST API – Tükrözés – Táblák tükrözési állapotának lekérése

Ha a tükrözés elindult, és a Get mirroring status API állapotot ad Running vissza, ez az API visszaadja a táblák replikációjának állapotát és metrikáit.

Példa:

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

Válasz 200:

{
    "continuationToken": null,
    "continuationUri": null,
    "data": [
        {
            "sourceSchemaName": "dbo",
            "sourceTableName": "test",
            "status": "Replicating",
            "metrics": {
                "processedBytes": 1247,
                "processedRows": 6,
                "lastSyncDateTime": "2024-10-08T05:07:11.0663362Z"
            }
        }
    ]
}

Tükrözés leállítása

REST API – Tükrözés – Tükrözés leállítása

Példa:

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

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

Megjegyzés:

A tükrözés leállítása után meghívhatja a Tükrözési állapot API meghívását a tükrözési állapot lekérdezéséhez.

Microsoft Fabric .NET SDK

A Hálótükrözést támogató .NET SDK a Microsoft Fabric .NET SDK-n érhető el. A verziónak = 1.0.0-beta.11-nek kell lennie >.

Kapcsolódó tartalom

  • Last updated on