Share via


IWorkspacePurgeOperations.PurgeWithHttpMessagesAsync Method

Definition

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 System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.OperationalInsights.Models.WorkspacePurgeResponse,Microsoft.Azure.Management.OperationalInsights.Models.WorkspacePurgePurgeHeaders>> PurgeWithHttpMessagesAsync (string resourceGroupName, string workspaceName, Microsoft.Azure.Management.OperationalInsights.Models.WorkspacePurgeBody body, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PurgeWithHttpMessagesAsync : string * string * Microsoft.Azure.Management.OperationalInsights.Models.WorkspacePurgeBody * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.OperationalInsights.Models.WorkspacePurgeResponse, Microsoft.Azure.Management.OperationalInsights.Models.WorkspacePurgePurgeHeaders>>
Public Function PurgeWithHttpMessagesAsync (resourceGroupName As String, workspaceName As String, body As WorkspacePurgeBody, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of WorkspacePurgeResponse, WorkspacePurgePurgeHeaders))

Parameters

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

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to