NotebookUtils forretningsbegivenhedsværktøjer til Fabric

Brug modulet notebookutils.businessEvents til at offentliggøre forretningsbegivenheder fra en Fabric-notesbog. Du kan udgive en enkelt begivenhed eller en batch af begivenheder, der følger et forretningsbegivenhedsskema i et hændelsesskema-sæt.

Business event-værktøjerne er tilgængelige i Python 3.12 og PySpark (Python) notebooks.

Følgende tabel viser de tilgængelige metoder:

Metode Signatur Beskrivelse
help help(methodName: str = '') -> None Skærme hjælper med modulet eller den angivne metode.
publish publish(eventSchemaSetWorkspace: str, eventSchemaSet: str, eventTypeName: str, eventData: Union[Dict[str, Any], List[Dict[str, Any]]], dataVersion: str = 'v1') -> bool Udgiver en eller flere forretningsbegivenheder til den angivne begivenhedstype.

Få hjælp

Kør følgende kommando for at få et overblik over modulet:

notebookutils.businessEvents.help()

For at få hjælp til metoden publish , angiv metodens navn:

notebookutils.businessEvents.help("publish")

Udgiv en forretningsbegivenhed

Note

Udgivelse af forretningsarrangementer på tværs af regioner understøttes. Publisher-elementet behøver ikke at være i samme region som Event Schema Set-elementet, der indeholder forretningsbegivenheden. Eksisterende tilladelser og netværksadgangskrav gælder stadig.

Brug publish() til at sende en payload, der matcher skemaet for en forretningsbegivenhed:

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 tabel beskriver parametrene:

Parameter Type Beskrivelse
eventSchemaSetWorkspace String Navnet eller ID'et på arbejdsområdet, der indeholder hændelsesskemasættet.
eventSchemaSet String Navnet eller ID'et på begivenhedsskemasættet.
eventTypeName String Navnet på den type forretningsbegivenhed, der skal udgives.
eventData Ordbog eller liste over ordbøger Begivenhedens nyttelast. Hver ordbog skal overholde det valgte forretningsbegivenhedsskema.
dataVersion String Versionen af forretningsbegivenhedsskemaet. Standarden er v1.

Metoden returneres, True når begivenheden udgives med succes. Hvis begivenheden ikke kan offentliggøres, skaber metoden en undtagelse.

Udgiv flere forretningsarrangementer

For at publicere flere begivenheder af samme type i ét kald, send en liste af ordbøger 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 skal overholde skemaversionen specificeret af dataVersion.

Overvejelser

  • Opret forretningshændelsestypen og dens skema, før du udgiver begivenheder fra en notesbog.
  • Brug enten navne eller ID'er for eventSchemaSetWorkspace og eventSchemaSet.
  • Match egenskabsnavne, datatyper og nødvendige felter i eventData den valgte skemaversion.
  • Håndter undtagelser fra publish() , så notebook- og pipeline-kørsler rapporterer publiceringsfejl.

Relateret indhold

  • Sidst opdateret den