Items - Refresh Sql Endpoint Metadata

Service:
SQLEndpoint
API-versie:
v1

Hiermee worden tabellen in een SQL-analyse-eindpunt vernieuwd.
Deze API ondersteunt langlopende bewerkingen (LRO).

Wanneer tables wordt opgegeven in de aanvraagbody, worden alleen de opgegeven tabellen vernieuwd. Als u dit weglaat of leeg is, worden alle tabellen vernieuwd.

Permissions

De aanroeper moet inzender hebben of een hogere werkruimterol.

Vereiste gedelegeerde bereiken

Item.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identity Support
User Yes
serviceprincipal en beheerde identiteiten Yes

Interface

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

URI-parameters

Name In Vereist Type Description
sqlEndpointId
 path True

string (uuid)

De eindpunt-id van SQL Analytics.
workspaceId
 path True

string (uuid)

De werkruimte-ID.

Aanvraagbody

Name Type Description
recreateTables

boolean

Als deze eigenschap is ingesteld op true, geeft deze eigenschap het systeem de opdracht om alle tabellen op het SQL Analytics-eindpunt te verwijderen en opnieuw te maken tijdens het vernieuwingsproces. Gebruik deze optie als u tabellen volledig opnieuw wilt bouwen op basis van de brondefinities, bijvoorbeeld om inconsistenties op te lossen of een schone vernieuwing te garanderen. In combinatie met tablesde synchronisatiestatus wordt alleen het bereik van de opgegeven tabellen ingesteld. De standaardwaarde is onwaar.
tables

TableDefinition[]

Wanneer dit is opgegeven, wordt de vernieuwing alleen gericht op de vermelde tabellen. Als u dit weglaat of leeg is, worden alle tabellen vernieuwd. Elke vermelding geeft een schema en een of meer tabelnamen op die moeten worden vernieuwd onder dat schema. Het maximum aantal tabellen dat in één aanvraag kan worden gesynchroniseerd, is 25. Tabelomzetting is afhankelijk van of het bovenliggende item van het SQL-eindpunt schema is ingeschakeld. Voor items met schema's worden tabellen omgezet met behulp van het door de aanroeper verstrekte schema. Voor niet-schema-ingeschakelde items worden alle tabellen omgezet onder het standaardschema, ongeacht de door de aanroeper verstrekte schemawaarde; tabellen onder een niet-standaardschema kunnen niet worden opgelost en worden gerapporteerd met een DeltaTableNotFound fout.
timeout

Duration

De aanvraagduur voordat er een time-out optreedt. De standaardwaarde is 15 minuten.

Antwoorden

Name Type Description
200 OK

TableSyncStatuses

De aanvraag is voltooid.
202 Accepted

Aanvraag geaccepteerd, SQL Analytics-tabel wordt vernieuwd.

Kopteksten

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

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • ItemNotFound : het aangevraagde item is niet gevonden.

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
Duration

Een duur.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
SqlEndpointRefreshMetadataRequest

De nettolading van de aanvraag voor het vernieuwen van een SQL Analytics-eindpunt.
SyncStatus

De status van de synchronisatiebewerking. Er kunnen in de loop van de tijd extra SyncStatus-typen worden toegevoegd.
TableDefinition

Een paar schema- en tabelnamen voor het bereik van selectief vernieuwen.
TableSyncStatus

Een tabelsynchronisatiestatusobject.
TableSyncStatuses

Een lijst met statussen voor tabelsynchronisatie.
TimeUnit

De tijdseenheid voor de duur. Er kunnen in de loop van de tijd extra duurtypen worden toegevoegd.

Duration

Object

Een duur.

Name Type Description
timeUnit

TimeUnit

De tijdseenheid voor de duur. Er kunnen in de loop van de tijd extra duurtypen worden toegevoegd.
value

number

Het aantal timeUnits in de duur.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable

boolean

Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de Retry-After antwoordheader om de vertraging te bepalen, indien beschikbaar.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

SqlEndpointRefreshMetadataRequest

Object

