workspace_purge

Creates, updates, deletes, gets or lists a workspace_purge resource.

Overview

Name	workspace_purge
Type	Resource
Id	azure.log_analytics.workspace_purge

Fields

The following fields are returned by SELECT queries:

get_purge_status

Name	Datatype	Description
status	string	Status of the operation represented by the requested Id. Required. Known values are: "pending" and "completed". (pending, completed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_purge_status	select	resource_group_name, workspace_name, purge_id, subscription_id		Gets status of an ongoing purge operation.
purge	delete	resource_group_name, workspace_name, subscription_id		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. Log Analytics only supports purge operations required for compliance with GDPR. The Log Analytics product team reserves the right to reject requests for purge operations that are not for the purpose of GDPR compliance. In the event of a dispute, please create a support ticket.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
purge_id	string	In a purge status request, this is the Id of the operation the status of which is returned. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get_purge_status

Gets status of an ongoing purge operation.

SELECT
status
FROM azure.log_analytics.workspace_purge
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND purge_id = '{{ purge_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

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. Log Analytics only supports purge operations required for compliance with GDPR. The Log Analytics product team reserves the right to reject requests for purge operations that are not for the purpose of GDPR compliance. In the event of a dispute, please create a support ticket.

DELETE FROM azure.log_analytics.workspace_purge
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;