OperationalInsightsWorkspaceResource.GetPurgeStatus Method

Reference

Definition

Namespace:: Azure.ResourceManager.OperationalInsights

Assembly:: Azure.ResourceManager.OperationalInsights.dll

Package:: Azure.ResourceManager.OperationalInsights v1.2.2

Package:: Azure.ResourceManager.OperationalInsights v1.2.0-beta.1

Source:: OperationalInsightsWorkspaceResource.cs

Source:: OperationalInsightsWorkspaceResource.cs

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 Azure.Response<Azure.ResourceManager.OperationalInsights.Models.OperationalInsightsWorkspacePurgeStatusResult> GetPurgeStatus (string purgeId, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetPurgeStatus (purgeId As String, Optional cancellationToken As CancellationToken = Nothing) As 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

Response<OperationalInsightsWorkspacePurgeStatusResult>

Exceptions

ArgumentException

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

ArgumentNullException

purgeId is null.

Applies to

Share via