NotebookUtils forretningshendelsesverktøy for Fabric

Bruk modulen notebookutils.businessEvents til å publisere forretningshendelser fra en Fabric-notatbok. Du kan publisere en enkelt hendelse eller en batch med hendelser som følger et forretningshendelsesskjema i et hendelsesskjema-sett.

Business Event verktøyene er tilgjengelige i Python 3.12 og PySpark (Python) notatbøker.

Følgende tabell viser de tilgjengelige metodene:

Metode Signatur Beskrivelse
help help(methodName: str = '') -> None Skjermer hjelper for modulen eller den angitte metoden.
publish publish(eventSchemaSetWorkspace: str, eventSchemaSet: str, eventTypeName: str, eventData: Union[Dict[str, Any], List[Dict[str, Any]]], dataVersion: str = 'v1') -> bool Publiserer ett eller flere forretningsarrangementer til den angitte arrangementstypen.

Få hjelp

Kjør følgende kommando for å få en oversikt over modulen:

notebookutils.businessEvents.help()

For å få hjelp med metoden publish , spesifiser metodens navn:

notebookutils.businessEvents.help("publish")

Publiser et forretningsarrangement

Bruk publish() for å sende en nyttelast som matcher skjemaet til en forretningshendelse:

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

print(f"Published: {published}")

Følgende tabell beskriver parameterne:

Parameteren Type: Beskrivelse
eventSchemaSetWorkspace string Navnet eller ID-en til arbeidsområdet som inneholder hendelsesskjemasettet.
eventSchemaSet string Navnet eller ID-en til hendelsesskjemasettet.
eventTypeName string Navnet på forretningsarrangementet som skal publiseres.
eventData Ordbok eller liste over ordbøker Hendelseslasten. Hver ordbok må følge det valgte forretningshendelsesskjemaet.
dataVersion string Versjonen av forretningshendelsesskjemaet. Standardverdien er v1.

Metoden returnerer True når hendelsen publiseres vellykket. Hvis hendelsen ikke kan publiseres, oppretter metoden et unntak.

Publisere flere forretningsarrangementer

For å publisere flere hendelser av samme type i ett kall, send en liste med ordbøker til 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}")

Alle nyttelaster i listen må følge skjemaversjonen spesifisert av dataVersion.

Vurderinger

  • Lag forretningshendelsestypen og skjemaet før du publiserer hendelser fra en notatbok.
  • Bruk enten navn eller ID-er for eventSchemaSetWorkspace og eventSchemaSet.
  • Samsvar med egenskapsnavn, datatyper og nødvendige felt i eventData den valgte skjemaversjonen.
  • Håndter unntak fra publish() slik at notatboken og pipeline-kjøringene rapporterer publiseringsfeil.

Relatert innhold

  • Last updated on