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.

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

begin_create_or_update(resource_group_name: str, workspace_name: str, workspace: azure.mgmt.healthcareapis.models._models_py3.Workspace, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.healthcareapis.models._models_py3.Workspace]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the service instance.

workspace_name

str

Required

The name of workspace resource.

workspace

Workspace

Required

The parameters for creating or updating a healthcare 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 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

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

Return type

LROPoller[Workspace]

Exceptions

HttpResponseError

begin_delete

Deletes a specified workspace.

begin_delete(resource_group_name: str, workspace_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the service instance.

workspace_name

str

Required

The name of workspace resource.

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

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

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_update

Patch workspace details.

begin_update(resource_group_name: str, workspace_name: str, workspace_patch_resource: azure.mgmt.healthcareapis.models._models_py3.WorkspacePatchResource, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.healthcareapis.models._models_py3.Workspace]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the service instance.

workspace_name

str

Required

The name of workspace resource.

workspace_patch_resource

WorkspacePatchResource

Required

The parameters for updating a specified 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 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

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

Return type

LROPoller[Workspace]

Exceptions

HttpResponseError

get

Gets the properties of the specified workspace.

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

Parameters

resource_group_name

str

Required

The name of the resource group that contains the service instance.

workspace_name

str

Required

The name of workspace resource.

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

Lists all the available workspaces under the specified resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.healthcareapis.models._models_py3.WorkspaceList]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the service instance.

cls

callable

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

Returns

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

Return type

ItemPaged[WorkspaceList]

Exceptions

HttpResponseError

list_by_subscription

Lists all the available workspaces under the specified subscription.

list_by_subscription(**kwargs: Any) -> Iterable[azure.mgmt.healthcareapis.models._models_py3.WorkspaceList]

Parameters

cls

callable

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

Returns

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

Return type

ItemPaged[WorkspaceList]

Exceptions

HttpResponseError

Attributes

models

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