Items - Refresh Sql Endpoint Metadata

Dienst:
SQLEndpoint
API-Version:
v1

Aktualisiert Tabellen in einem SQL-Analyseendpunkt.
Diese API unterstützt LRO-.

Wenn tables im Anforderungstext angegeben wird, werden nur die angegebenen Tabellen aktualisiert. Wenn sie nicht angegeben oder leer sind, werden alle Tabellen aktualisiert.

Permissions

Der Anrufer muss Mitwirkender oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Item.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity Support
User Yes
Service Principal und Verwaltete Identitäten Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/refreshMetadata

URI-Parameter

Name In Erforderlich Typ Beschreibung
sqlEndpointId
 path True

string (uuid)

Die SQL-Analyseendpunkt-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.

Anforderungstext

Name Typ Beschreibung
recreateTables

boolean

Wenn diese Eigenschaft auf "true" festgelegt ist, weist diese Eigenschaft das System an, während des Aktualisierungsprozesses alle Tabellen auf dem SQL-Analyseendpunkt abzulegen und neu zu erstellen. Verwenden Sie diese Option, wenn Sie Tabellen aus ihren Quelldefinitionen vollständig neu erstellen müssen, um z. B. Inkonsistenzen aufzulösen oder eine saubere Aktualisierung sicherzustellen. In Kombination mit tablesdem Synchronisierungsstatus wird die Zurücksetzung nur auf die angegebenen Tabellen festgelegt. Der Standardwert ist "false".
tables

TableDefinition[]

Wenn angegeben, wird die Aktualisierung nur auf die aufgelisteten Tabellen festgelegt. Wenn sie nicht angegeben oder leer sind, werden alle Tabellen aktualisiert. Jeder Eintrag gibt ein Schema und einen oder mehrere Tabellennamen an, die unter diesem Schema aktualisiert werden sollen. Die maximale Anzahl von Tabellen, die in einer einzelnen Anforderung synchronisiert werden können, beträgt 25. Die Tabellenauflösung hängt davon ab, ob das übergeordnete Element des SQL-Endpunkts schemafähig ist. Bei schemafähigen Elementen werden Tabellen mithilfe des vom Aufrufer bereitgestellten Schemas aufgelöst. Bei nicht schemafähigen Elementen werden alle Tabellen unabhängig vom Aufrufer bereitgestellten Schemawert unter dem Standardschema aufgelöst; Tabellen unter einem nicht standardmäßigen Schema können nicht aufgelöst werden und werden mit einem DeltaTableNotFound Fehler gemeldet.
timeout

Duration

Die Anforderungsdauer vor dem Timeout. Der Standardwert beträgt 15 Minuten.

Antworten

Name Typ Beschreibung
200 OK

TableSyncStatuses

Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted

Anforderung akzeptiert, SQL Analytics-Tabellenaktualisierung wird ausgeführt.

Header

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • ItemNotFound – Das angeforderte Element wurde nicht gefunden.

Beispiele

Refresh all tables for a specified SQL analytics endpoint in a workspace
Refresh selective tables for a specified SQL analytics endpoint in a workspace
Refresh selective tables with recreate tables for a specified SQL analytics endpoint in a workspace
Refresh selective tables with user defined schemas for a specified SQL analytics endpoint in a workspace

Refresh all tables for a specified SQL analytics endpoint in a workspace

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlEndpoints/5b218778-e7a5-4d73-8187-f10824047715/refreshMetadata

Beispiel für eine Antwort

Statuscode:
200 
{
  "value": [
    {
      "tableName": "Table 1",
      "startDateTime": "2025-08-08T10:31:22.2708973Z",
      "endDateTime": "2025-08-08T10:36:54.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2025-08-08T10:36:54.9651741Z"
    },
    {
      "tableName": "Table 2",
      "startDateTime": "2025-08-08T10:31:22.2708973Z",
      "endDateTime": "2025-08-08T10:43:02.5329616Z",
      "status": "Failure",
      "error": {
        "errorCode": "AdalRetryException",
        "message": "Couldn't run query. There is a problem with the Microsoft Entra ID token. Have the warehouse owner log in again. If they're unavailable, use the takeover feature."
      },
      "lastSuccessfulSyncDateTime": "2025-08-07T10:44:27.2632648Z"
    },
    {
      "tableName": "Table 3",
      "startDateTime": "2025-08-08T10:31:22.2708973Z",
      "endDateTime": "2025-08-08T10:36:59.9183509Z",
      "status": "NotRun",
      "lastSuccessfulSyncDateTime": "2025-08-06T08:32:53.3890146Z"
    }
  ]
}