De nettolading van de aanvraag voor het vernieuwen van een SQL Analytics-eindpunt.

Name Type Description
recreateTables

boolean

Als deze eigenschap is ingesteld op true, geeft deze eigenschap het systeem de opdracht om alle tabellen op het SQL Analytics-eindpunt te verwijderen en opnieuw te maken tijdens het vernieuwingsproces. Gebruik deze optie als u tabellen volledig opnieuw wilt bouwen op basis van de brondefinities, bijvoorbeeld om inconsistenties op te lossen of een schone vernieuwing te garanderen. In combinatie met tablesde synchronisatiestatus wordt alleen het bereik van de opgegeven tabellen ingesteld. De standaardwaarde is onwaar.
tables

TableDefinition[]

Wanneer dit is opgegeven, wordt de vernieuwing alleen gericht op de vermelde tabellen. Als u dit weglaat of leeg is, worden alle tabellen vernieuwd. Elke vermelding geeft een schema en een of meer tabelnamen op die moeten worden vernieuwd onder dat schema. Het maximum aantal tabellen dat in één aanvraag kan worden gesynchroniseerd, is 25. Tabelomzetting is afhankelijk van of het bovenliggende item van het SQL-eindpunt schema is ingeschakeld. Voor items met schema's worden tabellen omgezet met behulp van het door de aanroeper verstrekte schema. Voor niet-schema-ingeschakelde items worden alle tabellen omgezet onder het standaardschema, ongeacht de door de aanroeper verstrekte schemawaarde; tabellen onder een niet-standaardschema kunnen niet worden opgelost en worden gerapporteerd met een DeltaTableNotFound fout.
timeout

Duration

De aanvraagduur voordat er een time-out optreedt. De standaardwaarde is 15 minuten.

SyncStatus

Opsomming

De status van de synchronisatiebewerking. Er kunnen in de loop van de tijd extra SyncStatus-typen worden toegevoegd.

Waarde Description
Success

Geeft een succes aan.
Failure

Geeft een fout aan.
NotRun

Geeft aan dat de bewerking niet is uitgevoerd.

TableDefinition

Object

Een paar schema- en tabelnamen voor het bereik van selectief vernieuwen.

Name Type Description
schema

string

minLength: 1
maxLength: 128

De schemanaam voor tabelomzetting. Mag geen gereserveerd systeemschema zijn.
tableNames

string[]

minLength: 1
maxLength: 128

Een of meer tabelnamen die moeten worden vernieuwd onder het opgegeven schema.

TableSyncStatus

Object

Een tabelsynchronisatiestatusobject.

Name Type Description
endDateTime

string (date-time)

De datum en tijd waarop de tabelsynchronisatie is voltooid in UTC, met de notatie JJJJ-MM-DDTHH:mm:ssZ.
error

ErrorResponseDetails

Details van de foutreactie
lastSuccessfulSyncDateTime

string (date-time)

De datum en tijd waarop de tabelsynchronisatie is geslaagd in UTC, met de notatie JJJJ-MM-DDTHH:mm:ssZ.
startDateTime

string (date-time)

De datum en tijd waarop de tabelsynchronisatie is gestart in UTC, met de notatie JJJJ-MM-DDTHH:mm:ssZ.
status

SyncStatus

Of de tabel zonder fouten is gesynchroniseerd.
tableName

string

De naam van de tabel die is gesynchroniseerd. Voor items met schema's wordt de tabelnaam voorafgegaan door de schemanaam (bijvoorbeeld schema.tableName).

TableSyncStatuses

Object

Een lijst met statussen voor tabelsynchronisatie.

Name Type Description
value

TableSyncStatus[]

Een lijst met statussen voor tabelsynchronisatie.

TimeUnit

Opsomming

De tijdseenheid voor de duur. Er kunnen in de loop van de tijd extra duurtypen worden toegevoegd.

Waarde Description
Seconds

Duur in seconden.
Minutes

Duur in minuten.
Hours

Duur in uren.
Days

Duur in dagen.