Items - Refresh Sql Endpoint Metadata

Szolgáltatás:
SQLEndpoint
API-verzió:
v1

Frissíti a táblákat egy SQL Analytics-végponton belül.
Ez az API támogatja hosszú ideig futó műveleteket (LRO).

Ha tables a kérelem törzsében meg van adva, csak a megadott táblák frissülnek. Ha nincs megadva vagy üres, az összes tábla frissül.

Permissions

A hívónak közreműködői vagy magasabb munkaterületi szerepkört kell tartalmaznia.

Kötelező delegált hatókörök

Item.ReadWrite.All

Microsoft Entra által támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft identitásokat.

Identity Support
User Yes
szolgáltatás-princípium és felügyelt identitások Yes

Interface

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

URI-paraméterek

Name In Kötelező Típus Description
sqlEndpointId
 path True

string (uuid)

Az SQL Analytics végpontazonosítója.
workspaceId
 path True

string (uuid)

A munkaterület azonosítója.

Kérelem törzse

Name Típus Description
recreateTables

boolean

Ha igaz értékre van állítva, ez a tulajdonság arra utasítja a rendszert, hogy a frissítési folyamat során ejtse le és hozza létre újra az SQL Analytics-végpont összes tábláját. Ezt a lehetőséget akkor használhatja, ha teljesen újra kell építenie a táblákat a forrásdefiníciókból, például az inkonzisztenciák feloldásához vagy a tiszta frissítés biztosításához. Ezzel kombinálva tablesa szinkronizálási állapot visszaállítása csak a megadott táblákra terjed ki. Az alapértelmezett érték hamis.
tables

TableDefinition[]

Ha meg van adva, a frissítés hatóköre csak a felsorolt táblákra terjed ki. Ha nincs megadva vagy üres, az összes tábla frissül. Minden bejegyzés egy sémát és egy vagy több táblanevet ad meg, amelyet frissíteni szeretne az adott séma alatt. Az egyetlen kérelemben szinkronizálható táblák maximális száma 25. A táblafeloldás attól függ, hogy az SQL-végpont szülőeleme séma-kompatibilis-e. Sémabarát elemek esetén a táblák feloldása a hívó által biztosított sémával történik. Nem sémabarát elemek esetén az összes tábla az alapértelmezett séma alatt oldható fel, függetlenül a hívó által megadott sémaértéktől; a nem alapértelmezett séma alá tartozó táblák nem oldhatók fel, és hibaüzenet jelenik DeltaTableNotFound meg.
timeout

Duration

A kérelem időtartama az időtúllépés előtt. Az alapértelmezett érték 15 perc.

Válaszok

Name Típus Description
200 OK

TableSyncStatuses

A kérés sikeresen befejeződött.
202 Accepted

A kérelem elfogadva, az SQL Analytics-tábla frissítése folyamatban van.

Fejlécek

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

ErrorResponse

Túllépte a szolgáltatási sebesség korlátját. A kiszolgáló egy Retry-After fejlécet ad vissza másodpercek alatt, amely jelzi, hogy az ügyfélnek mennyi ideig kell várnia a további kérések elküldése előtt.

Fejlécek

Retry-After: integer
Other Status Codes

ErrorResponse

Gyakori hibakódok:

  • ItemNotFound – A kért elem nem található.

Példák

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

Mintakérelem

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

Mintaválasz

Állapotkód:
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

Mintakérelem

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

Mintaválasz

Állapotkód:
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

Mintakérelem

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

Mintaválasz

Állapotkód:
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

Mintakérelem

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

Mintaválasz

Állapotkód:
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"
    }
  ]
}

Definíciók

Name Description
Duration

Időtartam.
ErrorRelatedResource

A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse

A hibaválasz.
ErrorResponseDetails

A hibaválasz részletei.
SqlEndpointRefreshMetadataRequest

Az SQL Analytics-végpont frissítésére vonatkozó hasznos adatkérés.
SyncStatus

A szinkronizálási művelet állapota. Idővel további SyncStatus-típusok is hozzáadhatók.
TableDefinition

Séma- és táblanevek párja a szelektív frissítés hatókörének meghatározásához.
TableSyncStatus

Táblaszinkronizálási állapotobjektum.
TableSyncStatuses

A táblaszinkronizálási állapotok listája.
TimeUnit

Az időtartam időegysége. Idővel további időtartamtípusok is hozzáadhatók.

Duration

Tárgy

Időtartam.

Name Típus Description
timeUnit

TimeUnit

Az időtartam időegysége. Idővel további időtartamtípusok is hozzáadhatók.
value

number

Az időtartam időegységeinek száma.

ErrorRelatedResource

Tárgy

A hibával kapcsolatos erőforrás-részletek objektum.

