Citrix Virtual Apps and Desktops SDK

Remove-ProvOperationEvent

Introduced in: Citrix Virtual Apps and Desktop 7 2305

Removes one or more MCS operation events.

Syntax

Remove-ProvOperationEvent
      [-EventRecordId <Int64[]>]
      [-LinkedObjectType <String>]
      [-LinkedObjectUid <Guid>]
      [-All]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Allows you to remove a set of existing MCS operation events.

Examples

EXAMPLE 1

Removes all of the operation events of the provisioning scheme with id 7585f0de-192e-4847-a6d8-22713c3a2f42.

Remove-ProvOperationEvent -LinkedObjectType ProvisioningScheme -LinkedObjectUid 7585f0de-192e-4847-a6d8-22713c3a2f42
<!--NeedCopy-->

Parameters

-EventRecordId

The array of event record id which all associated operation events will be removed.

Type: Int64[]
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2407

-LinkedObjectType

The type of the linked object for which all associated operation events will be removed.

Type: String
Accepted values: ProvisioningScheme
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-LinkedObjectUid

The unique identifier of the linked object for which all associated operation events will be removed.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-All

All operation events will be removed.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Removed Parameters

Parameters in this section were available in older releases, and have been removed or replaced due to changes in functionality.

-EventId

The array of event id which all associated operation events will be removed.

Replaced with parameter EventRecordId.

Type: Int32[]
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Removed in: Citrix Virtual Apps and Desktop 7 2407

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Notes

In the case of failure, the following errors can result.

Error Codes


PartialData Only a subset of the available data was returned

CouldNotQueryDatabase The query to get the database was not defined.

PermissionDenied The user does not have administrative rights to perform this operation.

ConfigurationLoggingError The operation could not be performed because of a configuration logging error.

CommunicationError An error occurred while communicating with the service.

DatabaseNotConfigured The operation could not be completed because the database for the service is not configured.

InvalidFilter A filtering expression was supplied that could not be interpreted for this cmdlet.

ExceptionThrown An unexpected error occurred. For more details, see the Windows event logs on the controller being used, or Citrix Virtual Apps and Desktops logs.

Remove-ProvOperationEvent