ComponentsOperationsExtensions.PurgeAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Management.ApplicationInsights.Management
Assembly:
Microsoft.Azure.Management.ApplicationInsights.dll
Package:
Microsoft.Azure.Management.ApplicationInsights v0.3.0-preview

Purges data in an Application Insights component 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.ApplicationInsights.Management.Models.ComponentPurgeResponse> PurgeAsync (this Microsoft.Azure.Management.ApplicationInsights.Management.IComponentsOperations operations, string resourceGroupName, string resourceName, Microsoft.Azure.Management.ApplicationInsights.Management.Models.ComponentPurgeBody body, System.Threading.CancellationToken cancellationToken = default);
static member PurgeAsync : Microsoft.Azure.Management.ApplicationInsights.Management.IComponentsOperations * string * string * Microsoft.Azure.Management.ApplicationInsights.Management.Models.ComponentPurgeBody * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Management.ApplicationInsights.Management.Models.ComponentPurgeResponse>
<Extension()>
Public Function PurgeAsync (operations As IComponentsOperations, resourceGroupName As String, resourceName As String, body As ComponentPurgeBody, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ComponentPurgeResponse)

Parameters

operations
IComponentsOperations

The operations group for this extension method.

resourceGroupName
String

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

resourceName
String

The name of the Application Insights component resource.

body
ComponentPurgeBody

Describes the body of a request to purge data in a single table of an Application Insights component

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<ComponentPurgeResponse>

Applies to