sempy_labs.deployment_pipeline package
Module contents
- sempy_labs.deployment_pipeline.assign_workspace_to_stage(deployment_pipeline: str | UUID, stage: str | UUID, workspace: str | UUID | None = None)
Unassigns the workspace from the specified stage of the specified deployment pipeline.
This is a wrapper function for the following API: Deployment Pipelines - Assign Workspace To Stage.
Service Principal Authentication is supported (see here for examples).
- Parameters:
deployment_pipeline (str | uuid.UUID) – The deployment pipeline name or ID.
stage (str | uuid.UUID) – The deployment pipeline stage name or ID.
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.deployment_pipeline.delete_deployment_pipeline(deployment_pipeline: str | UUID)
Deletes the specified deployment pipeline.
This is a wrapper function for the following API: Deployment Pipelines - Delete Deployment Pipeline.
Service Principal Authentication is supported (see here for examples).
- sempy_labs.deployment_pipeline.deploy_stage_content(deployment_pipeline: str | UUID, source_stage_id: UUID, target_stage_id: UUID, items: dict | List[dict] | None = None, note: str | None = None, allow_cross_region_deployment: bool | None = False, capacity: str | UUID | None = None, workspace_name: str | None = None)
Deploys items from the specified stage of the specified deployment pipeline.
This is a wrapper function for the following API: Deployment Pipelines - Deploy Stage Content.
Service Principal Authentication is supported (see here for examples).
- Parameters:
deployment_pipeline (str | uuid.UUID) – The deployment pipeline name or ID.
source_stage_id (uuid.UUID) – The source deployment pipeline stage ID.
target_stage_id (uuid.UUID) – The target deployment pipeline stage ID.
items (dict | List[dict], default=None) –
A list of items to deploy. Each item should be a dictionary with the following structure: {
”sourceItemId”: “1a201f2a-d1d8-45c0-8c61-1676338517de”, “itemType”: “SemanticModel”
} If None, all items will be deployed.
note (str, default=None) – An optional note to include with the deployment.
allow_cross_region_deployment (bool, default=False) – Indicates whether cross region deployment is enabled. True - enabled, False - disabled. Default value is False.
capacity (str | uuid.UUID, default=None) – The capacity name or ID to use for the deployment operation if creating a new workspace. Required when deploying to a stage that has no assigned workspaces, otherwise it is ignored. The deployment will fail if the new workspace configuration details aren’t provided when required.
workspace_name (str, default=None) – The workspace name to use for the deployment operation if creating a new workspace. Required when deploying to a stage that has no assigned workspaces, otherwise it is ignored. The deployment will fail if the new workspace configuration details aren’t provided when required.
- sempy_labs.deployment_pipeline.list_deployment_pipeline_operations(deployment_pipeline: str | UUID) DataFrame
Shows the operations for the specified deployment pipeline.
This is a wrapper function for the following API: Deployment Pipelines - List Deployment Pipeline Operations.
Service Principal Authentication is supported (see here for examples).
- sempy_labs.deployment_pipeline.list_deployment_pipeline_role_assignments(deployment_pipeline: str | UUID) DataFrame
Shows the role assignments for the specified deployment pipeline.
This is a wrapper function for the following API: Deployment Pipelines - List Deployment Pipeline Role Assignments.
Service Principal Authentication is supported (see here for examples).
- sempy_labs.deployment_pipeline.list_deployment_pipeline_stage_items(deployment_pipeline: str | UUID, stage: str | UUID) DataFrame
Shows the supported items from the workspace assigned to the specified stage of the specified deployment pipeline.
This is a wrapper function for the following API: Deployment Pipelines - List Deployment Pipeline Stage Items.
Service Principal Authentication is supported (see here for examples).
- Parameters:
- Returns:
A pandas dataframe showing the supported items from the workspace assigned to the specified stage of the specified deployment pipeline.
- Return type:
- sempy_labs.deployment_pipeline.list_deployment_pipeline_stages(deployment_pipeline: str | UUID) DataFrame
Shows the specified deployment pipeline stages.
This is a wrapper function for the following API: Deployment Pipelines - List Deployment Pipeline Stages.
Service Principal Authentication is supported (see here for examples).
- sempy_labs.deployment_pipeline.list_deployment_pipelines() DataFrame
Shows a list of deployment pipelines the user can access.
This is a wrapper function for the following API: Deployment Pipelines - List Deployment Pipelines.
Service Principal Authentication is supported (see here for examples).
- Returns:
A pandas dataframe showing a list of deployment pipelines the user can access.
- Return type:
- sempy_labs.deployment_pipeline.unassign_workspace_from_stage(deployment_pipeline: str | UUID, stage: str | UUID)
Unassigns the workspace from the specified stage of the specified deployment pipeline.
This is a wrapper function for the following API: Deployment Pipelines - Unassign Workspace From Stage.
Service Principal Authentication is supported (see here for examples).