Items - Refresh Sql Endpoint Metadata

Tjänst:
SQLEndpoint
API-version:
v1

Uppdaterar tabeller i en SQL-analysslutpunkt.
Det här API:et stöder tidskrävande åtgärder (LRO).

När tables anges i begärandetexten uppdateras endast de angivna tabellerna. När de utelämnas eller är tomma uppdateras alla tabeller.

Permissions

Anroparen måste ha deltagare eller högre arbetsyteroll.

Obligatoriska delegerade omfång

Item.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity Support
User Yes
Tjänsthuvudnamn och hanterade identiteter Yes

Interface

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

URI-parametrar

Name I Obligatorisk Typ Description
sqlEndpointId
 path True

string (uuid)

SQL Analytics-slutpunkts-ID:t.
workspaceId
 path True

string (uuid)

Arbetsyte-ID.

Begärandetext

Name Typ Description
recreateTables

boolean

När värdet är true instruerar den här egenskapen systemet att släppa och återskapa alla tabeller på SQL-analysslutpunkten under uppdateringsprocessen. Använd det här alternativet om du behöver återskapa tabeller helt från deras källdefinitioner, till exempel för att lösa inkonsekvenser eller säkerställa en ren uppdatering. När den kombineras med tablesbegränsas återställningen av synkroniseringstillståndet endast till de angivna tabellerna. Standardvärdet är falskt.
tables

TableDefinition[]

När det tillhandahålls omfångsbegränsar uppdateringen endast till de listade tabellerna. När de utelämnas eller är tomma uppdateras alla tabeller. Varje post anger ett schema och ett eller flera tabellnamn som ska uppdateras under schemat. Det maximala antalet tabeller som kan synkroniseras i en enda begäran är 25. Tabellmatchning beror på om SQL-slutpunktens överordnade objekt är schemaaktiverat. För schemaaktiverade objekt matchas tabeller med hjälp av det schema som anroparen tillhandahåller. För objekt som inte är schemaaktiverade matchas alla tabeller under standardschemat oavsett schemavärdet som anges av anroparen. tabeller under ett icke-standardschema kan inte matchas och rapporteras med ett DeltaTableNotFound fel.
timeout

Duration

Varaktigheten för begäran innan tidsgränsen nås. Standardvärdet är 15 minuter.

Svar

Name Typ Description
200 OK

TableSyncStatuses

Begäran har slutförts.
202 Accepted

Begäran accepterad, SQL Analytics-tabelluppdatering pågår.

Sidhuvuden

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

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • ItemNotFound – Det begärda objektet hittades inte.

Exempel

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
Duration

En varaktighet.
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Information om felsvar.
SqlEndpointRefreshMetadataRequest

Nyttolasten för begäran för uppdatering av en SQL-analysslutpunkt.
SyncStatus

Status för synkroniseringsåtgärden. Ytterligare SyncStatus-typer kan läggas till över tid.
TableDefinition

Ett par schema- och tabellnamn för omfång för en selektiv uppdatering.
TableSyncStatus

Ett statusobjekt för tabellsynkronisering.
TableSyncStatuses

En lista över status för tabellsynkronisering.
TimeUnit

Tidsenheten för varaktigheten. Ytterligare varaktighetstyper kan läggas till över tid.

Duration

Objekt

En varaktighet.

Name Typ Description
timeUnit

TimeUnit

Tidsenheten för varaktigheten. Ytterligare varaktighetstyper kan läggas till över tid.
value

number

Antalet timeUnits i varaktigheten.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name Typ Description
resourceId

string

Det resurs-ID som ingår i felet.
resourceType

string

Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable

boolean

När det är sant kan begäran göras på nytt. Använd svarshuvudet Retry-After för att fastställa fördröjningen, om den är tillgänglig.
message

string

En mänsklig läsbar representation av felet.
moreDetails

ErrorResponseDetails[]

Lista över ytterligare felinformation.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.
requestId

string (uuid)

ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.

SqlEndpointRefreshMetadataRequest

Objekt

Nyttolasten för begäran för uppdatering av en SQL-analysslutpunkt.

Name Typ Description
recreateTables

boolean

När värdet är true instruerar den här egenskapen systemet att släppa och återskapa alla tabeller på SQL-analysslutpunkten under uppdateringsprocessen. Använd det här alternativet om du behöver återskapa tabeller helt från deras källdefinitioner, till exempel för att lösa inkonsekvenser eller säkerställa en ren uppdatering. När den kombineras med tablesbegränsas återställningen av synkroniseringstillståndet endast till de angivna tabellerna. Standardvärdet är falskt.
tables

TableDefinition[]

När det tillhandahålls omfångsbegränsar uppdateringen endast till de listade tabellerna. När de utelämnas eller är tomma uppdateras alla tabeller. Varje post anger ett schema och ett eller flera tabellnamn som ska uppdateras under schemat. Det maximala antalet tabeller som kan synkroniseras i en enda begäran är 25. Tabellmatchning beror på om SQL-slutpunktens överordnade objekt är schemaaktiverat. För schemaaktiverade objekt matchas tabeller med hjälp av det schema som anroparen tillhandahåller. För objekt som inte är schemaaktiverade matchas alla tabeller under standardschemat oavsett schemavärdet som anges av anroparen. tabeller under ett icke-standardschema kan inte matchas och rapporteras med ett DeltaTableNotFound fel.
timeout

Duration

Varaktigheten för begäran innan tidsgränsen nås. Standardvärdet är 15 minuter.

SyncStatus

Uppräkning

Status för synkroniseringsåtgärden. Ytterligare SyncStatus-typer kan läggas till över tid.

Värde Description
Success

Anger ett lyckat resultat.
Failure

Anger ett fel.
NotRun

Anger att åtgärden inte kördes.

TableDefinition

Objekt

Ett par schema- och tabellnamn för omfång för en selektiv uppdatering.

Name Typ Description
schema

string

minLength: 1
maxLength: 128

Schemanamnet för tabellmatchning. Får inte vara ett reserverat systemschema.
tableNames

string[]

minLength: 1
maxLength: 128

Ett eller flera tabellnamn som ska uppdateras under det angivna schemat.

TableSyncStatus

Objekt

Ett statusobjekt för tabellsynkronisering.

Name Typ Description
endDateTime

string (date-time)

Datum och tid då tabellsynkroniseringen slutfördes i UTC med formatet YYYY-MM-DDTHH:mm:ssZ.
error

ErrorResponseDetails

Information om felsvar
lastSuccessfulSyncDateTime

string (date-time)

Datum och tid då tabellsynkroniseringen lyckades i UTC med formatet YYYY-MM-DDTHH:mm:ssZ.
startDateTime

string (date-time)

Datum och tid då tabellsynkroniseringen startade i UTC med formatet YYYY-MM-DDTHH:mm:ssZ.
status

SyncStatus

Om tabellen synkroniserades utan fel.
tableName

string

Namnet på den tabell som synkroniserades. För schemaaktiverade objekt är tabellnamnet prefixet med schemanamnet (t.ex. "schema.tableName").

TableSyncStatuses

Objekt

En lista över status för tabellsynkronisering.

Name Typ Description
value

TableSyncStatus[]

En lista över status för tabellsynkronisering.

TimeUnit

Uppräkning

Tidsenheten för varaktigheten. Ytterligare varaktighetstyper kan läggas till över tid.

Värde Description
Seconds

Varaktighet i sekunder.
Minutes

Varaktighet i minuter.
Hours

Varaktighet i timmar.
Days

Varaktighet i dagar.