-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
Get-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!
Get-BrokerDesktopGroupWebhook
Gets the webhook configured for desktop group
Syntax
Get-BrokerDesktopGroupWebhook
[-Address <String>]
[-DesktopGroupName <String>]
[-DesktopGroupUid <Int32>]
[-OnEvent <WebhookTrigger>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Get-BrokerDesktopGroupWebhook
-Uid <Int32>
[-Property <String[]>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
The cmdlet returns the webhook that are currently being configured for desktop groups. Each desktop group can have up to one webhook.
————————– BrokerDesktopGroupWebhook Object
The BrokerDesktopGroupWebhook object represents a webhook of a desktop group that is invoked upon certain events, currently the only supported event is MachineRegistration.
-
Address (System.String)
URL of the webhook
-
DesktopGroupName (System.String)
The name of the desktop group
-
DesktopGroupUid (System.Int32)
The Uid of the desktop group
-
OnEvent (Citrix.Broker.Admin.SDK.WebhookTrigger)
The event upon that the webhook is triggered
-
Uid (System.Int32)
The Uid of the webhook
Examples
EXAMPLE 1
Gets the webhook that is associated to the desktop group 1
Get-BrokerDesktopGroupWebhook -DesktopGroupUid 1
<!--NeedCopy-->
Parameters
-Uid
Get only webhooks that match the specified Webhook Uid
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Address
Gets only webhooks whose URL matches that specified.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-DesktopGroupName
Gets only webhooks associated with desktop groups whose names match that specified.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-DesktopGroupUid
Gets only webhooks associated with the specified desktop group.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnEvent
Gets only webhooks that match the specified OnEvent.
Type: | WebhookTrigger |
Accepted values: | MachineRegistration |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReturnTotalRecordCount
When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MaxRecordCount
Specifies the maximum number of records to return.
Type: | Int32 |
Position: | Named |
Default value: | 250 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Skip
Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
Type: | Int32 |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SortBy
Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.
Type: | String |
Position: | Named |
Default value: | The default sort order is by name or unique identifier. |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Filter
Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FilterScope
Gets only results allowed by the specified scope id.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Introduced in: | Citrix Virtual Apps and Desktop 7 2106 |
-Property
Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.
Type: | String[] |
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
None
Input cannot be piped to this cmdlet
Outputs
Citrix.Broker.Admin.SDK.DesktopGroupWebhook
Returns an object for each enumerated Desktop Group and an Webhook combination
Related Links
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.