Items - Refresh Sql Endpoint Metadata

Usługa:: SQLEndpoint

Wersja API:: v1

Odświeża wszystkie tabele w punkcie końcowym analizy SQL.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Permissions

Obiekt wywołujący musi mieć rolę współautora lub nowszego obszaru roboczego.

Wymagane zakresy delegowane

Item.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity	Support
User	Yes
Główne usługi i Tożsamości zarządzane	Yes

Interface

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
sqlEndpointId	path	True	string (uuid)	Identyfikator punktu końcowego analizy SQL.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.

Ciało żądania

Nazwa	Typ	Opis
recreateTables	boolean	Po ustawieniu wartości true ta właściwość nakazuje systemowi usunięcie i ponowne utworzenie wszystkich tabel w punkcie końcowym analizy SQL podczas procesu odświeżania. Użyj tej opcji, jeśli chcesz w pełni skompilować tabele z ich definicji źródłowych, na przykład w celu rozwiązania niespójności lub zapewnienia czystego odświeżania. Wartość domyślna to fałsz.
timeout	Duration	Czas trwania żądania przed upływem limitu czasu. Wartość domyślna to 15 minut.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TableSyncStatuses	Żądanie zostało ukończone pomyślnie.
202 Accepted		Żądanie zaakceptowane, trwa odświeżanie tabeli sql analytics. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: ItemNotFound — żądany element nie został znaleziony.

Nazwa

Typ

Opis

200 OK

TableSyncStatuses

Żądanie zostało ukończone pomyślnie.

202 Accepted

Żądanie zaakceptowane, trwa odświeżanie tabeli sql analytics.

Nagłówki

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

ItemNotFound — żądany element nie został znaleziony.

Przykłady

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

Przykładowa prośba

HTTP

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

Przykładowa odpowiedź

Kod statusu:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
Duration	Czas trwania.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
SqlEndpointRefreshMetadataRequest	Odśwież ładunek żądania punktu końcowego analizy SQL.
SyncStatus	Stan operacji synchronizacji. Dodatkowe typy SyncStatus można dodawać w czasie.
TableSyncStatus	Obiekt stanu synchronizacji tabeli.
TableSyncStatuses	Lista stanów synchronizacji tabel.
TimeUnit	Jednostka czasu na czas trwania. Dodatkowe typy czasu trwania mogą być dodawane w czasie.

Duration

Sprzeciwiać się

Czas trwania.

Nazwa	Typ	Opis
timeUnit	TimeUnit	Jednostka czasu na czas trwania. Dodatkowe typy czasu trwania mogą być dodawane w czasie.
value	number	Liczba elementów timeUnits w czasie trwania.

ErrorRelatedResource

Sprzeciwiać się

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Sprzeciwiać się

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

SqlEndpointRefreshMetadataRequest

Sprzeciwiać się

Odśwież ładunek żądania punktu końcowego analizy SQL.

Nazwa	Typ	Opis
recreateTables	boolean	Po ustawieniu wartości true ta właściwość nakazuje systemowi usunięcie i ponowne utworzenie wszystkich tabel w punkcie końcowym analizy SQL podczas procesu odświeżania. Użyj tej opcji, jeśli chcesz w pełni skompilować tabele z ich definicji źródłowych, na przykład w celu rozwiązania niespójności lub zapewnienia czystego odświeżania. Wartość domyślna to fałsz.
timeout	Duration	Czas trwania żądania przed upływem limitu czasu. Wartość domyślna to 15 minut.

SyncStatus

Wyliczenie

Stan operacji synchronizacji. Dodatkowe typy SyncStatus można dodawać w czasie.

Wartość	Opis
Success	Wskazuje powodzenie.
Failure	Wskazuje błąd.
NotRun	Wskazuje, że operacja nie została uruchomiona.

TableSyncStatus

Sprzeciwiać się

Obiekt stanu synchronizacji tabeli.

Nazwa	Typ	Opis
endDateTime	string (date-time)	Data i godzina zakończenia synchronizacji tabeli w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
error	ErrorResponseDetails	Szczegóły odpowiedzi na błąd
lastSuccessfulSyncDateTime	string (date-time)	Data i godzina pomyślnej synchronizacji tabeli w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
startDateTime	string (date-time)	Data i godzina rozpoczęcia synchronizacji tabeli w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
status	SyncStatus	Określa, czy tabela została zsynchronizowana bez błędów.
tableName	string	Nazwa zsynchronizowanej tabeli.

TableSyncStatuses

Sprzeciwiać się

Lista stanów synchronizacji tabel.

Nazwa	Typ	Opis
value	TableSyncStatus[]	Lista stanów synchronizacji tabel.

TimeUnit

Wyliczenie

Jednostka czasu na czas trwania. Dodatkowe typy czasu trwania mogą być dodawane w czasie.

Wartość	Opis
Seconds	Czas trwania w sekundach.
Minutes	Czas trwania w minutach.
Hours	Czas trwania w godzinach.
Days	Czas trwania w dniach.

Udostępnij przez

Items - Refresh Sql Endpoint Metadata

Permissions

Wymagane zakresy delegowane

Tożsamości obsługiwane przez Microsoft Entra

Interface

Parametry URI

Ciało żądania

Odpowiedzi

Przykłady

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

Przykładowa prośba

Przykładowa odpowiedź

Definicje

Duration

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

SqlEndpointRefreshMetadataRequest

SyncStatus

TableSyncStatus

TableSyncStatuses

TimeUnit