WorkspacesOperations Class

WorkspacesOperations 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.

Constructor

WorkspacesOperations(client, config, serializer, deserializer)

Parameters

Name	Description
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

Name	Description
models	Alias to model classes used in this operation group.

Methods

begin_create_or_update	Creates or updates a workspace.
begin_delete	Deletes a workspace.
begin_update	Updates a workspace.
get	Gets a workspace.
list	Returns a list of workspaces in a subscription.
list_by_resource_group	Returns a list of workspaces in a resource group.

begin_create_or_update

Creates or updates a workspace.

begin_create_or_update(resource_group_name: str, workspace_name: str, workspace_info: '_models.Workspace', **kwargs: Any) -> LROPoller['_models.Workspace']

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
workspace_info Required	Workspace Workspace create or update request properties.

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 Pass in True if you'd like the ARMPolling polling method, False for no polling, or 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 a workspace.

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

Parameters

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

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 Pass in True if you'd like the ARMPolling polling method, False for no polling, or 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[object]	An instance of LROPoller that returns either object or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates a workspace.

begin_update(resource_group_name: str, workspace_name: str, workspace_patch_info: '_models.WorkspacePatchInfo', **kwargs: Any) -> LROPoller['_models.Workspace']

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
workspace_patch_info Required	WorkspacePatchInfo Workspace patch request properties.

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 Pass in True if you'd like the ARMPolling polling method, False for no polling, or 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 a workspace.

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

Parameters

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

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

Returns a list of workspaces in a subscription.

list(**kwargs: Any) -> Iterable['_models.WorkspaceInfoListResult']

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Returns a list of workspaces in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable['_models.WorkspaceInfoListResult']

Parameters

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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