Edit

Share via

Get-AzOperationalInsightsPurgeWorkspaceStatus

  • Reference
Module:
Az.OperationalInsights

Gets status of an ongoing purge operation.

Syntax

Get-AzOperationalInsightsPurgeWorkspaceStatus
   [-ResourceGroupName] <String>
   [-WorkspaceName] <String>
   [-PurgeId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Gets status of an ongoing purge operation.

Examples

Example 1

Get-AzOperationalInsightsPurgeWorkspaceStatus -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "MyWorkspace" -PurgeId "cd944bc7-ba11-447e-910c-c6393ac020a9"

This command gets the status of an ongoing purge operation by resource group name, workspace name and the purge id returned from New-AzOperationalInsightsPurgeWorkspace command.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PurgeId

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

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

The resource group name.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WorkspaceName

The name of the workspace that contains the table.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

PSWorkspacePurgeStatusResponse