Del via

Microsoft Fabric-spejling af offentlig REST API

De offentlige API'er til Fabric-spejling består af to kategorier: (1) CRUD-handlinger for Fabric-spejlede databaseelementer og (2) Start/stop og overvågningshandlinger. Den primære onlinereferencedokumentation til Microsoft Fabric REST API'er kan findes i Microsoft Fabric REST API-referencer.

Notat

Disse REST-API'er gælder ikke for spejlede databaser fra Azure Databricks.

Opret spejlet database

REST API - Elementer - Opret spejlet database

Før du opretter en spejlet database, skal du have den tilsvarende datakildeforbindelse. Hvis du ikke har en forbindelse endnu, skal du se Opret ny forbindelse ved hjælp af portalen og brug dette forbindelses-id i følgende definition. Du kan også se Opret ny REST API til forbindelse for at oprette en ny forbindelse ved hjælp af REST API'er til struktur.

Eksempel:

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

Legeme:

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

Egenskaben payload i den tidligere JSON-brødtekst er Base64-kodet. Du kan bruge Base64 Encode og Decode til at kode.

De originale JSON-definitionseksempler er som følger. Du kan finde flere oplysninger om definitionen af spejlede databaseelementer, herunder en opdeling af definitionsstrukturen, under Definition af spejlede databaseelementer. Du kan også referere til din eksisterende spejlede databases definition ved at kalde API'en Hent spejlet databasedefinition.

Vigtigt!

Hvis du vil spejle data fra Azure SQL Database, Azure SQL Managed Instance, Azure Database for PostgreSQL eller SQL Server 2025, skal du også gøre følgende, før du starter spejlingen:

  1. Aktivér den administrerede identitet for din Azure SQL logical server, Azure SQL Managed Instance, Azure Database for PostgreSQL eller SQL Server.
  2. Giv den administrerede identitet læse- og skrivetilladelse til den spejlede database. I øjeblikket skal du gøre dette på Fabric-portalen. Alternativt kan du tildele den administrerede identitets arbejdsområde-rolle ved at bruge Add Workspace Role Assignment API.

Notat

Angiv egenskaben deafultSchema for at bevare kildeskemahierarkiet i den spejlede database.

JSON-definitionseksempel på replikering af hele databasen

Sådan spejler du alle tabellerne fra kildedatabasen:

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

JSON-definitionseksempel på replikering af angivne tabeller

Hvis du vil spejle selektive tabeller fra kildedatabasen, kan du angive egenskaben mountedTables som i følgende eksempel.

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

Svar 201:

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

Slet spejlet database

REST API - Elementer - Slet spejlet database

Eksempel:

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

Svar 200: (Ingen krop)

Hent spejlet database

REST API - Elementer - Hent spejlet database

Eksempel:

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

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

Hent spejlet databasedefinition

REST API - Elementer - Hent spejlet databasedefinition

Eksempel:

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

Svar 200:

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

Liste over spejlede databaser

REST API - Elementer - Vis spejlede databaser

Eksempel:

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

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

Opdater spejlet database

REST API - Elementer - Opdater spejlet database

Eksempel:

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

Legeme:

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

Svar 200:

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

Opdater spejlet databasedefinition

REST API – Elementer – Opdater spejlet databasedefinition

Eksempel:

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

Legeme:

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

Svar 200: (Ingen krop)

Nyttedataegenskaben i den tidligere JSON-brødtekst er Base64-kodet. Du kan bruge Base64 Encode og Decode til at kode.

Notat

Denne API understøtter tilføjelse/fjernelse af tabeller ved at opdatere egenskaben mountedTables . Det understøtter også opdatering af kildeforbindelses-id'et, databasenavnet og standardskemaet (disse tre egenskaber kan kun opdateres, når API'en Hent spejlingsstatus returnerer Initialized/Stopped).

Konfigurere dataopbevaring

Du kan angive opbevaringsperioden for spejlede data ved hjælp af retentionInDays ejendommen. Standardværdien er syv dage. De tilladte værdier er heltal mellem 1 og 30.

Eksempel på JSON-definition før Base64-kodning:

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

Få spejlingsstatus

REST API - Spejling - Hent spejlingsstatus

Denne API returnerer status for spejlet databaseforekomst. Listen over tilgængelige statusser vises ved værdierne for MirroringStatus.

Eksempel:

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

Svar 200:

{
    "status": "Running"
}

Begynd spejling

REST API - Spejling - Start spejling

Eksempel:

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

Svar 200: (Ingen krop)

Notat

Spejling kan ikke startes, når API'en Hent spejlingsstatus returnerer Initializing status ovenfor.

Hent status for spejling af tabeller

REST API - Spejling - Hent status for spejling af tabeller

Hvis spejling startes, og API'en Hent spejlingsstatus returnerer Running status, returnerer denne API status og målepunkter for tabelreplikering.

Eksempel:

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

Svar 200:

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

Stop spejling

REST API - Spejling - Stop spejling

Eksempel:

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

Svar 200: (Ingen krop)

Notat

Når du har stoppet spejling, kan du kalde API'en Hent spejlingsstatus for at forespørge om spejlingsstatus.

Microsoft Fabric .NET SDK

Det .NET SDK, der understøtter Fabric Mirroring, er tilgængeligt på Microsoft Fabric .NET SDK. Versionen skal være >= 1.0.0-beta.11.

Relateret indhold

  • Last updated on