Aracılığıyla paylaş

Microsoft Fabric genel REST API'sini yansıtma

Doku yansıtma için genel API'ler iki kategoriden oluşur: (1) Doku yansıtılmış veritabanı öğesi için CRUD işlemleri ve (2) Başlatma/durdurma ve izleme işlemleri. Microsoft Fabric REST API'leri için birincil çevrimiçi başvuru belgeleri Microsoft Fabric REST API başvurularında bulunabilir.

Uyarı

Bu REST API'leri Azure Databricks'ten yansıtılmış veritabanına uygulanmaz.

Yansıtılmış veritabanı oluşturma

REST API - Öğeler - Yansıtılmış veritabanı oluşturma

Yansıtılmış veritabanı oluşturmadan önce ilgili veri kaynağı bağlantısı gerekir. Henüz bir bağlantınız yoksa , portalı kullanarak yeni bağlantı oluşturma bölümüne bakın ve aşağıdaki tanımda bu bağlantı kimliğini kullanın. Doku REST API'lerini kullanarak yeni bağlantı oluşturmak için yeni bağlantı REST API'sine de başvurabilirsiniz.

Örnek:

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

Metin:

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

payload Önceki JSON gövdesindeki özelliği Base64 kodlanmış. Kodlamak için Base64 Kodlama ve Kod Çözme'yi kullanabilirsiniz.

Özgün JSON tanımı örnekleri aşağıdaki gibidir. Tanım yapısının dökümü de dahil olmak üzere yansıtılmış veritabanı öğesi tanımı hakkında daha fazla bilgi için bkz. Yansıtılmış veritabanı öğesi tanımı. Yansıtılmış veritabanı tanımı API'sini alma çağrısı yaparak da mevcut yansıtılmış veritabanınızın tanımına başvurabilirsiniz.

Önemli

Azure SQL Veritabanı, Azure SQL Yönetilen Örneği, PostgreSQL için Azure Veritabanı veya SQL Server 2025'ten verileri yansıtmak için yansıtmaya başlamadan önce aşağıdakileri de yapmanız gerekir:

  1. Azure SQL mantıksal sunucunuzun, Azure SQLYönetilen Örneğinizin, PostgreSQL için Azure Veritabanı'nın veya SQL Server'ın yönetilen kimliğini etkinleştirin.
  2. Yönetilen kimliğe yansıtılmış veritabanına Okuma ve Yazma izni verin. Şu anda bunu Doku portalında yapmanız gerekir. Alternatif olarak, Çalışma Alanı Rolü Atama API'sini Kullan ile yönetilen kimlik için çalışma alanı rolü verebilirsiniz.

Uyarı

Yansıtmalı deafultSchema veritabanında kaynak şema hiyerarşisini korumak için özelliğini ayarlayın.

Veritabanının tamamını çoğaltmaya örnek JSON tanımı

Kaynak veritabanındaki tüm tabloları yansıtmak için:

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

Belirtilen tabloları çoğaltmaya ait JSON tanım örneği

Seçmeli tabloları kaynak veritabanından yansıtmak için aşağıdaki örnekte olduğu gibi özelliğini belirtebilirsiniz 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"
                    }
                }
            }
        ]
    }
}

Yanıt 201:

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

Yansıtılmış veritabanını silme

REST API - Öğeler - Yansıtılmış veritabanını silme

Örnek:

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

Yanıt 200: (Gövde yok)

Yansıtılmış veritabanı alma

REST API - Öğeler - Yansıtılmış veritabanı alma

Örnek:

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

Yanıt 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"
    }
}

Yansıtılmış veritabanı tanımını alma

REST API - Öğeler - Yansıtılmış veritabanı tanımını alma

Örnek:

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

Yanıt 200:

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

Yansıtılmış veritabanlarını listeleme

REST API - Öğeler - Yansıtılmış veritabanlarını listeleme

Örnek:

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

Yanıt 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"
            }
        }
    ] 
}

Yansıtılmış veritabanını güncelleştirme

REST API - Öğeler - Yansıtılmış veritabanını güncelleştirme

Örnek:

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

Metin:

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

Yanıt 200:

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

Yansıtılmış veritabanı tanımını güncelleştirme

REST API - Öğeler - Yansıtılmış veritabanı tanımını güncelleştirme

Örnek:

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

Metin:

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

Yanıt 200: (Gövde yok)

Önceki JSON gövdesindeki payload özelliği Base64 kodludur. Kodlamak için Base64 Kodlama ve Kod Çözme'yi kullanabilirsiniz.

Uyarı

Bu API, özelliğini yenileyerek tablo eklemeyi/kaldırmayı mountedTables destekler. Ayrıca kaynak bağlantı kimliğini, veritabanı adını ve varsayılan şemayı güncelleştirmeyi de destekler (bu üç özellik yalnızca Yansıtma durumu API'si döndürdüğünde Initialized/Stoppedgüncelleştirilebilir).

Veri saklamayı yapılandırma

özelliğini kullanarak retentionInDays ayarlayabilirsiniz. Varsayılan değer yedi gündür. İzin verilen değerler 1 ile 30 arasında bir tamsayıdır.

Base64 kodlamadan önceki JSON tanımı örneği:

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

Yansıtma durumunu alma

REST API - Yansıtma - Yansıtma durumunu alma

Bu API, yansıtılmış veritabanı örneğinin durumunu döndürür. Kullanılabilir durumların listesi MirroringStatus değerlerinde sağlanır.

Örnek:

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

Yanıt 200:

{
    "status": "Running"
}

Yansıtmayı başlatma

REST API - Yansıtma - Yansıtmayı başlatma

Örnek:

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

Yanıt 200: (Gövde yok)

Uyarı

Yansıtma durumu API'sini alma durumu döndürdüğünde Initializing yansıtma başlatılamaz.

Tablo yansıtma durumunu alma

REST API - Yansıtma - Tablo yansıtma durumunu alma

Yansıtma başlatılırsa ve Yansıtma durumunu al API'sinin durumu döndürülüyorsa Running , bu API tablo çoğaltmasının durumunu ve ölçümlerini döndürür.

Örnek:

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

Yanıt 200:

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

Yansıtmayı durdurma

REST API - Yansıtma - Yansıtmayı durdurma

Örnek:

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

Yanıt 200: (Gövde yok)

Uyarı

Yansıtmayı durdurduktan sonra yansıtma durumunu sorgulamak için Yansıtma durumu API'sini alma çağrısı yapabilirsiniz.

Microsoft Fabric .NET SDK

Doku yansıtmayı destekleyen .NET SDK'sı Microsoft Fabric .NET SDK'sı'nda kullanılabilir. Sürüm = 1.0.0-beta.11 olmalıdır >.

İlgili içerik

  • Last updated on