Items - Refresh Sql Endpoint Metadata

サービス:
SQLEndpoint
API バージョン:
v1

SQL 分析エンドポイント内のテーブルを更新します。
この API は、実行時間の長い操作 (LRO)をサポートします。

要求本文で tables が指定されると、指定されたテーブルのみが更新されます。 省略または空の場合、すべてのテーブルが更新されます。

Permissions

呼び出し元には、共同作成者 以上のワークスペース ロールが必要です。

必要な委任されたスコープ

Item.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

Identity Support
User Yes
サービス プリンシパルとマネージド ID Yes

Interface

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

URI パラメーター

名前 / 必須 型 説明
sqlEndpointId
 path True

string (uuid)

SQL 分析エンドポイント ID。
workspaceId
 path True

string (uuid)

ワークスペース ID。

要求本文

名前 型 説明
recreateTables

boolean

true に設定すると、このプロパティは、更新プロセス中に SQL 分析エンドポイント上のすべてのテーブルを削除して再作成するようにシステムに指示します。 このオプションは、ソース定義からテーブルを完全に再構築する必要がある場合に使用します。たとえば、不整合を解決したり、クリーンな更新を行ったりする必要があります。 tablesと組み合わせると、同期状態のリセットのスコープは、指定したテーブルのみに限定されます。 既定値は false です。
tables

TableDefinition[]

指定した場合、更新のスコープは、一覧に示されているテーブルのみに限定されます。 省略または空の場合、すべてのテーブルが更新されます。 各エントリは、スキーマと、そのスキーマの下で更新する 1 つ以上のテーブル名を指定します。 1 つの要求で同期できるテーブルの最大数は 25 です。 テーブル解決は、SQL エンドポイントの親項目がスキーマ対応かどうかによって異なります。 スキーマが有効な項目の場合、テーブルは呼び出し元が指定したスキーマを使用して解決されます。 スキーマが有効でない項目の場合、呼び出し元が指定したスキーマ値に関係なく、すべてのテーブルが既定のスキーマで解決されます。既定以外のスキーマのテーブルは解決できず、 DeltaTableNotFound エラーで報告されます。
timeout

Duration

タイムアウトするまでの要求期間。既定値は 15 分です。

応答

名前 型 説明
200 OK

TableSyncStatuses

要求は正常に完了しました。
202 Accepted

要求が受け入れられ、SQL 分析テーブルの更新が進行中です。

ヘッダー

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • ItemNotFound - 要求された項目が見つかりませんでした。

例

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

要求のサンプル

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

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

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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"
    }
  ]
}

定義

名前 説明
Duration

期間。
ErrorRelatedResource

エラー関連のリソース詳細オブジェクト。
ErrorResponse

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
SqlEndpointRefreshMetadataRequest

SQL 分析エンドポイントを更新するための要求ペイロード。
SyncStatus

同期操作の状態。 追加の SyncStatus 型は、時間の経過と同時に追加される場合があります。
TableDefinition

選択的更新のスコープを設定するためのスキーマとテーブル名のペア。
TableSyncStatus

テーブル同期状態オブジェクト。
TableSyncStatuses

テーブル同期の状態の一覧。
TimeUnit

期間の時間の単位。 期間の種類は、時間の経過と同時に追加される場合があります。

Duration

Object

期間。

名前 型 説明
timeUnit

TimeUnit

期間の時間の単位。 期間の種類は、時間の経過と同時に追加される場合があります。
value

number

期間の timeUnits の数。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前 型 説明
resourceId

string

エラーに関係するリソース ID。
resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
isRetriable

boolean

true の場合、要求を再試行できます。 Retry-After応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。
message

string

エラーの人間が判読できる表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。
requestId

string (uuid)

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。

SqlEndpointRefreshMetadataRequest

Object

SQL 分析エンドポイントを更新するための要求ペイロード。

名前 型 説明
recreateTables

boolean

true に設定すると、このプロパティは、更新プロセス中に SQL 分析エンドポイント上のすべてのテーブルを削除して再作成するようにシステムに指示します。 このオプションは、ソース定義からテーブルを完全に再構築する必要がある場合に使用します。たとえば、不整合を解決したり、クリーンな更新を行ったりする必要があります。 tablesと組み合わせると、同期状態のリセットのスコープは、指定したテーブルのみに限定されます。 既定値は false です。
tables

TableDefinition[]

指定した場合、更新のスコープは、一覧に示されているテーブルのみに限定されます。 省略または空の場合、すべてのテーブルが更新されます。 各エントリは、スキーマと、そのスキーマの下で更新する 1 つ以上のテーブル名を指定します。 1 つの要求で同期できるテーブルの最大数は 25 です。 テーブル解決は、SQL エンドポイントの親項目がスキーマ対応かどうかによって異なります。 スキーマが有効な項目の場合、テーブルは呼び出し元が指定したスキーマを使用して解決されます。 スキーマが有効でない項目の場合、呼び出し元が指定したスキーマ値に関係なく、すべてのテーブルが既定のスキーマで解決されます。既定以外のスキーマのテーブルは解決できず、 DeltaTableNotFound エラーで報告されます。
timeout

Duration

タイムアウトするまでの要求期間。既定値は 15 分です。

SyncStatus

列挙

同期操作の状態。 追加の SyncStatus 型は、時間の経過と同時に追加される場合があります。

値 説明
Success

成功を示します。
Failure

エラーを示します。
NotRun

操作が実行されなかったことを示します。

TableDefinition

Object

選択的更新のスコープを設定するためのスキーマとテーブル名のペア。

名前 型 説明
schema

string

minLength: 1
maxLength: 128

テーブル解決のスキーマ名。 予約済みシステム スキーマにすることはできません。
tableNames

string[]

minLength: 1
maxLength: 128

指定したスキーマで更新する 1 つ以上のテーブル名。

TableSyncStatus

Object

テーブル同期状態オブジェクト。

名前 型 説明
endDateTime

string (date-time)

YYYY-MM-DDTHH:mm:ssZ 形式を使用して、テーブルの同期が UTC で完了した日時。
error

ErrorResponseDetails

エラー応答の詳細
lastSuccessfulSyncDateTime

string (date-time)

YYYY-MM-DDTHH:mm:ssZ 形式を使用して、テーブルの同期が UTC で成功した日時。
startDateTime

string (date-time)

YYYY-MM-DDTHH:mm:ssZ 形式を使用して、テーブルの同期が UTC で開始された日時。
status

SyncStatus

テーブルがエラーなしで同期されたかどうか。
tableName

string

同期されたテーブルの名前。 スキーマが有効な項目の場合、テーブル名の前にスキーマ名 ("schema.tableName" など) が付きます。

TableSyncStatuses

Object

テーブル同期の状態の一覧。

名前 型 説明
value

TableSyncStatus[]

テーブル同期の状態の一覧。

TimeUnit

列挙

期間の時間の単位。 期間の種類は、時間の経過と同時に追加される場合があります。

値 説明
Seconds

秒単位の期間。
Minutes

期間 (分)。
Hours

時間単位の期間。
Days

期間 (日数)。