Microsoft Fabric mencerminkan REST API publik

API publik untuk pencerminan Fabric terdiri dari dua kategori: (1) operasi CRUD untuk item database cermin Fabric dan (2) Operasi mulai/hentikan dan pemantauan. Dokumentasi referensi online utama untuk MICROSOFT Fabric REST API dapat ditemukan di referensi Microsoft Fabric REST API.

Nota

REST API ini tidak berlaku untuk database cermin dari Azure Databricks.

Membuat database cermin

REST API - Item - Membuat database cermin

Sebelum Anda membuat database cermin, koneksi sumber data yang sesuai diperlukan. Jika Anda belum memiliki koneksi, lihat membuat koneksi baru menggunakan portal dan gunakan ID koneksi tersebut dalam definisi berikut. Anda juga dapat merujuk ke membuat REST API koneksi baru untuk membuat koneksi baru menggunakan Fabric REST API.

Contoh:

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

Badan:

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

Properti payload dalam isi JSON sebelumnya dikodekan Base64. Anda dapat menggunakan Encode Base64 dan Dekode untuk mengodekan .

Contoh definisi JSON asli adalah sebagai berikut. Untuk informasi selengkapnya tentang definisi item database yang dicerminkan, termasuk perincian struktur definisi, lihat Definisi item database cermin. Anda juga dapat merujuk ke definisi database cermin yang ada dengan memanggil Get mirrored database definition API.

Contoh definisi JSON untuk mereplikasi seluruh database
Contoh definisi JSON untuk mereplikasi tabel yang ditentukan

Penting

Untuk mencerminkan data dari Azure SQL Database, Azure SQL Managed Instance, Azure Database for PostgreSQL atau SQL Server 2025, Anda juga perlu melakukan hal berikut sebelum mulai mencerminkan:

Aktifkan identitas terkelola server logis Azure SQL Anda, Azure SQL Managed Instance, Azure Database for PostgreSQL , atau SQL Server.
Berikan izin Baca dan Tulis identitas terkelola ke database cermin. Saat ini Anda perlu melakukan ini di portal Fabric. Atau, Anda dapat memberikan peran ruang kerja identitas terkelola menggunakan Tambahkan API Penetapan Peran Ruang Kerja.

Nota

Atur deafultSchema properti untuk mempertahankan hierarki skema sumber dalam database yang dicerminkan.

Contoh definisi JSON untuk mereplikasi seluruh database

Untuk mencerminkan semua tabel dari database sumber:

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

Contoh definisi JSON untuk mereplikasi tabel yang ditentukan

Untuk mencerminkan tabel selektif dari database sumber, Anda bisa menentukan mountedTables properti seperti dalam contoh berikut.

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

Respons 201:

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

Menghapus database cermin

REST API - Item - Menghapus database cermin

Contoh:

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

Respons 200: (Tidak ada isi)

Mendapatkan database cermin

REST API - Item - Dapatkan database cermin

Contoh:

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

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

Mendapatkan definisi database yang dicerminkan

REST API - Item - Dapatkan definisi database yang dicerminkan

Contoh:

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

Respons 200:

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

Mencantumkan database cermin

REST API - Item - Mencantumkan database cermin

Contoh:

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

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

Memperbarui database cermin

REST API - Item - Memperbarui database cermin

Contoh:

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

Badan:

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

Respons 200:

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

Memperbarui definisi database yang dicerminkan

REST API - Item - Memperbarui definisi database yang dicerminkan

Contoh:

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

Badan:

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

Respons 200: (Tidak ada isi)

Properti payload di isi JSON sebelumnya dikodekan Base64. Anda dapat menggunakan Encode Base64 dan Dekode untuk mengodekan .

Nota

API ini mendukung penambahan/penghapusan tabel dengan menyegarkan mountedTables properti. Ini juga mendukung pembaruan ID koneksi sumber, nama database, dan skema default (ketiga properti ini hanya dapat diperbarui saat Dapatkan API status pencerminanInitialized/Stoppedmengembalikan ).

Mengonfigurasi retensi data

Anda dapat mengatur periode retensi untuk data cermin menggunakan retentionInDays properti . Nilai defaultnya adalah tujuh hari. Nilai yang diizinkan adalah bilangan bulat antara 1 dan 30.

Contoh definisi JSON sebelum pengodean Base64:

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

Mendapatkan status pencerminan

REST API - Pencerminan - Dapatkan status pencerminan

API ini mengembalikan status instans database cermin. Daftar status yang tersedia disediakan pada nilai MirroringStatus.

Contoh:

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

Respons 200:

{
    "status": "Running"
}

Mulai mencerminkan

REST API - Pencerminan - Mulai pencerminan

Contoh:

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

Respons 200: (Tidak ada isi)

Nota

Pencerminan tidak dapat dimulai ketika di atas Dapatkan status pencerminan API mengembalikan Initializing status.

Mendapatkan status pencerminan tabel

REST API - Pencerminan - Dapatkan status pencerminan tabel

Jika pencerminan dimulai dan Dapatkan status pencerminan API mengembalikan Running status, API ini mengembalikan status dan metrik replikasi tabel.

Contoh:

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

Respons 200:

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

Berhenti mencerminkan

REST API - Pencerminan - Hentikan pencerminan

Contoh:

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

Respons 200: (Tidak ada isi)

Nota

Setelah berhenti mencerminkan, Anda dapat memanggil Dapatkan API status pencerminan untuk mengkueri status pencerminan.

Microsoft Fabric .NET SDK

.NET SDK yang mendukung pencerminan Fabric tersedia di Microsoft Fabric .NET SDK. Versi harus >= 1.0.0-beta.11.

Saran dan Komentar

Apakah halaman ini membantu?

Last updated on 2025-11-27

Bagikan melalui

Microsoft Fabric mencerminkan REST API publik

Membuat database cermin

Contoh definisi JSON untuk mereplikasi seluruh database

Contoh definisi JSON untuk mereplikasi tabel yang ditentukan

Menghapus database cermin

Mendapatkan database cermin

Mendapatkan definisi database yang dicerminkan

Mencantumkan database cermin

Memperbarui database cermin

Memperbarui definisi database yang dicerminkan

Mengonfigurasi retensi data

Mendapatkan status pencerminan

Mulai mencerminkan

Mendapatkan status pencerminan tabel

Berhenti mencerminkan

Microsoft Fabric .NET SDK

Konten terkait

Saran dan Komentar

Sumber Daya Tambahan: