Items - Refresh Sql Endpoint Metadata

Tjeneste:
SQLEndpoint
API-versjon:
v1

Oppdaterer tabeller i et SQL Analytics-endepunkt.
Denne API-en støtter langvarige operasjoner (LRO).

Når tables det er angitt i forespørselsteksten, oppdateres bare de angitte tabellene. Når utelatt eller tom, oppdateres alle tabeller.

Permissions

Innringeren må ha bidragsyter - eller høyere arbeidsområderolle.

Nødvendige delegerte omfang

Item.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identity Support
User Yes
tjenestekontohaver og administrerte identiteter Yes

Interface

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

URI-parametere

Name I Obligatorisk Type Beskrivelse
sqlEndpointId
 path True

string (uuid)

Endepunkt-ID for SQL-analyse.
workspaceId
 path True

string (uuid)

Arbeidsområde-ID-en.

Brødtekst for forespørsel

Name Type Beskrivelse
recreateTables

boolean

Når den er satt til sann, ber denne egenskapen systemet om å slippe og gjenskape alle tabeller på SQL Analytics-endepunktet under oppdateringsprosessen. Bruk dette alternativet hvis du trenger å gjenoppbygge tabeller fullstendig fra kildedefinisjonene, for eksempel for å løse inkonsekvenser eller sikre en ren oppdatering. Når den kombineres med tables, er tilbakestillingen av synkroniseringstilstanden bare begrenset til de angitte tabellene. Standardverdien er false.
tables

TableDefinition[]

Når den er angitt, utvides oppdateringen til bare de oppførte tabellene. Når utelatt eller tom, oppdateres alle tabeller. Hver oppføring angir et skjema og ett eller flere tabellnavn som skal oppdateres under dette skjemaet. Maksimalt antall tabeller som kan synkroniseres i én enkelt forespørsel, er 25. Tabelloppløsning avhenger av om sql-endepunktets overordnede element er skjemaaktivert. For skjemaaktiverte elementer løses tabeller ved hjelp av det oppringer-angitte skjemaet. For elementer som ikke er skjemaaktivert, løses alle tabeller under standardskjemaet, uavhengig av skjemaverdien som er angitt av anroperen. tabeller under et skjema som ikke er standard, kan ikke løses og rapporteres med en DeltaTableNotFound feil.
timeout

Duration

Hvor lang tid forespørselen kan kjøre før tidsavbrudd. Standarder til 15 minutter, med maksimalt 24 timer.

Svar

Name Type Beskrivelse
200 OK

TableSyncStatuses

Forespørselen er fullført.
202 Accepted

Forespørsel godtatt, oppdatering av SQL Analytics-tabell pågår.

Overskrifter

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

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • ItemNotFound – Finner ikke det forespurte elementet.

Eksempler

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

Eksempelforespørsel

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

Eksempelsvar

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

Eksempelforespørsel

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

Eksempelsvar

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

Eksempelforespørsel

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

Eksempelsvar

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

Eksempelforespørsel

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

Eksempelsvar

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

Definisjoner

Name Beskrivelse
Duration

En varighet.
ErrorParameter

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
SqlEndpointRefreshMetadataRequest

Nyttelasten for forespørsel for oppdatering av et SQL Analytics-endepunkt.
SyncStatus

Statusen for synkroniseringsoperasjonen. Flere SyncStatus-typer kan legges til over tid.
TableDefinition

Et par skjema- og tabellnavn for omfang av en selektiv oppdatering.
TableSyncStatus

Et statusobjekt for tabellsynkronisering.
TableSyncStatuses

En liste over tabellsynkroniseringsstatuser.
TimeUnit

Tidsenheten for varigheten. Flere varighetstyper kan legges til over tid.

Duration

Objekt

En varighet.

Name Type Beskrivelse
timeUnit

TimeUnit

Tidsenheten for varigheten. Flere varighetstyper kan legges til over tid.
value

number

Antall timeUnits i varigheten.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name Type Beskrivelse
message

string

En lesbar beskrivelse av parameterens betydning.
name

string

Parameteridentifikatoren.
value

