workspace_purge_purge_status

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

Overview

Name	workspace_purge_purge_status
Type	Resource
Id	azure.log_analytics.workspace_purge_purge_status

Fields

The following fields are returned by SELECT queries:

get

Returns status of purge operation in body of response. e.g.: running, completed.

Name	Datatype	Description
status	string	Status of the operation represented by the requested Id.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, workspaceName, purgeId		Gets status of an ongoing purge operation.

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
purgeId	string	In a purge status request, this is the Id of the operation the status of which is returned.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets status of an ongoing purge operation.

SELECT
status
FROM azure.log_analytics.workspace_purge_purge_status
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND purgeId = '{{ purgeId }}' -- required
;