次の方法で共有

Items - Refresh Sql Endpoint Metadata

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

注

このプレビュー API は試験段階であり、予告なく変更される可能性があります。 これは、評価と開発のためにのみ提供されています。運用環境での使用はお勧めしません。

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

権限

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

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

Item.ReadWrite.All

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

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

アイデンティティ 支援
ユーザー イエス
サービス プリンシパルとマネージド ID イエス

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
sqlEndpointId
 path True

string (uuid)

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

string (uuid)

ワークスペース ID。
preview
 query True

boolean

この API にアクセスするには、この必須パラメーターを true に設定する必要があります。これは現在プレビュー段階です。 これは、呼び出し元が API の実験的性質を認識し、破壊的変更の可能性を受け入れることを示します。 その他の値または省略は現在サポートされていません。

要求本文

名前 型 説明
timeout

Duration

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

応答

名前 型 説明
200 OK

TableSyncStatus[]

要求は正常に完了しました。
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

要求のサンプル

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

応答のサンプル

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

定義

名前 説明
Duration

期間。
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
SqlEndpointRefreshMetadataRequest

SQL 分析エンドポイント要求ペイロードを更新します。
SyncStatus

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

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

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

Duration

Object

期間。

名前 型 説明
timeUnit

TimeUnit

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

number

期間の timeUnits の数。

ErrorRelatedResource

Object

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

名前 型 説明
resourceId

string

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

string

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

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

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

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

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

string

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

ErrorRelatedResource

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

SqlEndpointRefreshMetadataRequest

Object

SQL 分析エンドポイント要求ペイロードを更新します。

名前 型 説明
timeout

Duration

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

SyncStatus

列挙

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

値 説明
Failure

エラーを示します。
NotRun

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

成功を示します。

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

同期されたテーブルの名前。

TimeUnit

列挙

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

値 説明
Days

期間 (日数)。
Hours

時間単位の期間。
Minutes

期間 (分)。
Seconds

秒単位の期間。