OperationalInsightsWorkspaceResource.PurgeAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.OperationalInsights
Assembly:
Azure.ResourceManager.OperationalInsights.dll
Package:
Azure.ResourceManager.OperationalInsights v1.2.2
Package:
Azure.ResourceManager.OperationalInsights v1.3.0-beta.1
Source:
OperationalInsightsWorkspaceResource.cs
Source:
OperationalInsightsWorkspaceResource.cs

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/purge
  • Operation Id: WorkspacePurge_Purge
  • Default Api Version: 2020-08-01
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeResult>> PurgeAsync (Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member PurgeAsync : Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeResult>>
override this.PurgeAsync : Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeResult>>
Public Overridable Function PurgeAsync (content As OperationalInsightsWorkspacePurgeContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of OperationalInsightsWorkspacePurgeResult))

Parameters

content
OperationalInsightsWorkspacePurgeContent

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response<OperationalInsightsWorkspacePurgeResult>>

Exceptions

ArgumentNullException

content is null.

Applies to