Items - Refresh Sql Endpoint Metadata

Dienst:: SQLEndpoint

API-Version:: v1

Aktualisiert alle Tabellen innerhalb eines SQL-Analyseendpunkts.
Diese API unterstützt LRO-.

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 am SQL-Analyseendpunkt abzulegen und neu zu erstellen. Verwenden Sie diese Option, wenn Sie Tabellen aus ihren Quelldefinitionen vollständig neu erstellen müssen, z. B. um Inkonsistenzen aufzulösen oder eine saubere Aktualisierung sicherzustellen. Der Standardwert ist "false".
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
Other Status Codes	ErrorResponse	Häufige Fehlercodes: ItemNotFound – Das angeforderte Element wurde nicht gefunden.

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

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

Beispielanforderung

HTTP

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

Definitionen

Name	Beschreibung
Duration	Eine Dauer.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
SqlEndpointRefreshMetadataRequest	Aktualisieren Sie die NUTZLAST der SQL-Analaytics-Endpunktanforderung.
SyncStatus	Der Status des Synchronisierungsvorgangs. Zusätzliche SyncStatus-Typen können im Laufe der Zeit hinzugefügt werden.
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.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	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

Aktualisieren Sie die NUTZLAST der SQL-Analaytics-Endpunktanforderung.

Name	Typ	Beschreibung
recreateTables	boolean	Wenn diese Eigenschaft auf "true" festgelegt ist, weist diese Eigenschaft das System an, während des Aktualisierungsprozesses alle Tabellen am SQL-Analyseendpunkt abzulegen und neu zu erstellen. Verwenden Sie diese Option, wenn Sie Tabellen aus ihren Quelldefinitionen vollständig neu erstellen müssen, z. B. um Inkonsistenzen aufzulösen oder eine saubere Aktualisierung sicherzustellen. Der Standardwert ist "false".
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.

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.

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.

Freigeben über

Items - Refresh Sql Endpoint Metadata

Permissions

Erforderliche delegierte Bereiche

Von Microsoft Entra unterstützte Identitäten

Interface

URI-Parameter

Anforderungstext

Antworten

Beispiele

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

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Duration

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

SqlEndpointRefreshMetadataRequest

SyncStatus

TableSyncStatus

TableSyncStatuses

TimeUnit