Citrix Daas SDK

Get-MonitorWebhookProfile

November 26, 2024

Contributed by:

Retrieves one or more webhook profile configurations.

Syntax

Get-MonitorWebhookProfile
   [-Uid <Int64>]
   [-Name <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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
<!--NeedCopy-->

EXAMPLE 2

Retrieves the Webhook Profile object having the name equals to ‘WebhookProfile1’

Get-MonitorWebhookProfile -Name 'WebhookProfile1'
<!--NeedCopy-->

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.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-MonitorWebhookProfile

November 26, 2024

Contributed by:

November 26, 2024

Contributed by:

Get-MonitorWebhookProfile

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-Uid

-Name

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

ICollection<MonitorWebhookProfile> System.String

Related Links

In this article