OperationalInsightsWorkspaceResource.GetPurgeStatusAsync 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.
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
Exceptions
purgeId is an empty string, and was expected to be non-empty.
purgeId is null.
