Items - Refresh Sql Endpoint Metadata

Služba:
SQLEndpoint
Verze rozhraní API:
v1

Aktualizuje tabulky v rámci koncového bodu analýzy SQL.
Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Pokud tables je v textu požadavku k dispozici, aktualizují se pouze zadané tabulky. Pokud je vynecháno nebo je prázdné, aktualizují se všechny tabulky.

Permissions

Volající musí mít roli přispěvatele nebo vyšší.

Požadované delegovaná rozsahy

Item.ReadWrite.All

Podporované identity v Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identity Support
User Yes
Hlavní služba a Spravované identity Yes

Interface

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
sqlEndpointId
 path True

string (uuid)

ID koncového bodu SQL Analytics.
workspaceId
 path True

string (uuid)

Identifikátor pracovního prostoru.

Text požadavku

Name Typ Description
recreateTables

boolean

Pokud je tato vlastnost nastavená na hodnotu true, dává systému pokyn, aby během procesu aktualizace zahodil a znovu vytvořil všechny tabulky v koncovém bodu analýzy SQL. Tuto možnost použijte, pokud potřebujete plně znovu sestavit tabulky z jejich zdrojových definic, například vyřešit nekonzistence nebo zajistit čistou aktualizaci. V kombinaci s rozsahem tablesresetování stavu synchronizace se vztahuje pouze na zadané tabulky. Výchozí hodnota je false.
tables

TableDefinition[]

Po zadání rozsah aktualizace pouze na uvedené tabulky. Pokud je vynecháno nebo je prázdné, aktualizují se všechny tabulky. Každá položka určuje schéma a jeden nebo více názvů tabulek, které se mají v rámci tohoto schématu aktualizovat. Maximální počet tabulek, které je možné synchronizovat v jednom požadavku, je 25. Rozlišení tabulky závisí na tom, jestli je nadřazená položka koncového bodu SQL povolená schématem. U položek s povoleným schématem se tabulky přeloží pomocí schématu poskytnutého volajícím. U položek bez schématu se všechny tabulky překládají ve výchozím schématu bez ohledu na hodnotu schématu poskytnuté volajícím; tabulky v rámci jiného než výchozího schématu nelze vyřešit a budou hlášeny s chybou DeltaTableNotFound .
timeout

Duration

Doba trvání požadavku před uplynutím časového limitu. Výchozí hodnota je 15 minut.

Odpovědi

Name Typ Description
200 OK

TableSyncStatuses

Žádost byla úspěšně dokončena.
202 Accepted

Žádost byla přijata a probíhá aktualizace tabulky SQL Analytics.

Hlavičky

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

ErrorResponse

Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující Retry-After , jak dlouho musí klient čekat před odesláním dalších požadavků.

Hlavičky

Retry-After: integer
Other Status Codes

ErrorResponse

Běžné kódy chyb:

  • ItemNotFound – Požadovaná položka nebyla nalezena.

Příklady

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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"
    }
  ]
}

Definice

Name Description
Duration

Doba trvání.
ErrorRelatedResource

Chyba související s objektem podrobností o prostředku.
ErrorResponse

Odpověď na chybu.
ErrorResponseDetails

Podrobnosti o odpovědi na chybu.
SqlEndpointRefreshMetadataRequest

Datová část požadavku pro aktualizaci koncového bodu analýzy SQL.
SyncStatus

Stav operace synchronizace. V průběhu času je možné přidat další typy SyncStatus.
TableDefinition

Pár názvů schémat a tabulek pro nastavení rozsahu selektivní aktualizace.
TableSyncStatus

Objekt stavu synchronizace tabulky.
TableSyncStatuses

Seznam stavů synchronizace tabulek.
TimeUnit

Jednotka času pro dobu trvání. Další typy doby trvání mohou být přidány v průběhu času.

Duration

Objekt

Doba trvání.

Name Typ Description
timeUnit

TimeUnit

Jednotka času pro dobu trvání. Další typy doby trvání mohou být přidány v průběhu času.
value

number

Počet časových jednotek v době trvání.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name Typ Description
resourceId

string

ID prostředku, které je součástí chyby.
resourceType

string

Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
isRetriable

