Get-MonitorWebhookProfile
Retrieves one or more webhook profile configurations.
Syntax
Get-MonitorWebhookProfile
[-Uid <Int64>]
[-Name <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This cmdlet fetches the configuration(s) of existing webhook profile(s) based on the specified unique identifier (Uid) or name. If no parameters are provided, it returns all webhook profiles.
Examples
EXAMPLE 1
Retrieves the webhook profile with the unique identifier equal to 1.
Get-MonitorWebhookProfile -Uid 1
EXAMPLE 2
Retrieves the Webhook Profile object having the name equals to 'WebhookProfile1'
Get-MonitorWebhookProfile -Name 'WebhookProfile1'
Parameters
-Uid
Specifies the unique identifier of the webhook profile to retrieve.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the webhook profile to retrieve. This can be a partial name to match multiple profiles.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-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 |
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
ICollection\<MonitorWebhookProfile\> System.String
A collection of one or more MonitorWebhookProfile objects matching the query.