Share via


ApplicationInsightsComponentResource.PurgeAsync Method

Definition

Overloads

PurgeAsync(ComponentPurgeBody, CancellationToken)

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. Note: this operation is intended for Classic resources, for workspace-based Application Insights resource please run purge operation (directly on the workspace)(https://docs.microsoft.com/en-us/rest/api/loganalytics/workspace-purge/purge) , scoped to specific resource id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/purge
  • Operation Id: Components_Purge
  • Default Api Version: 2020-02-02
  • Resource: ApplicationInsightsComponentResource
PurgeAsync(ComponentPurgeContent, CancellationToken)

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. Note: this operation is intended for Classic resources, for workspace-based Application Insights resource please run purge operation (directly on the workspace)(https://docs.microsoft.com/en-us/rest/api/loganalytics/workspace-purge/purge) , scoped to specific resource id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/purge
  • Operation Id: Components_Purge
  • Default Api Version: 2020-02-02
  • Resource: ApplicationInsightsComponentResource

PurgeAsync(ComponentPurgeBody, CancellationToken)

Source:
ApplicationInsightsComponentResource.cs

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. Note: this operation is intended for Classic resources, for workspace-based Application Insights resource please run purge operation (directly on the workspace)(https://docs.microsoft.com/en-us/rest/api/loganalytics/workspace-purge/purge) , scoped to specific resource id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/purge
  • Operation Id: Components_Purge
  • Default Api Version: 2020-02-02
  • Resource: ApplicationInsightsComponentResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeResponse>> PurgeAsync (Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeBody body, System.Threading.CancellationToken cancellationToken = default);
abstract member PurgeAsync : Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeBody * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeResponse>>
override this.PurgeAsync : Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeBody * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeResponse>>
Public Overridable Function PurgeAsync (body As ComponentPurgeBody, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ComponentPurgeResponse))

Parameters

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 to use.

Returns

Exceptions

body is null.

Applies to

PurgeAsync(ComponentPurgeContent, CancellationToken)

Source:
ApplicationInsightsComponentResource.cs

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. Note: this operation is intended for Classic resources, for workspace-based Application Insights resource please run purge operation (directly on the workspace)(https://docs.microsoft.com/en-us/rest/api/loganalytics/workspace-purge/purge) , scoped to specific resource id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/purge
  • Operation Id: Components_Purge
  • Default Api Version: 2020-02-02
  • Resource: ApplicationInsightsComponentResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeResult>> PurgeAsync (Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member PurgeAsync : Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeResult>>
override this.PurgeAsync : Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeResult>>
Public Overridable Function PurgeAsync (content As ComponentPurgeContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ComponentPurgeResult))

Parameters

content
ComponentPurgeContent

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

content is null.

Applies to