Set-BrokerDesktopGroupWebhook
Adjusts the settings of a webhook for a desktop group
Syntax
Set-BrokerDesktopGroupWebhook
[-InputObject] <DesktopGroupWebhook[]>
[-PassThru]
[-Address <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This cmdlet is used to alter the settings of a webhook for a desktop group
Examples
EXAMPLE 1
Changes the URL of the webhook for the desktop group with Uid 1
Get-BrokerDesktopGroupWebhook -DesktopGroupUid 1 | Set-BrokerDesktopGroupWebhook -Address "http://citrix.com/example2"
Parameters
-InputObject
The webhook object to alter the settings.
| Type: | DesktopGroupWebhook[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-PassThru
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Address
Specified the new URL for the webhook.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop 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 |
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
Citrix.Broker.Admin.SDK.DesktopGroupWebhook
You can pipe webhooks to this cmdlet
Outputs
None or Citrix.Broker.Admin.SDK.DesktopGroupWebhook
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.DesktopGroupWebhook object.