Refresh selective tables for a specified SQL analytics endpoint in a workspace

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlEndpoints/5b218778-e7a5-4d73-8187-f10824047715/refreshMetadata

{
  "tables": [
    {
      "schema": "dbo",
      "tableNames": [
        "Orders",
        "OrderDetails"
      ]
    },
    {
      "schema": "dbo",
      "tableNames": [
        "DailySummary"
      ]
    }
  ]
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "value": [
    {
      "tableName": "Orders",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:25.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
    },
    {
      "tableName": "OrderDetails",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:26.5329616Z",
      "status": "Failure",
      "error": {
        "errorCode": "DeltaTableNotFound",
        "message": "Delta table 'Tables\\OrderDetails\\_delta_log' not found."
      },
      "lastSuccessfulSyncDateTime": "2026-06-08T10:31:26.5329616Z"
    },
    {
      "tableName": "DailySummary",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:24.9183509Z",
      "status": "NotRun",
      "lastSuccessfulSyncDateTime": "2026-06-08T08:32:53.3890146Z"
    }
  ]
}

Refresh selective tables with recreate tables for a specified SQL analytics endpoint in a workspace

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlEndpoints/5b218778-e7a5-4d73-8187-f10824047715/refreshMetadata

{
  "recreateTables": true,
  "tables": [
    {
      "schema": "dbo",
      "tableNames": [
        "Orders",
        "OrderDetails"
      ]
    }
  ]
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "value": [
    {
      "tableName": "Orders",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:25.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
    },
    {
      "tableName": "OrderDetails",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:26.5329616Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:26.5329616Z"
    }
  ]
}

Refresh selective tables with user defined schemas for a specified SQL analytics endpoint in a workspace

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlEndpoints/5b218778-e7a5-4d73-8187-f10824047715/refreshMetadata

{
  "tables": [
    {
      "schema": "sales",
      "tableNames": [
        "Orders",
        "OrderDetails"
      ]
    },
    {
      "schema": "analytics",
      "tableNames": [
        "DailySummary"
      ]
    }
  ]
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "value": [
    {
      "tableName": "sales.Orders",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:25.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
    },
    {
      "tableName": "sales.OrderDetails",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:26.5329616Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:26.5329616Z"
    },
    {
      "tableName": "analytics.DailySummary",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:24.9183509Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:24.9183509Z"
    }
  ]
}

Definitionen

Name Beschreibung
Duration

Eine Dauer.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
SqlEndpointRefreshMetadataRequest

Die Anforderungsnutzlast zum Aktualisieren eines SQL-Analyseendpunkts.
SyncStatus

Der Status des Synchronisierungsvorgangs. Zusätzliche SyncStatus-Typen können im Laufe der Zeit hinzugefügt werden.
TableDefinition

Ein Paar von Schema- und Tabellennamen für die Bereichsdefinition einer selektiven Aktualisierung.
TableSyncStatus

Ein Tabellensynchronisierungsstatusobjekt.
TableSyncStatuses

Eine Liste der Tabellensynchronisierungsstatus.
TimeUnit

Die Zeiteinheit für die Dauer. Zusätzliche Dauertypen können im Laufe der Zeit hinzugefügt werden.

Duration

Objekt

Eine Dauer.

Name Typ Beschreibung
timeUnit

TimeUnit

Die Zeiteinheit für die Dauer. Zusätzliche Dauertypen können im Laufe der Zeit hinzugefügt werden.
value

number

Die Anzahl der timeUnits in der Dauer.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
isRetriable

boolean

Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den Retry-After Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string (uuid)

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

SqlEndpointRefreshMetadataRequest

Objekt

Die Anforderungsnutzlast zum Aktualisieren eines SQL-Analyseendpunkts.

Name Typ Beschreibung
recreateTables

boolean

