Components - Get Purge Status

Get status for an ongoing purge operation.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/operations/{purgeId}?api-version=2015-05-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The ID of the target subscription.

resourceGroupName
path True
  • string

The name of the resource group. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

resourceName
path True
  • string

The name of the Application Insights component resource.

purgeId
path True
  • string

In a purge status request, this is the Id of the operation the status of which is returned.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

Returns status of purge operation in body of response. e.g.: running, completed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ComponentPurge

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/OIAutoRest5123/providers/Microsoft.Insights/components/aztest5048/operations/purge-970318e7-b859-4edb-8903-83b1b54d0b74?api-version=2015-05-01

Sample Response

{
  "status": "completed"
}

Definitions

ComponentPurgeStatusResponse

Response containing status for a specific purge operation.

PurgeState

Status of the operation represented by the requested Id.

ComponentPurgeStatusResponse

Response containing status for a specific purge operation.

Name Type Description
status

Status of the operation represented by the requested Id.

PurgeState

Status of the operation represented by the requested Id.

Name Type Description
completed
  • string
pending
  • string