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

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.

get

Gets a workspace instance.

list

Gets the workspaces in a subscription.

list_by_resource_group

Gets workspaces in a resource group.

update

Updates a workspace.

begin_create_or_update

Create or update a workspace.

begin_create_or_update(resource_group_name, workspace_name, parameters, **kwargs)

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

The parameters required to 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 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

Exceptions

~azure.core.exceptions.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, workspace_name, force=None, **kwargs)

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.

force
bool
default value: None

Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.

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

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets a workspace instance.

get(resource_group_name, workspace_name, **kwargs)

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

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets the workspaces in a subscription.

list(**kwargs)

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

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_resource_group

Gets workspaces in a resource group.

list_by_resource_group(resource_group_name, **kwargs)

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

Exceptions

~azure.core.exceptions.HttpResponseError

update

Updates a workspace.

update(resource_group_name, workspace_name, parameters, **kwargs)

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
WorkspacePatch
Required

The parameters required to patch a 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

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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