WorkspacePurge interface
Interface representing a WorkspacePurge.
Methods
| get |
Gets status of an ongoing purge operation. |
| purge(string, string, Workspace |
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 |
Method Details
getPurgeStatus(string, string, string, WorkspacePurgeGetPurgeStatusOptionalParams)
Gets status of an ongoing purge operation.
function getPurgeStatus(resourceGroupName: string, workspaceName: string, purgeId: string, options?: WorkspacePurgeGetPurgeStatusOptionalParams): Promise<WorkspacePurgeStatusResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- purgeId
-
string
In a purge status request, this is the Id of the operation the status of which is returned.
The options parameters.
Returns
Promise<WorkspacePurgeStatusResponse>
purge(string, string, WorkspacePurgeBody, WorkspacePurgePurgeOptionalParams)
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
function purge(resourceGroupName: string, workspaceName: string, body: WorkspacePurgeBody, options?: WorkspacePurgePurgeOptionalParams): Promise<WorkspacePurgePurgeResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- body
- WorkspacePurgeBody
Describes the body of a request to purge data in a single table of an Log Analytics Workspace
The options parameters.
Returns
Promise<WorkspacePurgePurgeResponse>