Interface WorkspacePurges


public interface WorkspacePurges
Resource collection API of WorkspacePurges.
  • Method Details

    • purge

      WorkspacePurgeResponse purge(String resourceGroupName, String workspaceName, WorkspacePurgeBody body)
      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.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      body - Describes the body of a request to purge data in a single table of an Log Analytics Workspace.
      Returns:
      response containing operationId for a specific purge action.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • purgeWithResponse

      com.azure.core.http.rest.Response<WorkspacePurgeResponse> purgeWithResponse(String resourceGroupName, String workspaceName, WorkspacePurgeBody body, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      body - Describes the body of a request to purge data in a single table of an Log Analytics Workspace.
      context - The context to associate with this operation.
      Returns:
      response containing operationId for a specific purge action.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getPurgeStatus

      WorkspacePurgeStatusResponse getPurgeStatus(String resourceGroupName, String workspaceName, String purgeId)
      Gets status of an ongoing purge operation.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      purgeId - In a purge status request, this is the Id of the operation the status of which is returned.
      Returns:
      status of an ongoing purge operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getPurgeStatusWithResponse

      com.azure.core.http.rest.Response<WorkspacePurgeStatusResponse> getPurgeStatusWithResponse(String resourceGroupName, String workspaceName, String purgeId, com.azure.core.util.Context context)
      Gets status of an ongoing purge operation.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      purgeId - In a purge status request, this is the Id of the operation the status of which is returned.
      context - The context to associate with this operation.
      Returns:
      status of an ongoing purge operation along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.