WorkspacesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:workspaces> attribute.

Constructor

WorkspacesOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update a workspace.
begin_delete	Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.
begin_failback	Deactivates failover for the specified workspace. The failback operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.
begin_failover	Activates failover for the specified workspace. The specified replication location must match the location of the enabled replication for this workspace. The failover operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.
begin_reconcile_nsp	Reconcile network security perimeter configuration for Workspace resource.
get	Gets a workspace instance.
get_nsp	Gets a network security perimeter configuration.
list	Gets the workspaces in a subscription.
list_by_resource_group	Gets workspaces in a resource group.
list_nsp	Gets a list of NSP configurations for specified workspace.
update	Updates a workspace.

begin_create_or_update

Create or update a 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 <xref:JSON> or IO[bytes] The parameters required to create or update a workspace. Is one of the following types: Workspace, JSON, IO[bytes] Required.

Returns

Type	Description
LROPoller[Workspace]	An instance of LROPoller that returns Workspace. The Workspace is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.

begin_delete(resource_group_name: str, workspace_name: str, *, force: bool | None = None, **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
force	bool Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered. Default value is None. Default value: None

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_failback

Deactivates failover for the specified workspace.

The failback operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.

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

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_failover

Activates failover for the specified workspace.

The specified replication location must match the location of the enabled replication for this workspace. The failover operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.

begin_failover(resource_group_name: str, location: 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.
location Required	str The location name. Required.
workspace_name Required	str The name of the workspace. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_reconcile_nsp

Reconcile network security perimeter configuration for Workspace resource.

begin_reconcile_nsp(resource_group_name: str, workspace_name: str, network_security_perimeter_configuration_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.
network_security_perimeter_configuration_name Required	str The name for a network security perimeter configuration. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

get

Gets a workspace instance.

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.

Returns

Type	Description
Workspace	Workspace. The Workspace is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_nsp

Gets a network security perimeter configuration.

get_nsp(resource_group_name: str, workspace_name: str, network_security_perimeter_configuration_name: str, **kwargs: Any) -> NetworkSecurityPerimeterConfiguration

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.
network_security_perimeter_configuration_name Required	str The name for a network security perimeter configuration. Required.

Returns

Type	Description
NetworkSecurityPerimeterConfiguration	NetworkSecurityPerimeterConfiguration. The NetworkSecurityPerimeterConfiguration is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Gets the workspaces in a subscription.

list(**kwargs: Any) -> ItemPaged[Workspace]

Returns

Type	Description
ItemPaged[Workspace]	An iterator like instance of Workspace

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Gets workspaces in a resource group.

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

Parameters

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

Returns

Type	Description
ItemPaged[Workspace]	An iterator like instance of Workspace

Exceptions

Type	Description
HttpResponseError

list_nsp

Gets a list of NSP configurations for specified workspace.

list_nsp(resource_group_name: str, workspace_name: str, **kwargs: Any) -> ItemPaged[NetworkSecurityPerimeterConfiguration]

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.

Returns

Type	Description
ItemPaged[NetworkSecurityPerimeterConfiguration]	An iterator like instance of NetworkSecurityPerimeterConfiguration

Exceptions

Type	Description
HttpResponseError

update

Updates a workspace.

update(resource_group_name: str, workspace_name: str, parameters: _models.WorkspacePatch, *, content_type: str = 'application/json', **kwargs: Any) -> _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	WorkspacePatch or <xref:JSON> or IO[bytes] The parameters required to patch a workspace. Is one of the following types: WorkspacePatch, JSON, IO[bytes] Required.

Returns

Type	Description
Workspace	Workspace. The Workspace is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Commenti e suggerimenti

Questa pagina è stata utile?