Citrix Virtual Apps and Desktops SDK

Remove-MonitorWebhookProfile

Introduced in: Citrix Virtual Apps and Desktop 7 2411

Removes the specified webhook profile.

Syntax

Remove-MonitorWebhookProfile
      -Uid <Int64>
      [-LoggingId <Guid>]
      [-SkipCertificateValidation]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

This cmdlet removes a webhook profile identified by its unique identifier (Uid) from the Monitor. It is used to manage webhook profiles by deleting unnecessary or outdated configurations.

Examples

EXAMPLE 1

This example removes the webhook profile with the specified unique identifier (Uid).

Remove-MonitorWebhookProfile -Uid 1
<!--NeedCopy-->

Parameters

-Uid

Specifies the unique identifier of the webhook profile to remove.

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

-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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

Boolean

Returns a boolean stating whether respective webhook profile is removed successfully

Notes

Use Get-MonitorWebhookProfile to find the Uid of the profile you wish to remove.

Remove-MonitorWebhookProfile