Items - Refresh Sql Endpoint Metadata

Serviço:: SQLEndpoint

Versão API:: v1

Atualiza todas as tabelas dentro de um ponto de extremidade de análise SQL.
Esta API suporta operações de longa duração (LRO).

Permissões

O chamador deve ter função de colaborador ou superior do espaço de trabalho.

Escopos delegados necessários

Item.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade	Apoio
Utilizador	Sim
Entidade de serviço e identidades geridas	Sim

Interfaz

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

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
sqlEndpointId	path	True	string (uuid)	O ID do ponto de extremidade da análise SQL.
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Órgão do Pedido

Nome	Tipo	Descrição
recreateTables	boolean	Quando definida como verdadeira, esta propriedade instrui o sistema a eliminar e recriar todas as tabelas no endpoint de análise SQL durante o processo de atualização. Use esta opção se precisar de reconstruir totalmente as tabelas a partir das definições de origem, por exemplo, para resolver inconsistências ou garantir uma atualização limpa. O valor predefinido é false.
timeout	Duration	A duração da solicitação antes do tempo limite. O valor padrão é 15 minutos.

Respostas

Nome	Tipo	Descrição
200 OK	TableSyncStatuses	Pedido concluído com sucesso.
202 Accepted		Solicitação aceita, atualização da tabela de análise SQL em andamento. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound - O item solicitado não foi encontrado.

Nome

Tipo

Descrição

200 OK

TableSyncStatuses

Pedido concluído com sucesso.

202 Accepted

Solicitação aceita, atualização da tabela de análise SQL em andamento.

Cabeçalhos

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de erro comuns:

ItemNotFound - O item solicitado não foi encontrado.

Exemplos

Refresh all tables for a specified SQL analytics endpoint in a workspace

Pedido de exemplo

HTTP

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

Resposta de exemplo

Código de estado:: 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"
    }
  ]
}

Definições

Nome	Descrição
Duration	Uma duração.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
SqlEndpointRefreshMetadataRequest	Atualize a carga útil de solicitação de ponto de extremidade de analaytics SQL.
SyncStatus	O status da operação de sincronização. Tipos adicionais de SyncStatus podem ser adicionados ao longo do tempo.
TableSyncStatus	Um objeto de status de sincronização de tabela.
TableSyncStatuses	Uma lista de status de sincronização de tabela.
TimeUnit	A unidade de tempo para a duração. Tipos de duração adicionais podem ser adicionados ao longo do tempo.

Duration

Objetivo

Uma duração.

Nome	Tipo	Descrição
timeUnit	TimeUnit	A unidade de tempo para a duração. Tipos de duração adicionais podem ser adicionados ao longo do tempo.
value	number	O número de timeUnits na duração.

ErrorRelatedResource

Objetivo

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Descrição
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Objetivo

A resposta de erro.

Nome	Tipo	Descrição
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objetivo

Os detalhes da resposta de erro.

Nome	Tipo	Descrição
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.

SqlEndpointRefreshMetadataRequest

Objetivo

Atualize a carga útil de solicitação de ponto de extremidade de analaytics SQL.

Nome	Tipo	Descrição
recreateTables	boolean	Quando definida como verdadeira, esta propriedade instrui o sistema a eliminar e recriar todas as tabelas no endpoint de análise SQL durante o processo de atualização. Use esta opção se precisar de reconstruir totalmente as tabelas a partir das definições de origem, por exemplo, para resolver inconsistências ou garantir uma atualização limpa. O valor predefinido é false.
timeout	Duration	A duração da solicitação antes do tempo limite. O valor padrão é 15 minutos.

SyncStatus

Enumeração

O status da operação de sincronização. Tipos adicionais de SyncStatus podem ser adicionados ao longo do tempo.

Valor	Descrição
Success	Indica um sucesso.
Failure	Indica uma falha.
NotRun	Indica que a operação não foi executada.

TableSyncStatus

Objetivo

Um objeto de status de sincronização de tabela.

Nome	Tipo	Descrição
endDateTime	string (date-time)	A data e a hora em que a sincronização da tabela foi concluída em UTC, usando o formato AAAA-MM-DDTHH:mm:ssZ.
error	ErrorResponseDetails	Os detalhes da resposta ao erro
lastSuccessfulSyncDateTime	string (date-time)	A data e a hora em que a sincronização da tabela foi bem-sucedida no UTC, usando o formato AAAA-MM-DDTHH:mm:ssZ.
startDateTime	string (date-time)	A data e a hora em que a sincronização da tabela começou em UTC, usando o formato AAAA-MM-DDTHH:mm:ssZ.
status	SyncStatus	Se a tabela sincronizou sem erros.
tableName	string	O nome da tabela sincronizada.

TableSyncStatuses

Objetivo

Uma lista de status de sincronização de tabela.

Nome	Tipo	Descrição
value	TableSyncStatus[]	Uma lista de status de sincronização de tabela.

TimeUnit

Enumeração

A unidade de tempo para a duração. Tipos de duração adicionais podem ser adicionados ao longo do tempo.

Valor	Descrição
Seconds	Duração em segundos.
Minutes	Duração em minutos.
Hours	Duração em horas.
Days	Duração em dias.

Partilhar via

Items - Refresh Sql Endpoint Metadata

Permissões

Escopos delegados necessários

Identidades suportadas pelo Entra da Microsoft

Interfaz

Parâmetros URI

Órgão do Pedido

Respostas

Exemplos

Refresh all tables for a specified SQL analytics endpoint in a workspace

Pedido de exemplo

Resposta de exemplo

Definições

Duration

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

SqlEndpointRefreshMetadataRequest

SyncStatus

TableSyncStatus

TableSyncStatuses

TimeUnit