Share via

ApplicationInsightsComponentResource.GetPurgeStatusAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.ApplicationInsights
Assembly:
Azure.ResourceManager.ApplicationInsights.dll
Package:
Azure.ResourceManager.ApplicationInsights v1.0.0
Package:
Azure.ResourceManager.ApplicationInsights v1.0.0-beta.5
Source:
ApplicationInsightsComponentResource.cs
Source:
ApplicationInsightsComponentResource.cs

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 System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResult>> GetPurgeStatusAsync (string purgeId, System.Threading.CancellationToken cancellationToken = default);
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResponse>> GetPurgeStatusAsync (string purgeId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetPurgeStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResult>>
override this.GetPurgeStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResult>>
abstract member GetPurgeStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResponse>>
override this.GetPurgeStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ComponentPurgeStatusResponse>>
Public Overridable Function GetPurgeStatusAsync (purgeId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ComponentPurgeStatusResult))
Public Overridable Function GetPurgeStatusAsync (purgeId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

Task<Response<ComponentPurgeStatusResult>>
Task<Response<ComponentPurgeStatusResponse>>

Exceptions

ArgumentException

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

ArgumentNullException

purgeId is null.

Applies to