WorkspacePurgeOperations Class

WorkspacePurgeOperations async 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

WorkspacePurgeOperations

Constructor

WorkspacePurgeOperations(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

get_purge_status

Gets status of an ongoing purge operation.

purge

Purges data in an Log Analytics workspace by a set of user-defined filters. In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.

get_purge_status

Gets status of an ongoing purge operation.

async get_purge_status(resource_group_name: str, workspace_name: str, purge_id: str, **kwargs: Any) -> azure.mgmt.loganalytics.models._models_py3.WorkspacePurgeStatusResponse

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.

purge_id

str

Required

In a purge status request, this is the Id of the operation the status of which is returned.

cls

callable

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

Returns

WorkspacePurgeStatusResponse, or the result of cls(response)

Return type

WorkspacePurgeStatusResponse

Exceptions

HttpResponseError

purge

Purges data in an Log Analytics workspace by a set of user-defined filters.

In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.

async purge(resource_group_name: str, workspace_name: str, body: azure.mgmt.loganalytics.models._models_py3.WorkspacePurgeBody, **kwargs: Any) -> azure.mgmt.loganalytics.models._models_py3.WorkspacePurgeResponse

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.

body

WorkspacePurgeBody

Required

Describes the body of a request to purge data in a single table of an Log Analytics Workspace.

cls

callable

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

Returns

WorkspacePurgeResponse, or the result of cls(response)

Return type

WorkspacePurgeResponse

Exceptions

HttpResponseError

Attributes

models

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