WorkspacesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

HealthcareApisManagementClient's

<xref:workspaces> attribute.

Inheritance

builtins.object

WorkspacesOperations

Constructor

WorkspacesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a workspace resource with the specified parameters.
begin_delete	Deletes a specified workspace.
begin_update	Patch workspace details.
get	Gets the properties of the specified workspace.
list_by_resource_group	Lists all the available workspaces under the specified resource group.
list_by_subscription	Lists all the available workspaces under the specified subscription.

begin_create_or_update

Creates or updates a workspace resource with the specified parameters.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
workspace_name Required	str The name of workspace resource. Required.
workspace Required	Workspace or IO[bytes] The parameters for creating or updating a healthcare workspace. Is either a Workspace type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a specified workspace.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
workspace_name Required	str The name of workspace resource. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_update

Patch workspace details.

async begin_update(resource_group_name: str, workspace_name: str, workspace_patch_resource: _models.WorkspacePatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Workspace]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
workspace_name Required	str The name of workspace resource. Required.
workspace_patch_resource Required	WorkspacePatchResource or IO[bytes] The parameters for updating a specified workspace. Is either a WorkspacePatchResource type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets the properties of the specified workspace.

async 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 that contains the service instance. Required.
workspace_name Required	str The name of workspace resource. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists all the available workspaces under the specified resource group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Lists all the available workspaces under the specified subscription.

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

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.healthcareapis.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\healthcareapis\\models\\__init__.py'>