boolean

Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky Retry-After odpovědi určete zpoždění, pokud je k dispozici.
message

string

Lidské čitelné vyjádření chyby.
moreDetails

ErrorResponseDetails[]

Seznam dalších podrobností o chybě
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou
requestId

string (uuid)

ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message

string

Lidské čitelné vyjádření chyby.
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou

SqlEndpointRefreshMetadataRequest

Objekt

Datová část požadavku pro aktualizaci koncového bodu analýzy SQL.

Name Typ Description
recreateTables

boolean

Pokud je tato vlastnost nastavená na hodnotu true, dává systému pokyn, aby během procesu aktualizace zahodil a znovu vytvořil všechny tabulky v koncovém bodu analýzy SQL. Tuto možnost použijte, pokud potřebujete plně znovu sestavit tabulky z jejich zdrojových definic, například vyřešit nekonzistence nebo zajistit čistou aktualizaci. V kombinaci s rozsahem tablesresetování stavu synchronizace se vztahuje pouze na zadané tabulky. Výchozí hodnota je false.
tables

TableDefinition[]

Po zadání rozsah aktualizace pouze na uvedené tabulky. Pokud je vynecháno nebo je prázdné, aktualizují se všechny tabulky. Každá položka určuje schéma a jeden nebo více názvů tabulek, které se mají v rámci tohoto schématu aktualizovat. Maximální počet tabulek, které je možné synchronizovat v jednom požadavku, je 25. Rozlišení tabulky závisí na tom, jestli je nadřazená položka koncového bodu SQL povolená schématem. U položek s povoleným schématem se tabulky přeloží pomocí schématu poskytnutého volajícím. U položek bez schématu se všechny tabulky překládají ve výchozím schématu bez ohledu na hodnotu schématu poskytnuté volajícím; tabulky v rámci jiného než výchozího schématu nelze vyřešit a budou hlášeny s chybou DeltaTableNotFound .
timeout

Duration

Doba trvání požadavku před uplynutím časového limitu. Výchozí hodnota je 15 minut.

SyncStatus

Výčet

Stav operace synchronizace. V průběhu času je možné přidat další typy SyncStatus.

Hodnota Description
Success

Označuje úspěch.
Failure

Označuje selhání.
NotRun

Označuje, že operace nebyla spuštěna.

TableDefinition

Objekt

Pár názvů schémat a tabulek pro nastavení rozsahu selektivní aktualizace.

Name Typ Description
schema

string

minLength: 1
maxLength: 128

Název schématu pro rozlišení tabulky. Nesmí se jednat o rezervované systémové schéma.
tableNames

string[]

minLength: 1
maxLength: 128

Jeden nebo více názvů tabulek, které se mají aktualizovat v zadaném schématu.

TableSyncStatus

Objekt

Objekt stavu synchronizace tabulky.

Name Typ Description
endDateTime

string (date-time)

Datum a čas dokončení synchronizace tabulky ve standardu UTC pomocí formátu RRRR-MM-DDTHH:mm:ssZ.
error

ErrorResponseDetails

Podrobnosti odpovědi na chybu
lastSuccessfulSyncDateTime

string (date-time)

Datum a čas úspěšné synchronizace tabulky ve formátu UTC pomocí formátu RRRR-MM-DDTHH:mm:ssZ.
startDateTime

string (date-time)

Datum a čas spuštění synchronizace tabulky v UTC pomocí formátu RRRR-MM-DDTHH:mm:ssZ.
status

SyncStatus

Určuje, jestli se tabulka synchronizovala bez chyb.
tableName

string

Název tabulky, která se synchronizovala. U položek s povoleným schématem má název tabulky předponu názvu schématu (např. schema.tableName).

TableSyncStatuses

Objekt

Seznam stavů synchronizace tabulek.

Name Typ Description
value

TableSyncStatus[]

Seznam stavů synchronizace tabulek.

TimeUnit

Výčet

Jednotka času pro dobu trvání. Další typy doby trvání mohou být přidány v průběhu času.

Hodnota Description
Seconds

Doba trvání v sekundách.
Minutes

Doba trvání v minutách.
Hours

Doba trvání v hodinách.
Days

Doba trvání ve dnech.