ApplicationInsightsComponentResource.GetPurgeStatus 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 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

Response<ComponentPurgeStatusResult>
Response<ComponentPurgeStatusResponse>

Exceptions

ArgumentException

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

ArgumentNullException

purgeId is null.

Applies to