Items - Refresh Sql Endpoint Metadata

服務:: SQLEndpoint

API 版本:: v1

重新整理 SQL 分析端點內的所有資料表。
此 API 支援長時間執行的作業（LRO）。

Permissions

呼叫者必須具有 參與者 或更高的工作區角色。

必要的委派範圍

Item.ReadWrite.All

Microsoft Entra 支援的身份識別

此 API 支援本節中列出的Microsoft 身分識別。

Identity	Support
User	Yes
服務主體和受控識別	Yes

Interface

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

URI 參數

名稱	位於	必要	類型	Description
sqlEndpointId	path	True	string (uuid)	SQL 分析端點識別碼。
workspaceId	path	True	string (uuid)	工作區識別碼。

要求本文

名稱	類型	Description
recreateTables	boolean	當設定為 true（true）時，此屬性指示系統在刷新過程中丟棄並重新建立 SQL 分析端點上的所有資料表。如果你需要從原始碼定義完全重建資料表，例如解決不一致或確保乾淨刷新，可以使用這個選項。預設值為 false。
timeout	Duration	逾時前的要求持續時間。預設值為15分鐘。

回應

名稱	類型	Description
200 OK	TableSyncStatuses	要求成功完成。
202 Accepted		要求已接受，SQL 分析數據表正在重新整理。標題 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	常見的錯誤碼： ItemNotFound - 找不到要求的專案。

名稱

類型

Description

200 OK

TableSyncStatuses

要求成功完成。

202 Accepted

要求已接受，SQL 分析數據表正在重新整理。

標題

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

Other Status Codes

ErrorResponse

常見的錯誤碼：

ItemNotFound - 找不到要求的專案。

範例

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

範例要求

HTTP

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

範例回覆

狀態碼:: 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"
    }
  ]
}

定義

名稱	Description
Duration	持續時間。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
SqlEndpointRefreshMetadataRequest	重新整理 SQL analaytics 端點要求承載。
SyncStatus	同步處理作業的狀態。可能會隨著時間新增其他 SyncStatus 類型。
TableSyncStatus	數據表同步處理狀態物件。
TableSyncStatuses	數據表同步處理狀態的清單。
TimeUnit	持續時間的時間單位。可能會隨著時間新增其他持續時間類型。

Duration

Object

持續時間。

名稱	類型	Description
timeUnit	TimeUnit	持續時間的時間單位。可能會隨著時間新增其他持續時間類型。
value	number	持續時間中的 timeUnits 數目。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱	類型	Description
resourceId	string	發生錯誤的資源識別碼。
resourceType	string	發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細數據的清單。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。
requestId	string	與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。

SqlEndpointRefreshMetadataRequest

Object

重新整理 SQL analaytics 端點要求承載。

名稱	類型	Description
recreateTables	boolean	當設定為 true（true）時，此屬性指示系統在刷新過程中丟棄並重新建立 SQL 分析端點上的所有資料表。如果你需要從原始碼定義完全重建資料表，例如解決不一致或確保乾淨刷新，可以使用這個選項。預設值為 false。
timeout	Duration	逾時前的要求持續時間。預設值為15分鐘。

SyncStatus

列舉型別

同步處理作業的狀態。可能會隨著時間新增其他 SyncStatus 類型。

值	Description
Success	表示成功。
Failure	表示失敗。
NotRun	表示作業未執行。

TableSyncStatus

Object

數據表同步處理狀態物件。

名稱	類型	Description
endDateTime	string (date-time)	使用YYYY-MM-DDTHH：mm：ssZ格式，以UTC完成數據表同步處理的日期和時間。
error	ErrorResponseDetails	錯誤回應詳細數據
lastSuccessfulSyncDateTime	string (date-time)	使用YYYY-MM-DDTHH：mm：ssZ格式的數據表同步處理成功時的日期和時間。
startDateTime	string (date-time)	使用YYYY-MM-DDTHH：mm：ssZ格式啟動資料表同步處理的日期和時間。
status	SyncStatus	數據表是否同步處理，而不會發生錯誤。
tableName	string	同步處理之數據表的名稱。

TableSyncStatuses

Object

數據表同步處理狀態的清單。

名稱	類型	Description
value	TableSyncStatus[]	數據表同步處理狀態的清單。

TimeUnit

列舉型別

持續時間的時間單位。可能會隨著時間新增其他持續時間類型。

值	Description
Seconds	持續時間以秒為單位。
Minutes	以分鐘為單位的持續時間。
Hours	以小時為單位的持續時間。
Days	以天為單位的持續時間。

共用方式為

Items - Refresh Sql Endpoint Metadata

Permissions

必要的委派範圍

Microsoft Entra 支援的身份識別

Interface

URI 參數

要求本文

回應

範例

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

範例要求

範例回覆

定義

Duration

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

SqlEndpointRefreshMetadataRequest

SyncStatus

TableSyncStatus

TableSyncStatuses

TimeUnit