Items - Refresh Sql Endpoint Metadata

서비스:: SQLEndpoint

API 버전:: v1

비고

이 미리 보기 API는 실험적이며 예고 없이 변경 될 수 있습니다. 평가 및 개발용으로만 제공됩니다. 프로덕션 사용은 권장되지 않습니다.

SQL 분석 엔드포인트 내의 모든 테이블을 새로 고칩니다.
이 API는 LRO(장기 실행 작업)지원합니다.

권한

호출자에게는 기여자 이상의 작업 영역 역할이 있어야 합니다.

필요한 위임된 범위

아이템.읽기쓰기.전체

Microsoft Entra 지원 식별자

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

아이덴티티	지원
사용자	예
서비스 주체 및 관리 ID	예

인터페이스

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
sqlEndpointId	path	True	string (uuid)	SQL 분석 엔드포인트 ID입니다.
workspaceId	path	True	string (uuid)	작업 영역 ID입니다.
preview	query	True	boolean	현재 미리 보기로 있는 이 API에 액세스하려면 `true` 이 필수 매개 변수를 설정해야 합니다. 이는 호출자가 API의 실험적 특성을 인정하고 변경 내용이 손상되는 가능성을 허용한다는 것을 나타냅니다. 다른 값 또는 누락은 현재 지원되지 않습니다.

요청 본문

Name	형식	Description
timeout	Duration	시간이 초과되기 전의 요청 기간입니다. 기본값은 15분입니다.

응답

Name	형식	Description
200 OK	TableSyncStatus[]	요청이 성공적으로 완료되었습니다.
202 Accepted		요청이 수락되었습니다. SQL 분석 테이블 새로 고침이 진행 중입니다. 헤더 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	일반적인 오류 코드: ItemNotFound - 요청된 항목을 찾을 수 없습니다.

Name

형식

Description

200 OK

TableSyncStatus[]

요청이 성공적으로 완료되었습니다.

202 Accepted

요청이 수락되었습니다. SQL 분석 테이블 새로 고침이 진행 중입니다.

헤더

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

Other Status Codes

ErrorResponse

일반적인 오류 코드:

ItemNotFound - 요청된 항목을 찾을 수 없습니다.

예제

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

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 200

[
  {
    "tableName": "Table 1",
    "startDateTime": "2025-02-04T22:29:12.4400865Z",
    "endDateTime": "2025-02-04T22:29:12.4869641Z",
    "status": "Success",
    "lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
  },
  {
    "tableName": "Table 2",
    "startDateTime": "2025-02-04T22:29:13.4400865Z",
    "endDateTime": "2025-02-04T22:29:13.4869641Z",
    "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": "2024-07-23T14:28:23.1864319Z"
  },
  {
    "tableName": "Table 3",
    "startDateTime": "2025-02-04T22:29:14.4400865Z",
    "endDateTime": "2025-02-04T22:29:14.4869641Z",
    "status": "NotRun",
    "lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
  }
]

정의

Name	Description
Duration	기간입니다.
ErrorRelatedResource	오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse	오류 응답입니다.
ErrorResponseDetails	오류 응답 세부 정보입니다.
SqlEndpointRefreshMetadataRequest	SQL analaytics 엔드포인트 요청 페이로드를 새로 고칩니다.
SyncStatus	동기화 작업의 상태입니다. 시간이 지남에 따라 추가 SyncStatus 형식을 추가할 수 있습니다.
TableSyncStatus	테이블 동기화 상태 개체입니다.
TimeUnit	기간의 시간 단위입니다. 시간이 지남에 따라 추가 기간 유형을 추가할 수 있습니다.

Duration

Object

기간입니다.

Name	형식	Description
timeUnit	TimeUnit	기간의 시간 단위입니다. 시간이 지남에 따라 추가 기간 유형을 추가할 수 있습니다.
value	number	기간의 timeUnits 수입니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name	형식	Description
resourceId	string	오류와 관련된 리소스 ID입니다.
resourceType	string	오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
moreDetails	ErrorResponseDetails[]	추가 오류 세부 정보 목록입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.
requestId	string	오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.

SqlEndpointRefreshMetadataRequest

Object

SQL analaytics 엔드포인트 요청 페이로드를 새로 고칩니다.

Name	형식	Description
timeout	Duration	시간이 초과되기 전의 요청 기간입니다. 기본값은 15분입니다.

SyncStatus

열거형

동기화 작업의 상태입니다. 시간이 지남에 따라 추가 SyncStatus 형식을 추가할 수 있습니다.

값	Description
Failure	오류를 나타냅니다.
NotRun	작업이 실행되지 않았음을 나타냅니다.
Success	성공을 나타냅니다.

TableSyncStatus

Object

테이블 동기화 상태 개체입니다.

Name	형식	Description
endDateTime	string (date-time)	YYYY-MM-DDTHH:mm:ssZ 형식을 사용하여 테이블 동기화가 UTC로 완료된 날짜 및 시간입니다.
error	ErrorResponseDetails	오류 응답 세부 정보
lastSuccessfulSyncDateTime	string (date-time)	YYYY-MM-DDTHH:mm:ssZ 형식을 사용하여 테이블 동기화가 UTC에서 성공한 날짜 및 시간입니다.
startDateTime	string (date-time)	YYYY-MM-DDTHH:mm:ssZ 형식을 사용하여 테이블 동기화가 UTC로 시작된 날짜 및 시간입니다.
status	SyncStatus	테이블이 오류 없이 동기화되었는지 여부입니다.
tableName	string	동기화된 테이블의 이름입니다.

TimeUnit

열거형

기간의 시간 단위입니다. 시간이 지남에 따라 추가 기간 유형을 추가할 수 있습니다.

값	Description
Days	기간(일)입니다.
Hours	기간(시간)입니다.
Minutes	기간(분)입니다.
Seconds	기간(초)입니다.

다음을 통해 공유

Items - Refresh Sql Endpoint Metadata

권한

필요한 위임된 범위

Microsoft Entra 지원 식별자

인터페이스

URI 매개 변수

요청 본문

응답

예제

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

샘플 요청

샘플 응답

정의

Duration

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

SqlEndpointRefreshMetadataRequest

SyncStatus

TableSyncStatus

TimeUnit