sempy_labs.eventstream package

Module contents

sempy_labs.eventstream.create_eventstream(name: str, description: str | None = None, workspace: str | UUID | None = None)

Creates a Fabric eventstream.

This is a wrapper function for the following API: Items - Create Eventstream.

Parameters:

name (str) – Name of the eventstream.
description (str, default=None) – A description of the environment.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

sempy_labs.eventstream.delete_eventstream(eventstream: str | UUID, workspace: str | UUID | None = None, **kwargs)

Deletes a Fabric eventstream.

This is a wrapper function for the following API: Items - Delete Eventstream.

Parameters:

eventstream (str | uuid.UUID) – Name or ID of the eventstream.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

sempy_labs.eventstream.get_eventstream_definition(eventstream: str | UUID, workspace: str | UUID | None = None, decode: bool = True, return_dataframe: bool = False) → dict

sempy_labs.eventstream.get_eventstream_destination(eventstream: str | UUID, destination_id: UUID, workspace: str | UUID | None = None) → DataFrame

Returns the specified destination of the eventstream.

This is a wrapper function for the following API: Topology - Get Eventstream Destination.

Service Principal Authentication is supported (see here for examples).

Parameters:

eventstream (str | uuid.UUID) – The name or ID of the eventstream.
destination_id (uuid.UUID) – The ID of the destination.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

Returns:

A pandas dataframe showing the details of the destination.

Return type:

pandas.DataFrame

sempy_labs.eventstream.get_eventstream_destination_connection(eventstream: str | UUID, destination_id: UUID, workspace: str | UUID | None = None) → DataFrame

Returns the connection information of a specified destination of the eventstream. Only custom endpoints destinations are supported.

This is a wrapper function for the following API: Topology - Get Eventstream Destination Connection.

Service Principal Authentication is supported (see here for examples).

Parameters:

eventstream (str | uuid.UUID) – The name or ID of the eventstream.
destination_id (uuid.UUID) – The ID of the destination.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

Returns:

A pandas dataframe showing the connection details of the destination.

Return type:

pandas.DataFrame

sempy_labs.eventstream.get_eventstream_source(eventstream: str | UUID, source_id: UUID, workspace: str | UUID | None = None) → DataFrame

Returns the specified source of the eventstream.

This is a wrapper function for the following API: Topology - Get Eventstream Source.

Service Principal Authentication is supported (see here for examples).

Parameters:

eventstream (str | uuid.UUID) – The name or ID of the eventstream.
source_id (uuid.UUID) – The ID of the source.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

Returns:

A pandas dataframe showing the details of the source.

Return type:

pandas.DataFrame

sempy_labs.eventstream.get_eventstream_source_connection(eventstream: str | UUID, source_id: UUID, workspace: str | UUID | None = None) → DataFrame

Returns the connection information of specified source of the eventstream. Only custom endpoints sources are supported.

This is a wrapper function for the following API: Topology - Get Eventstream Source Connection.

Service Principal Authentication is supported (see here for examples).

Parameters:

eventstream (str | uuid.UUID) – The name or ID of the eventstream.
source_id (uuid.UUID) – The ID of the source.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

Returns:

A pandas dataframe showing the connection details of the source.

Return type:

pandas.DataFrame

sempy_labs.eventstream.get_eventstream_topology(eventstream: str | UUID, workspace: str | UUID | None = None) → DataFrame

Returns the topology of the specified eventstream.

This is a wrapper function for the following API: Topology - Get Eventstream Topology.

Service Principal Authentication is supported (see here for examples).

Parameters:

eventstream (str | uuid.UUID) – The name or ID of the eventstream.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

Returns:

A pandas dataframe showing the topology of the eventstream, including sources and destinations.

Return type:

pandas.DataFrame

sempy_labs.eventstream.list_eventstreams(workspace: str | UUID | None = None) → DataFrame

Shows the eventstreams within a workspace.

This is a wrapper function for the following API: Items - List Eventstreams.

Parameters:: workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.
Returns:: A pandas dataframe showing the eventstreams within a workspace.
Return type:: pandas.DataFrame

sempy_labs.eventstream.pause_eventstream(eventstream: str | UUID, workspace: str | UUID | None = None) → dict

Pause running all supported sources and destinations of the eventstream.

This is a wrapper function for the following API: Topology - Pause Eventstream.

Service Principal Authentication is supported (see here for examples).

Parameters:

eventstream (str | uuid.UUID) – The name or ID of the eventstream.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

sempy_labs.eventstream.pause_eventstream_destination(eventstream: str | UUID, destination_id: UUID, workspace: str | UUID | None = None)

Pause running the specified destination in the eventstream.

This is a wrapper function for the following API: Topology - Pause Eventstream Destination.

Service Principal Authentication is supported (see here for examples).

Parameters:

eventstream (str | uuid.UUID) – The name or ID of the eventstream.
destination_id (uuid.UUID) – The ID of the destination.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

sempy_labs.eventstream.pause_eventstream_source(eventstream: str | UUID, source_id: UUID, workspace: str | UUID | None = None)

Pause running the specified source in the eventstream.

This is a wrapper function for the following API: Topology - Pause Eventstream Source.

Service Principal Authentication is supported (see here for examples).

Parameters:

eventstream (str | uuid.UUID) – The name or ID of the eventstream.
source_id (uuid.UUID) – The ID of the source.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

sempy_labs.eventstream.resume_eventstream(eventstream: str | UUID, workspace: str | UUID | None = None)

Resume running all supported sources and destinations of the eventstream.

This is a wrapper function for the following API: Topology - Resume Eventstream.

Service Principal Authentication is supported (see here for examples).

Parameters:

eventstream (str | uuid.UUID) – The name or ID of the eventstream.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

sempy_labs.eventstream.resume_eventstream_destination(eventstream: str | UUID, destination_id: UUID, workspace: str | UUID | None = None)

Resume running the specified destination in the eventstream.

This is a wrapper function for the following API: Topology - Resume Eventstream Destination.

Service Principal Authentication is supported (see here for examples).

Parameters:

eventstream (str | uuid.UUID) – The name or ID of the eventstream.
destination_id (uuid.UUID) – The ID of the destination.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

sempy_labs.eventstream.resume_eventstream_source(eventstream: str | UUID, source_id: UUID, workspace: str | UUID | None = None)

Resume running the specified source in the eventstream.

This is a wrapper function for the following API: Topology - Resume Eventstream Source.

Service Principal Authentication is supported (see here for examples).

Parameters:

eventstream (str | uuid.UUID) – The name or ID of the eventstream.
source_id (uuid.UUID) – The ID of the source.
workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.