Fabric용 NotebookUtils 비즈니스 이벤트 유틸리티

이 모듈을 notebookutils.businessEvents 사용해 Fabric 노트북에서 비즈니스 이벤트를 게시하세요. 비즈니스 이벤트 스키마를 따르는 단일 이벤트 또는 이벤트 스키마 세트에 이벤트 배치를 게시할 수 있습니다.

비즈니스 이벤트 유틸리티는 Python 3.12와 PySpark(Python) 노트북에서 제공됩니다.

다음 표는 사용 가능한 방법들을 나열합니다:

Method Signature Description
help help(methodName: str = '') -> None 모듈 또는 지정된 방법에 대한 도움말을 표시합니다.
publish publish(eventSchemaSetWorkspace: str, eventSchemaSet: str, eventTypeName: str, eventData: Union[Dict[str, Any], List[Dict[str, Any]]], dataVersion: str = 'v1') -> bool 지정된 이벤트 유형에 대해 하나 이상의 비즈니스 이벤트를 게시합니다.

도움받기

다음 명령어를 실행하여 모듈의 개요를 확인하세요:

notebookutils.businessEvents.help()

publish 메서드에 대한 도움말을 보려면 메서드 이름을 지정하세요:

notebookutils.businessEvents.help("publish")

비즈니스 행사를 게시하기

비즈니스 이벤트 스키마와 일치하는 페이로드를 전송하기 위해 사용 publish() 하세요:

published = notebookutils.businessEvents.publish(
    eventSchemaSetWorkspace="ContosoWorkspace",
    eventSchemaSet="OrderEvents",
    eventTypeName="OrderDelayed",
    eventData={
        "orderId": "12345",
        "status": "delayed",
        "reason": "weather"
    },
    dataVersion="v1"
)

print(f"Published: {published}")

다음 표는 매개 변수를 설명합니다.

매개 변수 Type Description
eventSchemaSetWorkspace 문자열 이벤트 스키마 세트를 포함하는 작업 공간의 이름이나 ID입니다.
eventSchemaSet 문자열 이벤트 스키마 집합의 이름이나 ID입니다.
eventTypeName 문자열 게시할 비즈니스 이벤트 유형의 이름.
eventData 사전 또는 사전 목록 이벤트 페이로드입니다. 각 사전은 선택된 비즈니스 이벤트 스키마에 부합해야 합니다.
dataVersion 문자열 비즈니스 이벤트 스키마의 버전입니다. 기본값은 v1입니다.

이벤트가 성공적으로 게시되면 이 메서드는 True를 반환합니다. 이벤트를 게시할 수 없으면 메서드가 예외를 생성합니다.

여러 비즈니스 행사를 게시하세요

동일한 유형의 여러 이벤트를 한 번의 호출로 게시하려면, 딕셔너리 목록을 eventData에 전달하세요:

published = notebookutils.businessEvents.publish(
    eventSchemaSetWorkspace="ContosoWorkspace",
    eventSchemaSet="OrderEvents",
    eventTypeName="OrderDelayed",
    eventData=[
        {
            "orderId": "12345",
            "status": "delayed",
            "reason": "weather"
        },
        {
            "orderId": "12346",
            "status": "delayed",
            "reason": "traffic"
        }
    ],
    dataVersion="v1"
)

print(f"Published: {published}")

리스트 내 모든 페이로드는 에 의해 dataVersion지정된 스키마 버전을 준수해야 합니다.

Considerations

  • 노트에서 이벤트를 게시하기 전에 비즈니스 이벤트 유형과 그 스키마를 만드세요.
  • eventSchemaSet와 eventSchemaSetWorkspace에 대해 이름 또는 ID를 사용하세요.
  • 선택한 스키마 버전에 속성 eventData 이름, 데이터 타입, 필수 필드를 맞추세요.
  • 노트북 및 파이프라인 실행에서 게시 실패를 보고하도록 publish()의 예외를 처리하세요.

관련 콘텐츠

  • Last updated on