Workspace Purge - Get Purge Status

Reference

Service:: Log Analytics

API Version:: 2023-09-01

Gets status of an ongoing purge operation.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/operations/{purgeId}?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
purgeId	path	True	string	In a purge status request, this is the Id of the operation the status of which is returned.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	The name of the workspace. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	WorkspacePurgeStatusResponse	Returns status of purge operation in body of response. e.g.: running, completed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

WorkspacePurgeOperation

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/OIAutoRest5123/providers/Microsoft.OperationalInsights/workspaces/aztest5048/operations/purge-970318e7-b859-4edb-8903-83b1b54d0b74?api-version=2023-09-01

Sample response

Status code:: 200

{
  "status": "completed"
}

Definitions

Name	Description
PurgeState	Status of the operation represented by the requested Id.
WorkspacePurgeStatusResponse	Response containing status for a specific purge operation.

PurgeState

Status of the operation represented by the requested Id.

Name	Type	Description
completed	string
pending	string

WorkspacePurgeStatusResponse

Response containing status for a specific purge operation.

Name	Type	Description
status	PurgeState	Status of the operation represented by the requested Id.

Share via