WorkspacesOperations Class

WorkspacesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

WorkspacesOperations

Constructor

WorkspacesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.

async begin_create_or_update(resource_group_name: str, workspace_name: str, parameters: azure.mgmt.databricks.models._models_py3.Workspace, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.databricks.models._models_py3.Workspace]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

workspace_name

str

Required

The name of the workspace.

parameters

Workspace

Required

Parameters supplied to the create or update a workspace.

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 AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either Workspace or the result of cls(response)

Return type

AsyncLROPoller[Workspace]

Exceptions

HttpResponseError

begin_delete

Deletes the workspace.

async begin_delete(resource_group_name: str, workspace_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

workspace_name

str

Required

The name of the workspace.

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 AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_update

Updates a workspace.

async begin_update(resource_group_name: str, workspace_name: str, parameters: azure.mgmt.databricks.models._models_py3.WorkspaceUpdate, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.databricks.models._models_py3.Workspace]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

workspace_name

str

Required

The name of the workspace.

parameters

WorkspaceUpdate

Required

The update to the workspace.

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 AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either Workspace or the result of cls(response)

Return type

AsyncLROPoller[Workspace]

Exceptions

HttpResponseError

get

Gets the workspace.

async get(resource_group_name: str, workspace_name: str, **kwargs) -> azure.mgmt.databricks.models._models_py3.Workspace

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

workspace_name

str

Required

The name of the workspace.

cls

callable

A custom type or function that will be passed the direct response

Returns

Workspace, or the result of cls(response)

Return type

Workspace

Exceptions

HttpResponseError

list_by_resource_group

Gets all the workspaces within a resource group.

list_by_resource_group(resource_group_name: str, **kwargs) -> AsyncIterable[azure.mgmt.databricks.models._models_py3.WorkspaceListResult]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WorkspaceListResult or the result of cls(response)

Return type

AsyncItemPaged[WorkspaceListResult]

Exceptions

HttpResponseError

list_by_subscription

Gets all the workspaces within a subscription.

list_by_subscription(**kwargs) -> AsyncIterable[azure.mgmt.databricks.models._models_py3.WorkspaceListResult]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WorkspaceListResult or the result of cls(response)

Return type

AsyncItemPaged[WorkspaceListResult]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.databricks.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\databricks\\models\\__init__.py'>