다음을 통해 공유

Items - Update Eventstream Definition

서비스:
Eventstream
API 버전:
v1

지정된 eventstream의 정의를 업데이트합니다. 업데이트는 현재 정의를 재정의합니다.
이 API는 LRO(장기 실행 작업)지원합니다.

eventstream 정의를 업데이트해도 해당 민감도 레이블에는 영향을 주지 않습니다.

권한

호출자에게 eventstream에 대한 읽기 및 쓰기 권한이 있어야 합니다.

필요한 위임된 범위

Eventstream.ReadWrite.All 또는 Item.ReadWrite.All

Microsoft Entra 지원 식별자

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

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

인터페이스

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition
선택적 매개 변수: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition?updateMetadata={updateMetadata}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
eventstreamId
 path True

string (uuid)

이벤트스트림 ID입니다.
workspaceId
 path True

string (uuid)

작업 영역 ID입니다.
updateMetadata
 query

boolean

항목의 메타데이터가 파일에 제공된 .platform 경우 업데이트할지 여부입니다. True - 정의의 일부로 파일에 제공된 경우 메타데이터를 .platform 업데이트합니다. False - 메타데이터를 업데이트하지 마세요.

요청 본문

Name 필수 형식 Description
definition True

EventstreamDefinition

Eventstream 공용 정의 개체입니다.

응답

Name 형식 Description
200 OK

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

요청이 수락되었습니다. 업데이트 정의가 진행 중입니다.

헤더

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

일반적인 오류 코드:

  • OperationNotSupportedForItem - 요청된 항목에 대해 지원되지 않는 작업입니다.

  • CorruptedPayload - 제공된 페이로드가 손상되었습니다.

예제

Update an eventstream definition example

샘플 요청

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventstreams/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "eventstream.json",
        "payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
        "payloadType": "InlineBase64"
      },
      {
        "path": "eventstreamProperties.json",
        "payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

샘플 응답

상태 코드:
200
상태 코드:
202 
Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

정의

Name Description
ErrorRelatedResource

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

오류 응답입니다.
ErrorResponseDetails

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

Eventstream 공용 정의 개체입니다.
EventstreamDefinitionPart

Eventstream 정의 파트 개체입니다.
PayloadType

정의 파트 페이로드의 형식입니다. 추가 페이로드 유형은 시간이 지남에 따라 추가될 수 있습니다.
UpdateEventstreamDefinitionRequest

eventstream 공용 정의 요청 페이로드를 업데이트합니다.

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

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

EventstreamDefinition

Object

Eventstream 공용 정의 개체입니다.

Name 형식 Description
format

string

항목 정의의 형식입니다.
parts

EventstreamDefinitionPart[]

정의 부분 목록입니다.

EventstreamDefinitionPart

Object

Eventstream 정의 파트 개체입니다.

Name 형식 Description
path

string

eventstream 파트 경로입니다.
payload

string

eventstream 부분 페이로드입니다.
payloadType

PayloadType

페이로드 형식입니다.

PayloadType

열거형

정의 파트 페이로드의 형식입니다. 추가 페이로드 유형은 시간이 지남에 따라 추가될 수 있습니다.

값 Description
InlineBase64

인라인 베이스 64.

UpdateEventstreamDefinitionRequest

Object

eventstream 공용 정의 요청 페이로드를 업데이트합니다.

Name 형식 Description
definition

EventstreamDefinition

Eventstream 공용 정의 개체입니다.