Functions.ComponentsPurge Method

  • Reference

Definition

Namespace:
Microsoft.Azure.PowerShell.Cmdlets.Functions
Assembly:
Az.Functions.private.dll

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 System.Threading.Tasks.Task ComponentsPurge (string resourceGroupName, string subscriptionId, string resourceName, Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20150501.IComponentPurgeBody body, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20150501.IComponentPurgeResponse>,System.Threading.Tasks.Task> onAccepted, Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.IEventListener eventListener, Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.ISendAsync sender);
member this.ComponentsPurge : string * string * string * Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20150501.IComponentPurgeBody * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20150501.IComponentPurgeResponse>, System.Threading.Tasks.Task> * Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.IEventListener * Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.ISendAsync -> System.Threading.Tasks.Task
Public Function ComponentsPurge (resourceGroupName As String, subscriptionId As String, resourceName As String, body As IComponentPurgeBody, onAccepted As Func(Of HttpResponseMessage, Task(Of IComponentPurgeResponse), Task), eventListener As IEventListener, sender As ISendAsync) As Task

Parameters

resourceGroupName
String

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

subscriptionId
String

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

resourceName
String

The name of the Application Insights component resource.

body
IComponentPurgeBody

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

onAccepted
Func<HttpResponseMessage,Task<IComponentPurgeResponse>,Task>

a delegate that is called when the remote service returns 202 (Accepted).

eventListener
IEventListener

an IEventListener instance that will receive events.

sender
ISendAsync

an instance of an Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.ISendAsync pipeline to use to make the request.

Returns

Task

A Task that will be complete when handling of the response is completed.

Applies to