WorkspacesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AzureDatabricksManagementClient's

<xref:workspaces> attribute.

Constructor

WorkspacesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates a new workspace.
begin_delete	Deletes the workspace.
begin_update	Updates a workspace.
get	Gets the workspace.
list_by_resource_group	Gets all the workspaces within a resource group.
list_by_subscription	Gets all the workspaces within a subscription.

begin_create_or_update

Creates a new workspace.

begin_create_or_update(resource_group_name: str, workspace_name: str, parameters: _models.Workspace, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Workspace]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
workspace_name Required	str The name of the workspace. Required.
parameters Required	Workspace or IO Parameters supplied to the create or update a workspace. Is either a Workspace type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[Workspace]	An instance of LROPoller that returns either Workspace or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the workspace.

begin_delete(resource_group_name: str, workspace_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
workspace_name Required	str The name of the workspace. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates a workspace.

begin_update(resource_group_name: str, workspace_name: str, parameters: _models.WorkspaceUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Workspace]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
workspace_name Required	str The name of the workspace. Required.
parameters Required	WorkspaceUpdate or IO The update to the workspace. Is either a WorkspaceUpdate type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[Workspace]	An instance of LROPoller that returns either Workspace or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the workspace.

get(resource_group_name: str, workspace_name: str, **kwargs: Any) -> Workspace

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
workspace_name Required	str The name of the workspace. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Workspace	Workspace or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Gets all the workspaces within a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[Workspace]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[Workspace]	An iterator like instance of either Workspace or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Gets all the workspaces within a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[Workspace]

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[Workspace]	An iterator like instance of either Workspace or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.databricks.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv108\\Lib\\site-packages\\azure\\mgmt\\databricks\\models\\__init__.py'>