OperationalInsightsWorkspaceResource.Purge Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 Azure.Response<Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeResult> Purge (Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member Purge : Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeContent * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeResult>
override this.Purge : Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeContent * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeResult>
Public Overridable Function Purge (content As OperationalInsightsWorkspacePurgeContent, Optional cancellationToken As CancellationToken = Nothing) As Response(Of OperationalInsightsWorkspacePurgeResult)
Parameters
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
Exceptions
content
is null.