Interface WorkspacePurge

Package version

Interface representing a WorkspacePurge.

Hierarchy

WorkspacePurge

Implemented by

WorkspacePurgeImpl

Index

Methods

Methods

getPurgeStatus

getPurgeStatus(resourceGroupName: string, workspaceName: string, purgeId: string, options?: WorkspacePurgeGetPurgeStatusOptionalParams): Promise<WorkspacePurgeGetPurgeStatusResponse>

- Defined in operationsInterfaces/workspacePurge.ts:46
Gets status of an ongoing purge operation.

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.
- Optional options: WorkspacePurgeGetPurgeStatusOptionalParams
  
  The options parameters.
Returns Promise<WorkspacePurgeGetPurgeStatusResponse>

purge

purge(resourceGroupName: string, workspaceName: string, body: WorkspacePurgeBody, options?: WorkspacePurgePurgeOptionalParams): Promise<WorkspacePurgePurgeResponse>

- Defined in operationsInterfaces/workspacePurge.ts:32
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.

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
- Optional options: WorkspacePurgePurgeOptionalParams
  
  The options parameters.
Returns Promise<WorkspacePurgePurgeResponse>

Generated using TypeDoc