Items - Refresh Sql Endpoint Metadata

Service:: SQLEndpoint

Version d’API:: v1

Actualise les tables au sein d’un point de terminaison d’analyse SQL.
Cette API prend en charge opérations longues (LRO).

Lorsqu’elle tables est fournie dans le corps de la demande, seules les tables spécifiées sont actualisées. En cas d’omission ou de vide, toutes les tables sont actualisées.

Permissions

L’appelant doit avoir rôle de contributeur ou supérieur.

Étendues déléguées requises

Item.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identity	Support
User	Yes
Service principal et identités gérées	Yes

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
sqlEndpointId	path	True	string (uuid)	ID de point de terminaison d’analytique SQL.
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.

Corps de la demande

Nom	Type	Description
recreateTables	boolean	Lorsqu’elle est définie sur true, cette propriété indique au système de supprimer et de recréer toutes les tables sur le point de terminaison d’analyse SQL pendant le processus d’actualisation. Utilisez cette option si vous devez reconstruire entièrement les tables à partir de leurs définitions sources, par exemple pour résoudre les incohérences ou garantir une actualisation propre. En cas de combinaison avec `tables`, la réinitialisation de l’état de synchronisation est limitée uniquement aux tables spécifiées. La valeur par défaut est false.
tables	TableDefinition[]	Lorsqu’elle est fournie, l’actualisation est limitée aux tables répertoriées uniquement. En cas d’omission ou de vide, toutes les tables sont actualisées. Chaque entrée spécifie un schéma et un ou plusieurs noms de tables à actualiser sous ce schéma. Le nombre maximal de tables pouvant être synchronisées dans une requête unique est de 25. La résolution de table dépend du fait que l’élément parent du point de terminaison SQL est activé par le schéma. Pour les éléments compatibles avec le schéma, les tables sont résolues à l’aide du schéma fourni par l’appelant. Pour les éléments non compatibles avec le schéma, toutes les tables sont résolues sous le schéma par défaut, quelle que soit la valeur de schéma fournie par l’appelant ; les tables sous un schéma non par défaut ne peuvent pas être résolues et sont signalées avec une `DeltaTableNotFound` erreur.
timeout	Duration	Durée de la demande avant expiration du délai d’attente. La valeur par défaut est de 15 minutes.

Réponses

Nom	Type	Description
200 OK	TableSyncStatuses	La demande s’est terminée avec succès.
202 Accepted		Demande acceptée, actualisation de la table d’analyse SQL en cours. En-têtes Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : ItemNotFound : l’élément demandé n’a pas été trouvé.

Exemples

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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
Duration	Durée.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
SqlEndpointRefreshMetadataRequest	Charge utile de la requête pour actualiser un point de terminaison d’analytique SQL.
SyncStatus	État de l’opération de synchronisation. Des types SyncStatus supplémentaires peuvent être ajoutés au fil du temps.
TableDefinition	Paire de noms de schéma et de table pour l’étendue d’une actualisation sélective.
TableSyncStatus	Objet d’état de synchronisation de table.
TableSyncStatuses	Liste des états de synchronisation des tables.
TimeUnit	Unité de temps pour la durée. Des types de durée supplémentaires peuvent être ajoutés au fil du temps.

Duration

Objet

Durée.

Nom	Type	Description
timeUnit	TimeUnit	Unité de temps pour la durée. Des types de durée supplémentaires peuvent être ajoutés au fil du temps.
value	number	Nombre d’unités de temps dans la durée.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
isRetriable	boolean	Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête `Retry-After` de réponse pour déterminer le délai, le cas échéant.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string (uuid)	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

SqlEndpointRefreshMetadataRequest

Objet

Charge utile de la requête pour actualiser un point de terminaison d’analytique SQL.

Nom	Type	Description
recreateTables	boolean	Lorsqu’elle est définie sur true, cette propriété indique au système de supprimer et de recréer toutes les tables sur le point de terminaison d’analyse SQL pendant le processus d’actualisation. Utilisez cette option si vous devez reconstruire entièrement les tables à partir de leurs définitions sources, par exemple pour résoudre les incohérences ou garantir une actualisation propre. En cas de combinaison avec `tables`, la réinitialisation de l’état de synchronisation est limitée uniquement aux tables spécifiées. La valeur par défaut est false.
tables	TableDefinition[]	Lorsqu’elle est fournie, l’actualisation est limitée aux tables répertoriées uniquement. En cas d’omission ou de vide, toutes les tables sont actualisées. Chaque entrée spécifie un schéma et un ou plusieurs noms de tables à actualiser sous ce schéma. Le nombre maximal de tables pouvant être synchronisées dans une requête unique est de 25. La résolution de table dépend du fait que l’élément parent du point de terminaison SQL est activé par le schéma. Pour les éléments compatibles avec le schéma, les tables sont résolues à l’aide du schéma fourni par l’appelant. Pour les éléments non compatibles avec le schéma, toutes les tables sont résolues sous le schéma par défaut, quelle que soit la valeur de schéma fournie par l’appelant ; les tables sous un schéma non par défaut ne peuvent pas être résolues et sont signalées avec une `DeltaTableNotFound` erreur.
timeout	Duration	Durée de la demande avant expiration du délai d’attente. La valeur par défaut est de 15 minutes.

SyncStatus

Énumération

État de l’opération de synchronisation. Des types SyncStatus supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Success	Indique une réussite.
Failure	Indique une défaillance.
NotRun	Indique que l’opération n’a pas été exécutée.

TableDefinition

Objet

Paire de noms de schéma et de table pour l’étendue d’une actualisation sélective.

Nom	Type	Description
schema	string minLength: 1 maxLength: 128	Nom du schéma pour la résolution de table. Ne doit pas être un schéma système réservé.
tableNames	string[] minLength: 1 maxLength: 128	Un ou plusieurs noms de tables à actualiser sous le schéma spécifié.

TableSyncStatus

Objet

Objet d’état de synchronisation de table.

Nom	Type	Description
endDateTime	string (date-time)	Date et heure de fin de la synchronisation de la table au format UTC à l’aide du format AAAA-MM-DDTHH :mm :ssZ.
error	ErrorResponseDetails	Détails de la réponse d’erreur
lastSuccessfulSyncDateTime	string (date-time)	Date et heure de réussite de la synchronisation de la table au format UTC à l’aide du format AAAA-MM-DDTHH :mm :ssZ.
startDateTime	string (date-time)	Date et heure de début de la synchronisation de table au format UTC à l’aide du format AAAA-MM-DDTHH :mm :ssZ.
status	SyncStatus	Indique si la table est synchronisée sans erreur.
tableName	string	Nom de la table qui a été synchronisée. Pour les éléments activés pour le schéma, le nom de la table est précédé du nom du schéma (par exemple, « schema.tableName »).

TableSyncStatuses

Objet

Liste des états de synchronisation des tables.

Nom	Type	Description
value	TableSyncStatus[]	Liste des états de synchronisation des tables.

TimeUnit

Énumération

Unité de temps pour la durée. Des types de durée supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Seconds	Durée en secondes.
Minutes	Durée en minutes.
Hours	Durée en heures.
Days	Durée en jours.