NotebookUtils – narzędzia do wydarzeń biznesowych dla Fabric

Użyj modułunotebookutils.businessEvents, aby publikować wydarzenia biznesowe z notatnika Fabric. Możesz opublikować pojedyncze zdarzenie lub partię zdarzeń, które podążają za schematem biznesowego zdarzenia w zbiorze schematów zdarzeń.

Narzędzia do wydarzeń biznesowych są dostępne w notatnikach Python 3.12 oraz PySpark (Python).

Poniższa tabela przedstawia dostępne metody:

Method Signature Opis
help help(methodName: str = '') -> None Wyświetla pomoc dla modułu lub określonej metody.
publish publish(eventSchemaSetWorkspace: str, eventSchemaSet: str, eventTypeName: str, eventData: Union[Dict[str, Any], List[Dict[str, Any]]], dataVersion: str = 'v1') -> bool Publikuje jedno lub więcej wydarzeń biznesowych do określonego typu wydarzenia.

Uzyskaj pomoc

Wykonaj następujące polecenie, aby zobaczyć przegląd modułu:

notebookutils.businessEvents.help()

Aby uzyskać pomoc dla metody publish , podaj nazwę metody:

notebookutils.businessEvents.help("publish")

Opublikuj wydarzenie biznesowe

Note

Wspierane jest publikowanie wydarzeń biznesowych w różnych regionach. Element wydawcy nie musi znajdować się w tym samym regionie co element Event Schema Set, który zawiera wydarzenie biznesowe. Istniejące uprawnienia i wymagania dotyczące dostępu do sieci nadal obowiązują.

Użyj publish() do wysłania ładunku odpowiadającego schematowi wydarzenia biznesowego:

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

print(f"Published: {published}")

W poniższej tabeli opisano parametry:

Parametr Typ Opis
eventSchemaSetWorkspace String Nazwa lub identyfikator przestrzeni roboczej zawierającej zestaw schematu zdarzeń.
eventSchemaSet String Nazwa lub identyfikator zbioru schematu zdarzeń.
eventTypeName String Nazwa typu wydarzenia biznesowego do publikacji.
eventData Słownik lub lista słowników Ładunek zdarzeń. Każdy słownik musi odpowiadać wybranemu schematowi wydarzenia biznesowego.
dataVersion String Wersja schematu wydarzeń biznesowych. Wartość domyślna to v1.

Metoda zwraca True, jeśli publikacja zdarzenia zakończy się pomyślnie. Jeśli zdarzenie nie może zostać opublikowane, metoda ta wywołuje wyjątek.

Publikuj wiele wydarzeń firmowych

Aby opublikować wiele zdarzeń tego samego typu w jednym wywołaniu, należy przekazać listę słowników do 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}")

Wszystkie ładunki na liście muszą być zgodne z wersją schematu określoną przez dataVersion.

Rozważania

  • Stwórz typ wydarzenia biznesowego i jego schemat przed publikacją wydarzeń z notatnika.
  • Używaj nazw lub identyfikatorów dla eventSchemaSetWorkspace i eventSchemaSet.
  • Dopasuj nazwy właściwości, typy danych i wymagane pola w eventData do wybranej wersji schematu.
  • Obsługuj wyjątki tak publish() , aby notatnik i pipeline uruchamiały raporty o niepowodzeniach publikowania.