Items - Refresh Sql Endpoint Metadata

Service:

SQLEndpoint

API Version:

v1

Note

This Preview API is experimental and may change without notice. It is provided for evaluation and development only; production use is not recommended.

Refreshes all tables within a SQL analytics endpoint.
This API supports long running operations (LRO).

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

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

URI Parameters

Name	In	Required	Type	Description
sqlEndpointId	path	True	string (uuid)	The SQL analytics endpoint ID.
workspaceId	path	True	string (uuid)	The workspace ID.
preview	query	True	boolean	This required parameter must be set to true to access this API, which is currently in preview. It indicates that the caller acknowledges the API's experimental nature and accepts the possibility of breaking changes. Any other value or omission is currently not supported.

Request Body

Name	Type	Description
timeout	Duration	The request duration before timing out. The default value is 15 minutes.

Responses

Name	Type	Description
200 OK	TableSyncStatus[]	Request completed successfully.
202 Accepted		Request accepted, SQL analytics table refresh in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found.

Examples

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

Sample request

HTTP

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

Sample response

Status code:

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

Definitions

Name	Description
Duration	A duration.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
SqlEndpointRefreshMetadataRequest	Refresh SQL analaytics endpoint request payload.
SyncStatus	The status of the synchronization operation. Additional SyncStatus types may be added over time.
TableSyncStatus	A table synchronization status object.
TimeUnit	The unit of time for the duration. Additional duration types may be added over time.

Duration

Object

A duration.

Name	Type	Description
timeUnit	TimeUnit	The unit of time for the duration. Additional duration types may be added over time.
value	number	The number of timeUnits in the duration.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

SqlEndpointRefreshMetadataRequest

Object

Refresh SQL analaytics endpoint request payload.

Name	Type	Description
timeout	Duration	The request duration before timing out. The default value is 15 minutes.

SyncStatus

Enumeration

The status of the synchronization operation. Additional SyncStatus types may be added over time.

Value	Description
Failure	Indicates a failure.
NotRun	Indicates that the operation did not run.
Success	Indicates a success.

TableSyncStatus

Object

A table synchronization status object.

Name	Type	Description
endDateTime	string (date-time)	The date and time when the table synchronization completed in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
error	ErrorResponseDetails	The error response details
lastSuccessfulSyncDateTime	string (date-time)	The date and time when the table synchronization was successful in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
startDateTime	string (date-time)	The date and time when the table synchronization started in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
status	SyncStatus	Whether the table synchronized without errors.
tableName	string	The name of the table that synchronized.

TimeUnit

Enumeration

The unit of time for the duration. Additional duration types may be added over time.

Value	Description
Days	Duration in days.
Hours	Duration in hours.
Minutes	Duration in minutes.
Seconds	Duration in seconds.