Items - Refresh Sql Endpoint Metadata

Layanan:
SQLEndpoint
Versi API:
v1

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

Ketika tables disediakan dalam isi permintaan, hanya tabel yang ditentukan yang di-refresh. Saat dihilangkan atau kosong, semua tabel disegarkan.

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 yang bersih. Saat dikombinasikan dengan tables, pengaturan ulang status sinkronisasi hanya dicakup ke tabel yang ditentukan. Nilai defaultnya adalah false.
tables

TableDefinition[]

Saat disediakan, cakupan refresh hanya ke tabel yang tercantum. Saat dihilangkan atau kosong, semua tabel disegarkan. Setiap entri menentukan skema dan satu atau beberapa nama tabel untuk disegarkan di bawah skema tersebut. Jumlah maksimum tabel yang dapat disinkronkan dalam satu permintaan adalah 25. Resolusi tabel bergantung pada apakah item induk titik akhir SQL diaktifkan skema. Untuk item berkemampuan skema, tabel diselesaikan menggunakan skema yang disediakan pemanggil. Untuk item yang tidak mendukung skema, semua tabel diselesaikan di bawah skema default terlepas dari nilai skema yang disediakan pemanggil; tabel di bawah skema non-default tidak dapat diselesaikan dan akan dilaporkan dengan DeltaTableNotFound kesalahan.
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
429 Too Many Requests

ErrorResponse

Batas tarif layanan terlampaui. Server mengembalikan header yang Retry-After menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan.

Header

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
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

Permintaan sampel

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

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

Permintaan sampel

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

Respon sampel

Kode status:
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

Permintaan sampel

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

Respon sampel

Kode status:
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

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
Duration

Durasi.
ErrorRelatedResource

Objek detail sumber daya terkait kesalahan.
ErrorResponse

Respons kesalahan.
ErrorResponseDetails

Detail respons kesalahan.
SqlEndpointRefreshMetadataRequest

Payload permintaan untuk me-refresh titik akhir analitik SQL.
SyncStatus

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

Sepasang nama skema dan tabel untuk mencakup refresh selektif.
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.
isRetriable

boolean

Jika benar, permintaan dapat dicoba kembali. Retry-After Gunakan header respons untuk menentukan penundaan, jika tersedia.
message

string

Representasi kesalahan yang dapat dibaca manusia.
moreDetails

ErrorResponseDetails[]

Daftar detail kesalahan tambahan.
relatedResource

ErrorRelatedResource

Detail sumber daya terkait kesalahan.
requestId

string (uuid)

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

Payload permintaan untuk me-refresh titik akhir analitik 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 yang bersih. Saat dikombinasikan dengan tables, pengaturan ulang status sinkronisasi hanya dicakup ke tabel yang ditentukan. Nilai defaultnya adalah false.
tables

TableDefinition[]

Saat disediakan, cakupan refresh hanya ke tabel yang tercantum. Saat dihilangkan atau kosong, semua tabel disegarkan. Setiap entri menentukan skema dan satu atau beberapa nama tabel untuk disegarkan di bawah skema tersebut. Jumlah maksimum tabel yang dapat disinkronkan dalam satu permintaan adalah 25. Resolusi tabel bergantung pada apakah item induk titik akhir SQL diaktifkan skema. Untuk item berkemampuan skema, tabel diselesaikan menggunakan skema yang disediakan pemanggil. Untuk item yang tidak mendukung skema, semua tabel diselesaikan di bawah skema default terlepas dari nilai skema yang disediakan pemanggil; tabel di bawah skema non-default tidak dapat diselesaikan dan akan dilaporkan dengan DeltaTableNotFound kesalahan.
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.

TableDefinition

Objek

Sepasang nama skema dan tabel untuk mencakup refresh selektif.

Nama Jenis Deskripsi
schema

string

minLength: 1
maxLength: 128

Nama skema untuk resolusi tabel. Tidak boleh berupa skema sistem yang dipesan.
tableNames

string[]

minLength: 1
maxLength: 128

Satu atau beberapa nama tabel untuk disegarkan di bawah skema yang ditentukan.

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. Untuk item yang diaktifkan skema, nama tabel diawali dengan nama skema (misalnya, "schema.tableName").

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.