New-BrokerDesktopGroupWebhook
Create a webhook for the sepcified desktop group
Syntax
New-BrokerDesktopGroupWebhook
-Address <String>
-DesktopGroupUid <Int32>
-OnEvent <WebhookTrigger>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This cmdlet is used to create a webhook for the sepcified desktop group, that is invoked upon the specified event of the desktop group.
Examples
EXAMPLE 1
Creates a new webhook for the desktop group with Uid 1, that is to be invoked when a machine registers to the broker.
When it is invoked, a HTTP POST request is sent out to the address above with a JSON payload {"SamName": "value"} where "value" is the SAM name of registering machine.
New-BrokerDesktopGroupWebhook -DesktopGroupUid 1 -OnEvent MachineRegistration -Address 'http://citrix.com/example'
Parameters
-Address
The URL of the webhook
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
| Length range: | 1 to 2000 |
-DesktopGroupUid
The Uid of the desktop group to configure a webhook
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-OnEvent
The event upon that the webhook is invoked, currently the only supported event is MachineRegistration.
For MachineRegistration, when the webhook is invoked it is HTTP POST with a JSON payload of the format: {"SamName": "value"} where the "value" is the SamName of the machine that is registering to the broker.
| Type: | WebhookTrigger |
| Accepted values: | MachineRegistration |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| 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
The set of webhooks to be added to the desktop group can be piped into this cmdlet
Outputs
None
By default, this cmdlet returns no output.