Items - Refresh Sql Endpoint Metadata

Servizio:

SQLEndpoint

Versione API:

v1

Annotazioni

Questa API di anteprima è sperimentale e può cambiare senza preavviso. Viene fornito solo per la valutazione e lo sviluppo; l'uso di produzione non è consigliato.

Aggiorna tutte le tabelle all'interno di un endpoint di analisi SQL.
Questa API supporta operazioni con esecuzione prolungata (LRO).

Autorizzazioni

Il chiamante deve avere ruolo collaboratore o superiore dell'area di lavoro.

Ambiti delegati obbligatori

Elemento.LeggiScrivi.Tutto

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Assistenza
Utente	Sì
Principale del servizio e Identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
sqlEndpointId	path	True	string (uuid)	ID endpoint di analisi SQL.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
preview	query	True	boolean	Questo parametro obbligatorio deve essere impostato su per accedere a true questa API, attualmente in anteprima. Indica che il chiamante riconosce la natura sperimentale dell'API e accetta la possibilità di apportare modifiche di rilievo. Qualsiasi altro valore o omissione non è attualmente supportato.

Corpo della richiesta

Nome	Tipo	Descrizione
timeout	Duration	Durata della richiesta prima del timeout. Il valore predefinito è 15 minuti.

Risposte

Nome	Tipo	Descrizione
200 OK	TableSyncStatus[]	Richiesta completata correttamente.
202 Accepted		Richiesta accettata, aggiornamento della tabella di analisi SQL in corso. Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: ItemNotFound: l'elemento richiesto non è stato trovato.

Esempio

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

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

200

[
  {
    "tableName": "Table 1",
    "startDateTime": "2025-02-04T22:29:12.4400865Z",
    "endDateTime": "2025-02-04T22:29:12.4869641Z",
    "status": "Success",
    "lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
  },
  {
    "tableName": "Table 2",
    "startDateTime": "2025-02-04T22:29:13.4400865Z",
    "endDateTime": "2025-02-04T22:29:13.4869641Z",
    "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": "2024-07-23T14:28:23.1864319Z"
  },
  {
    "tableName": "Table 3",
    "startDateTime": "2025-02-04T22:29:14.4400865Z",
    "endDateTime": "2025-02-04T22:29:14.4869641Z",
    "status": "NotRun",
    "lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
  }
]

Definizioni

Nome	Descrizione
Duration	Durata.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
SqlEndpointRefreshMetadataRequest	Aggiornare il payload della richiesta dell'endpoint analaytics sql.
SyncStatus	Stato dell'operazione di sincronizzazione. È possibile aggiungere altri tipi SyncStatus nel tempo.
TableSyncStatus	Oggetto stato sincronizzazione tabella.
TimeUnit	Unità di tempo per la durata. È possibile aggiungere tipi di durata aggiuntivi nel tempo.

Duration

Object

Durata.

Nome	Tipo	Descrizione
timeUnit	TimeUnit	Unità di tempo per la durata. È possibile aggiungere tipi di durata aggiuntivi nel tempo.
value	number	Numero di timeUnits nella durata.

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string	ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

SqlEndpointRefreshMetadataRequest

Object

Aggiornare il payload della richiesta dell'endpoint analaytics sql.

Nome	Tipo	Descrizione
timeout	Duration	Durata della richiesta prima del timeout. Il valore predefinito è 15 minuti.

SyncStatus

Enumerazione

Stato dell'operazione di sincronizzazione. È possibile aggiungere altri tipi SyncStatus nel tempo.

Valore	Descrizione
Failure	Indica un errore.
NotRun	Indica che l'operazione non è stata eseguita.
Success	Indica un esito positivo.

TableSyncStatus

Object

Oggetto stato sincronizzazione tabella.

Nome	Tipo	Descrizione
endDateTime	string (date-time)	Data e ora in cui la sincronizzazione della tabella è stata completata in formato UTC, utilizzando il formato AAAA-MM-GGTHH:mm:ssZ.
error	ErrorResponseDetails	Dettagli della risposta di errore
lastSuccessfulSyncDateTime	string (date-time)	Data e ora in cui la sincronizzazione della tabella ha avuto esito positivo in formato UTC, utilizzando il formato AAAA-MM-GGTHH:mm:ssZ.
startDateTime	string (date-time)	Data e ora di inizio della sincronizzazione della tabella in formato UTC, utilizzando il formato AAAA-MM-GGTHH:mm:ssZ.
status	SyncStatus	Indica se la tabella è sincronizzata senza errori.
tableName	string	Nome della tabella sincronizzata.

TimeUnit

Enumerazione

Unità di tempo per la durata. È possibile aggiungere tipi di durata aggiuntivi nel tempo.

Valore	Descrizione
Days	Durata in giorni.
Hours	Durata in ore.
Minutes	Durata in minuti.
Seconds	Durata in secondi.