Wenn diese Eigenschaft auf "true" festgelegt ist, weist diese Eigenschaft das System an, während des Aktualisierungsprozesses alle Tabellen auf dem SQL-Analyseendpunkt abzulegen und neu zu erstellen. Verwenden Sie diese Option, wenn Sie Tabellen aus ihren Quelldefinitionen vollständig neu erstellen müssen, um z. B. Inkonsistenzen aufzulösen oder eine saubere Aktualisierung sicherzustellen. In Kombination mit tablesdem Synchronisierungsstatus wird die Zurücksetzung nur auf die angegebenen Tabellen festgelegt. Der Standardwert ist "false".
tables

TableDefinition[]

Wenn angegeben, wird die Aktualisierung nur auf die aufgelisteten Tabellen festgelegt. Wenn sie nicht angegeben oder leer sind, werden alle Tabellen aktualisiert. Jeder Eintrag gibt ein Schema und einen oder mehrere Tabellennamen an, die unter diesem Schema aktualisiert werden sollen. Die maximale Anzahl von Tabellen, die in einer einzelnen Anforderung synchronisiert werden können, beträgt 25. Die Tabellenauflösung hängt davon ab, ob das übergeordnete Element des SQL-Endpunkts schemafähig ist. Bei schemafähigen Elementen werden Tabellen mithilfe des vom Aufrufer bereitgestellten Schemas aufgelöst. Bei nicht schemafähigen Elementen werden alle Tabellen unabhängig vom Aufrufer bereitgestellten Schemawert unter dem Standardschema aufgelöst; Tabellen unter einem nicht standardmäßigen Schema können nicht aufgelöst werden und werden mit einem DeltaTableNotFound Fehler gemeldet.
timeout

Duration

Die Anforderungsdauer vor dem Timeout. Der Standardwert beträgt 15 Minuten.

SyncStatus

Enumeration

Der Status des Synchronisierungsvorgangs. Zusätzliche SyncStatus-Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Success

Gibt einen Erfolg an.
Failure

Gibt einen Fehler an.
NotRun

Gibt an, dass der Vorgang nicht ausgeführt wurde.

TableDefinition

Objekt

Ein Paar von Schema- und Tabellennamen für die Bereichsdefinition einer selektiven Aktualisierung.

Name Typ Beschreibung
schema

string

minLength: 1
maxLength: 128

Der Schemaname für die Tabellenauflösung. Darf kein reserviertes Systemschema sein.
tableNames

string[]

minLength: 1
maxLength: 128

Mindestens ein Tabellenname, der unter dem angegebenen Schema aktualisiert werden soll.

TableSyncStatus

Objekt

Ein Tabellensynchronisierungsstatusobjekt.

Name Typ Beschreibung
endDateTime

string (date-time)

Datum und Uhrzeit, zu dem die Tabellensynchronisierung in UTC abgeschlossen wurde, mithilfe des JJJJ-MM-TTTHH:mm:ssZ-Formats.
error

ErrorResponseDetails

Die Fehlerantwortdetails
lastSuccessfulSyncDateTime

string (date-time)

Datum und Uhrzeit, zu dem die Tabellensynchronisierung in UTC erfolgreich war, mit dem Format JJJJ-MM-DDTHH:mm:ssZ.
startDateTime

string (date-time)

Datum und Uhrzeit, zu dem die Tabellensynchronisierung in UTC gestartet wurde, mit dem Format JJJJ-MM-TTTHH:mm:ssZ.
status

SyncStatus

Gibt an, ob die Tabelle ohne Fehler synchronisiert wurde.
tableName

string

Der Name der Tabelle, die synchronisiert wurde. Bei schemafähigen Elementen wird der Tabellenname dem Schemanamen vorangestellt (z. B. "schema.tableName").

TableSyncStatuses

Objekt

Eine Liste der Tabellensynchronisierungsstatus.

Name Typ Beschreibung
value

TableSyncStatus[]

Eine Liste der Tabellensynchronisierungsstatus.

TimeUnit

Enumeration

Die Zeiteinheit für die Dauer. Zusätzliche Dauertypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Seconds

Dauer in Sekunden.
Minutes

Dauer in Minuten.
Hours

Dauer in Stunden.
Days

Dauer in Tagen.