Share via

WorkspacePurgeOperationsExtensions.PurgeAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Management.OperationalInsights
Assembly:
Microsoft.Azure.Management.OperationalInsights.dll
Package:
Microsoft.Azure.Management.OperationalInsights v0.25.0-preview

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.

public static System.Threading.Tasks.Task<Microsoft.Azure.Management.OperationalInsights.Models.WorkspacePurgeResponse> PurgeAsync (this Microsoft.Azure.Management.OperationalInsights.IWorkspacePurgeOperations operations, string resourceGroupName, string workspaceName, Microsoft.Azure.Management.OperationalInsights.Models.WorkspacePurgeBody body, System.Threading.CancellationToken cancellationToken = default);
static member PurgeAsync : Microsoft.Azure.Management.OperationalInsights.IWorkspacePurgeOperations * string * string * Microsoft.Azure.Management.OperationalInsights.Models.WorkspacePurgeBody * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Management.OperationalInsights.Models.WorkspacePurgeResponse>
<Extension()>
Public Function PurgeAsync (operations As IWorkspacePurgeOperations, resourceGroupName As String, workspaceName As String, body As WorkspacePurgeBody, Optional cancellationToken As CancellationToken = Nothing) As Task(Of WorkspacePurgeResponse)

Parameters

operations
IWorkspacePurgeOperations

The operations group for this extension method.

resourceGroupName
String

The name of the resource group. The name is case insensitive.

workspaceName
String

The name of the workspace.

body
WorkspacePurgeBody

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

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<WorkspacePurgeResponse>

Applies to