Name Típus Description
resourceId

string

A hibában érintett erőforrás-azonosító.
resourceType

string

A hibában érintett erőforrás típusa.

ErrorResponse

Tárgy

A hibaválasz.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
isRetriable

boolean

Ha igaz, a kérés újrapróbálkozott. Ha elérhető, a Retry-After válaszfejléc használatával állapítsa meg a késést.
message

string

A hiba emberi olvasható ábrázolása.
moreDetails

ErrorResponseDetails[]

További hibaadatok listája.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.
requestId

string (uuid)

A hibához társított kérés azonosítója.

ErrorResponseDetails

Tárgy

A hibaválasz részletei.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message

string

A hiba emberi olvasható ábrázolása.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.

SqlEndpointRefreshMetadataRequest

Tárgy

Az SQL Analytics-végpont frissítésére vonatkozó hasznos adatkérés.

Name Típus Description
recreateTables

boolean

Ha igaz értékre van állítva, ez a tulajdonság arra utasítja a rendszert, hogy a frissítési folyamat során ejtse le és hozza létre újra az SQL Analytics-végpont összes tábláját. Ezt a lehetőséget akkor használhatja, ha teljesen újra kell építenie a táblákat a forrásdefiníciókból, például az inkonzisztenciák feloldásához vagy a tiszta frissítés biztosításához. Ezzel kombinálva tablesa szinkronizálási állapot visszaállítása csak a megadott táblákra terjed ki. Az alapértelmezett érték hamis.
tables

TableDefinition[]

Ha meg van adva, a frissítés hatóköre csak a felsorolt táblákra terjed ki. Ha nincs megadva vagy üres, az összes tábla frissül. Minden bejegyzés egy sémát és egy vagy több táblanevet ad meg, amelyet frissíteni szeretne az adott séma alatt. Az egyetlen kérelemben szinkronizálható táblák maximális száma 25. A táblafeloldás attól függ, hogy az SQL-végpont szülőeleme séma-kompatibilis-e. Sémabarát elemek esetén a táblák feloldása a hívó által biztosított sémával történik. Nem sémabarát elemek esetén az összes tábla az alapértelmezett séma alatt oldható fel, függetlenül a hívó által megadott sémaértéktől; a nem alapértelmezett séma alá tartozó táblák nem oldhatók fel, és hibaüzenet jelenik DeltaTableNotFound meg.
timeout

Duration

A kérelem időtartama az időtúllépés előtt. Az alapértelmezett érték 15 perc.

SyncStatus

Felsorolás

A szinkronizálási művelet állapota. Idővel további SyncStatus-típusok is hozzáadhatók.

Érték Description
Success

Sikerességet jelez.
Failure

Hibát jelez.
NotRun

Azt jelzi, hogy a művelet nem futott.

TableDefinition

Tárgy

Séma- és táblanevek párja a szelektív frissítés hatókörének meghatározásához.

Name Típus Description
schema

string

minLength: 1
maxLength: 128

A táblafeloldás sémaneve. Nem lehet fenntartott rendszerséma.
tableNames

string[]

minLength: 1
maxLength: 128

Egy vagy több táblanév, amely frissítve lesz a megadott séma alatt.

TableSyncStatus

Tárgy

Táblaszinkronizálási állapotobjektum.

Name Típus Description
endDateTime

string (date-time)

Az a dátum és idő, amikor a tábla szinkronizálása UTC-ben befejeződött, YYYY-MM-DDTHH:mm:ssZ formátumban.
error

ErrorResponseDetails

A hibaválasz részletei
lastSuccessfulSyncDateTime

string (date-time)

A táblaszinkronizálás sikerességének dátuma és időpontja UTC-ben, YYYY-MM-DDTHH:mm:ssZ formátumban.
startDateTime

string (date-time)

Az a dátum és idő, amikor a tábla szinkronizálása UTC-ben kezdődött, YYYY-MM-DDTHH:mm:ssZ formátumban.
status

SyncStatus

Azt jelzi, hogy a tábla hiba nélkül szinkronizálva van-e.
tableName

string

A szinkronizált tábla neve. Sémabarát elemek esetén a tábla neve a séma nevével (például "schema.tableName") van előtaggal elosztva.

TableSyncStatuses

Tárgy

A táblaszinkronizálási állapotok listája.

Name Típus Description
value

TableSyncStatus[]

A táblaszinkronizálási állapotok listája.

TimeUnit

Felsorolás

Az időtartam időegysége. Idővel további időtartamtípusok is hozzáadhatók.

Érték Description
Seconds

Időtartam másodpercben.
Minutes

Időtartam percekben.
Hours

Időtartam órákban.
Days

Időtartam napokban.