Items - Refresh Sql Endpoint Metadata

Служба:
SQLEndpoint
Версия API:
v1

Обновляет таблицы в конечной точке аналитики SQL.
Этот API поддерживает длительные операции (LRO).

При tables указании в тексте запроса обновляются только указанные таблицы. Если опущен или пуст, все таблицы обновляются.

Permissions

Вызывающий объект должен иметь участника или более поздней роли рабочей области.

Обязательные делегированные области

Item.ReadWrite.All

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Identity Support
User Yes
Представитель службы и управляемые удостоверения Yes

Interface

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

Параметры URI

Имя В Обязательно Тип Описание
sqlEndpointId
 path True

string (uuid)

Идентификатор конечной точки аналитики SQL.
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.

Текст запроса

Имя Тип Описание
recreateTables

boolean

Если задано значение true, это свойство указывает системе удалять и повторно создавать все таблицы в конечной точке аналитики SQL во время процесса обновления. Используйте этот параметр, если необходимо полностью перестроить таблицы из их исходных определений, например для устранения несоответствий или обеспечения чистого обновления. В сочетании с tablesпараметром сброс состояния синхронизации ограничивается только указанными таблицами. По умолчанию используется значение false.
tables

TableDefinition[]

При условии обновите только перечисленные таблицы. Если опущен или пуст, все таблицы обновляются. Каждая запись указывает схему и одно или несколько имен таблиц для обновления в этой схеме. Максимальное количество таблиц, которые можно синхронизировать в одном запросе, равно 25. Разрешение таблиц зависит от того, включен ли родительский элемент конечной точки SQL. Для элементов с поддержкой схемы таблицы разрешаются с помощью предоставленной вызывающим схемой. Для элементов, не поддерживающих схему, все таблицы разрешаются в схеме по умолчанию независимо от значения схемы, предоставленной вызывающей схемой; Таблицы в схеме, отличной от по умолчанию, не могут быть разрешены и будут сообщаться с ошибкой DeltaTableNotFound .
timeout

Duration

Длительность запроса до истечения времени ожидания. Значение по умолчанию — 15 минут.

Ответы

Имя Тип Описание
200 OK

TableSyncStatuses

Запрос успешно завершен.
202 Accepted

Запрос принят, обновление таблицы аналитики SQL выполняется.

Заголовки

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

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • ItemNotFound — запрошенный элемент не найден.

Примеры

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

Образец запроса

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

Пример ответа

Код состояния:
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

Образец запроса

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

Пример ответа

Код состояния:
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

Образец запроса

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

Пример ответа

Код состояния:
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

Образец запроса

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

Пример ответа

Код состояния:
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"
    }
  ]
}

Определения

Имя Описание
Duration

Длительность.
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.
SqlEndpointRefreshMetadataRequest

Полезные данные запроса для обновления конечной точки аналитики SQL.
SyncStatus

Состояние операции синхронизации. С течением времени могут добавляться дополнительные типы SyncStatus.
TableDefinition

Пара имен схем и таблиц для определения выборочного обновления.
TableSyncStatus

Объект состояния синхронизации таблиц.
TableSyncStatuses

Список состояний синхронизации таблиц.
TimeUnit

Единица времени для длительности. С течением времени могут добавляться дополнительные типы длительности.

Duration

Объект

Длительность.

Имя Тип Описание
timeUnit

TimeUnit

Единица времени для длительности. С течением времени могут добавляться дополнительные типы длительности.
value

number

Количество единиц времени в течение длительности.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable

boolean

Если задано значение true, запрос можно получить. Retry-After Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

SqlEndpointRefreshMetadataRequest

Объект

Полезные данные запроса для обновления конечной точки аналитики SQL.

Имя Тип Описание
recreateTables

boolean

Если задано значение true, это свойство указывает системе удалять и повторно создавать все таблицы в конечной точке аналитики SQL во время процесса обновления. Используйте этот параметр, если необходимо полностью перестроить таблицы из их исходных определений, например для устранения несоответствий или обеспечения чистого обновления. В сочетании с tablesпараметром сброс состояния синхронизации ограничивается только указанными таблицами. По умолчанию используется значение false.
tables

TableDefinition[]

При условии обновите только перечисленные таблицы. Если опущен или пуст, все таблицы обновляются. Каждая запись указывает схему и одно или несколько имен таблиц для обновления в этой схеме. Максимальное количество таблиц, которые можно синхронизировать в одном запросе, равно 25. Разрешение таблиц зависит от того, включен ли родительский элемент конечной точки SQL. Для элементов с поддержкой схемы таблицы разрешаются с помощью предоставленной вызывающим схемой. Для элементов, не поддерживающих схему, все таблицы разрешаются в схеме по умолчанию независимо от значения схемы, предоставленной вызывающей схемой; Таблицы в схеме, отличной от по умолчанию, не могут быть разрешены и будут сообщаться с ошибкой DeltaTableNotFound .
timeout

Duration

Длительность запроса до истечения времени ожидания. Значение по умолчанию — 15 минут.

SyncStatus

Перечисление

Состояние операции синхронизации. С течением времени могут добавляться дополнительные типы SyncStatus.

Значение Описание
Success

Указывает на успешное выполнение.
Failure

Указывает на сбой.
NotRun

Указывает, что операция не выполнялась.

TableDefinition

Объект

Пара имен схем и таблиц для определения выборочного обновления.

Имя Тип Описание
schema

string

minLength: 1
maxLength: 128

Имя схемы для разрешения таблиц. Не должно быть зарезервированной системной схемой.
tableNames

string[]

minLength: 1
maxLength: 128

Одно или несколько имен таблиц для обновления в указанной схеме.

TableSyncStatus

Объект

Объект состояния синхронизации таблиц.

Имя Тип Описание
endDateTime

string (date-time)

Дата и время завершения синхронизации таблиц в формате UTC с использованием формата YYYY-MM-DDTHH:mm:ssZ.
error

ErrorResponseDetails

Сведения об ответе на ошибку
lastSuccessfulSyncDateTime

string (date-time)

Дата и время успешной синхронизации таблиц в формате UTC с использованием формата YYYY-MM-DDTHH:mm:ssZ.
startDateTime

string (date-time)

Дата и время начала синхронизации таблиц в формате UTC с использованием формата ГГГГ-ММ-ДДTHH:mm:ssZ.
status

SyncStatus

Синхронизирована ли таблица без ошибок.
tableName

string

Имя таблицы, синхронизированной. Для элементов с поддержкой схемы имя таблицы префиксируется именем схемы (например, schema.tableName).

TableSyncStatuses

Объект

Список состояний синхронизации таблиц.

Имя Тип Описание
value

TableSyncStatus[]

Список состояний синхронизации таблиц.

TimeUnit

Перечисление

Единица времени для длительности. С течением времени могут добавляться дополнительные типы длительности.

Значение Описание
Seconds

Длительность в секундах.
Minutes

Длительность в минутах.
Hours

Длительность в часах.
Days

Длительность в днях.