sempy_labs.environment package

Module contents

sempy_labs.environment.create_environment(environment: str, description: str | None = None, workspace: str | UUID | None = None)

Creates a Fabric environment.

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

Parameters:

environment (str) – Name of the environment.
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.environment.delete_environment(environment: str | UUID, workspace: str | UUID | None = None)

Deletes a Fabric environment.

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

Parameters:

environment (str | uuid.UUID) – Name or ID 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.environment.get_published_spark_compute(environment: str | UUID, workspace: str | UUID | None = None) → DataFrame

Gets the Spark compute of a published Fabric environment.

This is a wrapper function for the following API: Published - Get Spark Compute.

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

Parameters:

environment (str | uuid.UUID) – Name or ID 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.environment.get_staging_spark_compute(environment: str | UUID, workspace: str | UUID | None = None) → DataFrame

Gets the Spark compute of a staging Fabric environment.

This is a wrapper function for the following API: Staging - Get Spark Compute.

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

Parameters:

environment (str | uuid.UUID) – Name or ID 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.environment.list_environments(workspace: str | UUID | None = None) → DataFrame

Shows the environments within a workspace.

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

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

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 environments within a workspace.
Return type:: pandas.DataFrame

sempy_labs.environment.list_published_libraries(environment: str | UUID, workspace: str | UUID | None = None) → DataFrame

Gets the published libraries of a Fabric environment.

This is a wrapper function for the following API: Published - List Libraries.

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

Parameters:

environment (str | uuid.UUID) – Name or ID 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.environment.list_staging_libraries(environment: str | UUID, workspace: str | UUID | None = None) → DataFrame

Gets the staging libraries of a Fabric environment.

This is a wrapper function for the following API: Staging - List Libraries.

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

Parameters:

environment (str | uuid.UUID) – Name or ID 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.environment.publish_environment(environment: str | UUID, workspace: str | UUID | None = None)

Publishes a Fabric environment.

This is a wrapper function for the following API: Spark Libraries - Publish Environment.

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

Parameters:

environment (str | uuid.UUID) – Name or ID 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.