WorkspacePurgeOperations Class

  • Reference

WorkspacePurgeOperations 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

Name Description
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

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

get_purge_status(resource_group_name: str, workspace_name: str, purge_id: str, **kwargs: Any) -> _models.WorkspacePurgeStatusResponse

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.
workspace_name
Required
str

The name of the workspace.
purge_id
Required
str

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

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
WorkspacePurgeStatusResponse

WorkspacePurgeStatusResponse, or the result of cls(response)

Exceptions

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

purge(resource_group_name: str, workspace_name: str, body: '_models.WorkspacePurgeBody', **kwargs: Any) -> _models.WorkspacePurgeResponse

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.
workspace_name
Required
str

The name of the workspace.
body
Required
WorkspacePurgeBody

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

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
WorkspacePurgeResponse

WorkspacePurgeResponse, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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