ApplicationInsightsComponentResource.GetPurgeStatus Method

Definition

Get status for an ongoing purge operation.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/operations/{purgeId}
  • Operation Id: Components_GetPurgeStatus
  • Default Api Version: 2020-02-02
  • Resource: ApplicationInsightsComponentResource
public virtual Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResult> GetPurgeStatus (string purgeId, System.Threading.CancellationToken cancellationToken = default);
public virtual Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResponse> GetPurgeStatus (string purgeId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetPurgeStatus : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResult>
override this.GetPurgeStatus : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResult>
abstract member GetPurgeStatus : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResponse>
override this.GetPurgeStatus : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResponse>
Public Overridable Function GetPurgeStatus (purgeId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ComponentPurgeStatusResult)
Public Overridable Function GetPurgeStatus (purgeId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ComponentPurgeStatusResponse)

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.

Applies to