-
-
-
-
-
New-BrokerDesktopGroupWebhook
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
New-Brokerdesktopgroupwebhook
Create a webhook for the sepcified desktop group
Syntax
New-BrokerDesktopGroupWebhook -Address <String> -DesktopGroupUid <Int32> -OnEvent <WebhookTrigger> [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed 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.
Related Commands
Parameters
Name | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|
Address | The URL of the webhook | true | true (ByPropertyName) | |
DesktopGroupUid | The Uid of the desktop group to configure a webhook | true | true (ByPropertyName) | |
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. | true | true (ByPropertyName) | ||
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. | false | false | |
AdminAddress | Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value will become the default. |
BearerToken | Specifies the bearer token assigned to the calling user | false | false | |
TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | |
TraceState | Specifies the trace state assigned for internal diagnostic tracing use | false | false | |
VirtualSiteId | Specifies the virtual site the PowerShell snap-in will connect to. | false | false |
Input Type
Citrix.Broker.Admin.Sdk.Desktopgroupwebhook
The set of webhooks to be added to the desktop group can be piped into this cmdlet
Return Values
None
Examples
Example 1
C:\PS> New-BrokerDesktopGroupWebhook –DesktopGroupUid 1 –OnEvent MachineRegistration –Address 'http://citrix.com/example'
<!--NeedCopy-->
Description
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.
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.