sempy_labs.kql_dashboard package

Module contents

sempy_labs.kql_dashboard.create_kql_dashboard(name: str, content: str | None = None, description: str | None = None, workspace: str | UUID | None = None)

Creates a KQL dashboard.

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

Parameters:

  • name (str) – Name of the KQL dashboard.

  • content (Optional[dict], default=None) – The RealTimeDashboard.json content.

  • 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.kql_dashboard.create_workspace_monitoring_dashboard(name: str = 'Fabric Workspace Monitoring Dashboard', workspace: str | UUID | None = None)

Creates a workspace monitoring dashboard based on this template.

This function requires the workspace to have workspace monitoring enabled.

Parameters:

  • name (str, default="Fabric Workspace Monitoring Dashboard") – The name of the workspace monitoring dashboard.

  • 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.kql_dashboard.delete_kql_dashboard(kql_dashboard: str | UUID, workspace: str | UUID | None = None)

Deletes a KQL dashboard.

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

Parameters:

  • kql_dashboard (str | uuid.UUID) – Name or ID of the KQL dashboard.

  • 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.kql_dashboard.list_kql_dashboards(workspace: str | UUID | None = None) → DataFrame

Shows the KQL dashboards within a workspace.

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

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 KQL dashboards within a workspace.

Return type:

pandas.DataFrame