OperationalInsightsWorkspaceResource.GetPurgeStatusAsync Method

Definition

Namespace:

Azure.ResourceManager.OperationalInsights

Assembly:

Azure.ResourceManager.OperationalInsights.dll

Package:

Azure.ResourceManager.OperationalInsights v1.2.2

Source:

OperationalInsightsWorkspaceResource.cs

Gets status of an ongoing purge operation.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/operations/{purgeId}
• Operation Id: WorkspacePurge_GetPurgeStatus
• Default Api Version: 2020-08-01

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeStatusResult>> GetPurgeStatusAsync (string purgeId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetPurgeStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeStatusResult>>
override this.GetPurgeStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeStatusResult>>

Public Overridable Function GetPurgeStatusAsync (purgeId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of OperationalInsightsWorkspacePurgeStatusResult))

Parameters

purgeId

String

In a purge status request, this is the Id of the operation the status of which is returned.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<OperationalInsightsWorkspacePurgeStatusResult>>

Exceptions

ArgumentException

purgeId is an empty string, and was expected to be non-empty.

ArgumentNullException

purgeId is null.