Items - Refresh Sql Endpoint Metadata

Layanan:: SQLEndpoint

Versi API:: v1

Merefresh semua tabel dalam titik akhir analitik SQL.
API ini mendukung operasi jangka panjang (LRO).

Permissions

Pemanggil harus memiliki kontributor atau peran ruang kerja yang lebih tinggi.

Cakupan yang Didelegasikan yang Diperlukan

Item.ReadWrite.All

Identitas yang didukung oleh Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identity	Support
User	Yes
Prinsipal Layanan dan Identitas Terkelola	Yes

Interface

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
sqlEndpointId	path	True	string (uuid)	ID titik akhir analitik SQL.
workspaceId	path	True	string (uuid)	ID ruangkerja.

Isi Permintaan

Nama	Jenis	Deskripsi
recreateTables	boolean	Ketika diatur ke true, properti ini menginstruksikan sistem untuk menghilangkan dan membuat ulang semua tabel pada titik akhir analitik SQL selama proses refresh. Gunakan opsi ini jika Anda perlu sepenuhnya membangun ulang tabel dari definisi sumbernya, misalnya untuk mengatasi inkonsistensi atau memastikan refresh bersih. Nilai defaultnya adalah false.
timeout	Duration	Durasi permintaan sebelum waktu habis. Nilai defaultnya adalah 15 menit.

Respons

Nama	Jenis	Deskripsi
200 OK	TableSyncStatuses	Permintaan berhasil diselesaikan.
202 Accepted		Permintaan diterima, refresh tabel analitik SQL sedang berlangsung. Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: ItemNotFound - Item yang diminta tidak ditemukan.

Nama

Jenis

Deskripsi

200 OK

TableSyncStatuses

Permintaan berhasil diselesaikan.

202 Accepted

Permintaan diterima, refresh tabel analitik SQL sedang berlangsung.

Header

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

Other Status Codes

ErrorResponse

Kode kesalahan umum:

ItemNotFound - Item yang diminta tidak ditemukan.

Contoh

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

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 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"
    }
  ]
}

Definisi

Nama	Deskripsi
Duration	Durasi.
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
SqlEndpointRefreshMetadataRequest	Refresh payload permintaan titik akhir analaytik SQL.
SyncStatus	Status operasi sinkronisasi. Jenis SyncStatus tambahan dapat ditambahkan dari waktu ke waktu.
TableSyncStatus	Objek status sinkronisasi tabel.
TableSyncStatuses	Daftar status sinkronisasi tabel.
TimeUnit	Satuan waktu untuk durasi. Jenis durasi tambahan dapat ditambahkan dari waktu ke waktu.

Duration

Objek

Durasi.

Nama	Jenis	Deskripsi
timeUnit	TimeUnit	Satuan waktu untuk durasi. Jenis durasi tambahan dapat ditambahkan dari waktu ke waktu.
value	number	Jumlah timeUnits dalam durasi.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

SqlEndpointRefreshMetadataRequest

Objek

Refresh payload permintaan titik akhir analaytik SQL.

Nama	Jenis	Deskripsi
recreateTables	boolean	Ketika diatur ke true, properti ini menginstruksikan sistem untuk menghilangkan dan membuat ulang semua tabel pada titik akhir analitik SQL selama proses refresh. Gunakan opsi ini jika Anda perlu sepenuhnya membangun ulang tabel dari definisi sumbernya, misalnya untuk mengatasi inkonsistensi atau memastikan refresh bersih. Nilai defaultnya adalah false.
timeout	Duration	Durasi permintaan sebelum waktu habis. Nilai defaultnya adalah 15 menit.

SyncStatus

Enumerasi

Status operasi sinkronisasi. Jenis SyncStatus tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Success	Menunjukkan keberhasilan.
Failure	Menunjukkan kegagalan.
NotRun	Menunjukkan bahwa operasi tidak berjalan.

TableSyncStatus

Objek

Objek status sinkronisasi tabel.

Nama	Jenis	Deskripsi
endDateTime	string (date-time)	Tanggal dan waktu ketika sinkronisasi tabel selesai dalam UTC, menggunakan format YYYY-MM-DDTHH:mm:ssZ.
error	ErrorResponseDetails	Detail respons kesalahan
lastSuccessfulSyncDateTime	string (date-time)	Tanggal dan waktu ketika sinkronisasi tabel berhasil dalam UTC, menggunakan format YYYY-MM-DDTHH:mm:ssZ.
startDateTime	string (date-time)	Tanggal dan waktu saat sinkronisasi tabel dimulai dalam UTC, menggunakan format YYYY-MM-DDTHH:mm:ssZ.
status	SyncStatus	Apakah tabel disinkronkan tanpa kesalahan.
tableName	string	Nama tabel yang disinkronkan.

TableSyncStatuses

Objek

Daftar status sinkronisasi tabel.

Nama	Jenis	Deskripsi
value	TableSyncStatus[]	Daftar status sinkronisasi tabel.

TimeUnit

Enumerasi

Satuan waktu untuk durasi. Jenis durasi tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Seconds	Durasi dalam detik.
Minutes	Durasi dalam hitung menit.
Hours	Durasi dalam jam.
Days	Durasi dalam hari.

Bagikan melalui

Items - Refresh Sql Endpoint Metadata

Permissions

Cakupan yang Didelegasikan yang Diperlukan

Identitas yang didukung oleh Microsoft Entra

Interface

Parameter URI

Isi Permintaan

Respons

Contoh

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

Permintaan sampel

Respon sampel

Definisi

Duration

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

SqlEndpointRefreshMetadataRequest

SyncStatus

TableSyncStatus

TableSyncStatuses

TimeUnit