NotebookUtils nástroje pro obchodní akce pro Fabric

Použijte notebookutils.businessEvents modul k publikování obchodních událostí z Fabric notebooku. Můžete publikovat jednu událost nebo sadu událostí, které následují schéma obchodních událostí, v sadě schématu událostí.

Nástroje pro obchodní události jsou k dispozici v noteboocích Python 3.12 a PySpark (Python).

Následující tabulka uvádí dostupné metody:

Method Signature Description
help help(methodName: str = '') -> None Zobrazí nápovědu k modulu nebo zadané metodě.
publish publish(eventSchemaSetWorkspace: str, eventSchemaSet: str, eventTypeName: str, eventData: Union[Dict[str, Any], List[Dict[str, Any]]], dataVersion: str = 'v1') -> bool Publikuje jednu nebo více obchodních akcí podle určeného typu události.

Získání pomoci

Pro přehled modulu spusťte následující příkaz:

notebookutils.businessEvents.help()

Pro pomoc s metodou publish zadejte název metody:

notebookutils.businessEvents.help("publish")

Vydat obchodní událost

Použijte publish() pro odeslání payloadu, který odpovídá schématu obchodní události:

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

print(f"Published: {published}")

Následující tabulka popisuje parametry:

Parametr Typ Description
eventSchemaSetWorkspace String Název nebo ID pracovního prostoru, který obsahuje sadu schématu událostí.
eventSchemaSet String Název nebo ID sady schématu událostí.
eventTypeName String Název typu obchodní události, kterou chcete publikovat.
eventData Slovník nebo seznam slovníků Datová část události. Každý slovník musí odpovídat vybranému schématu obchodní události.
dataVersion String Verze schématu obchodních událostí. Výchozí hodnota je v1.

Metoda vrátí True, pokud je událost úspěšně publikována. Pokud událost nelze publikovat, metoda vyvolává výjimku.

Publikujte více obchodních akcí

Pro publikaci více událostí stejného typu v jednom hovoru předejte seznam slovníků na 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}")

Všechny datové části v seznamu musí odpovídat verzi schématu určené pomocí dataVersion.

Considerations

  • Vytvořte typ obchodní události a jeho schéma před publikováním akcí z poznámkového bloku.
  • Použijte jména nebo ID pro eventSchemaSetWorkspace a eventSchemaSet.
  • Porovnejte názvy vlastností, datové typy a povinná pole v eventData s vybranou verzí schématu.
  • Zpracujte výjimky z publish(), aby spuštění notebooku a kanálu hlásila chyby při publikování.

Související obsah

  • Last updated on