string

Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable

boolean

Når sann, kan forespørselen prøves på nytt. Retry-After Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

SqlEndpointRefreshMetadataRequest

Objekt

Nyttelasten for forespørsel for oppdatering av et SQL Analytics-endepunkt.

Name Type Beskrivelse
recreateTables

boolean

Når den er satt til sann, ber denne egenskapen systemet om å slippe og gjenskape alle tabeller på SQL Analytics-endepunktet under oppdateringsprosessen. Bruk dette alternativet hvis du trenger å gjenoppbygge tabeller fullstendig fra kildedefinisjonene, for eksempel for å løse inkonsekvenser eller sikre en ren oppdatering. Når den kombineres med tables, er tilbakestillingen av synkroniseringstilstanden bare begrenset til de angitte tabellene. Standardverdien er false.
tables

TableDefinition[]

Når den er angitt, utvides oppdateringen til bare de oppførte tabellene. Når utelatt eller tom, oppdateres alle tabeller. Hver oppføring angir et skjema og ett eller flere tabellnavn som skal oppdateres under dette skjemaet. Maksimalt antall tabeller som kan synkroniseres i én enkelt forespørsel, er 25. Tabelloppløsning avhenger av om sql-endepunktets overordnede element er skjemaaktivert. For skjemaaktiverte elementer løses tabeller ved hjelp av det oppringer-angitte skjemaet. For elementer som ikke er skjemaaktivert, løses alle tabeller under standardskjemaet, uavhengig av skjemaverdien som er angitt av anroperen. tabeller under et skjema som ikke er standard, kan ikke løses og rapporteres med en DeltaTableNotFound feil.
timeout

Duration

Hvor lang tid forespørselen kan kjøre før tidsavbrudd. Standarder til 15 minutter, med maksimalt 24 timer.

SyncStatus

Opplisting

Statusen for synkroniseringsoperasjonen. Flere SyncStatus-typer kan legges til over tid.

Verdi Beskrivelse
Success

Angir en suksess.
Failure

Angir en feil.
NotRun

Angir at operasjonen ikke ble kjørt.

TableDefinition

Objekt

Et par skjema- og tabellnavn for omfang av en selektiv oppdatering.

Name Type Beskrivelse
schema

string

minLength: 1
maxLength: 128

Skjemanavnet for tabelloppløsning. Kan ikke være et reservert systemskjema.
tableNames

string[]

minLength: 1
maxLength: 128

Ett eller flere tabellnavn som skal oppdateres under det angitte skjemaet.

TableSyncStatus

Objekt

Et statusobjekt for tabellsynkronisering.

Name Type Beskrivelse
endDateTime

string (date-time)

Datoen og klokkeslettet da tabellsynkroniseringen ble fullført i UTC, ved hjelp av YYYY-MM-DDTHH:mm:ssZ-formatet.
error

ErrorResponseDetails

Feilsvardetaljene
lastSuccessfulSyncDateTime

string (date-time)

Datoen og klokkeslettet da tabellsynkroniseringen var vellykket i UTC, ved hjelp av YYYY-MM-DDTHH:mm:ssZ-formatet.
startDateTime

string (date-time)

Datoen og klokkeslettet da tabellsynkroniseringen startet i UTC, ved hjelp av YYYY-MM-DDTHH:mm:ssZ-formatet.
status

SyncStatus

Om tabellen synkroniserte uten feil.
tableName

string

Navnet på tabellen som synkroniserte. For skjemaaktiverte elementer er tabellnavnet prefikset med skjemanavnet (f.eks. «schema.tableName»).

TableSyncStatuses

Objekt

En liste over tabellsynkroniseringsstatuser.

Name Type Beskrivelse
value

TableSyncStatus[]

En liste over tabellsynkroniseringsstatuser.

TimeUnit

Opplisting

Tidsenheten for varigheten. Flere varighetstyper kan legges til over tid.

Verdi Beskrivelse
Seconds

Varighet i sekunder.
Minutes

Varighet i minutter.
Hours

Varighet i timer.
Days

Varighet i dager.