Test-AzContainerRegistryWebhook

Reference

Module:: Az.ContainerRegistry

Triggers a ping event to be sent to the webhook.

Syntax

Test-AzContainerRegistryWebhook
    -Name <String>
    -RegistryName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Test-AzContainerRegistryWebhook
    [-SubscriptionId <String>]
    -Webhook <IWebhook>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Triggers a ping event to be sent to the webhook.

Examples

Example 1: Triggers a webhook ping event.

Test-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001"

c5950af0-c8d0-4924-9873-1ba7da5cbf83

Triggers a webhook ping event.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The name of the webhook.

Type:	String
Aliases:	WebhookName, ResourceName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RegistryName

The name of the container registry.

Type:	String
Aliases:	ContainerRegistryName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Webhook

The webhook object. To construct, see NOTES section for WEBHOOK properties and create a hash table.

Type:	IWebhook
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

String

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

WEBHOOK <IWebhook>: The webhook object.

Location <String>: The location of the resource. This cannot be changed after the resource is created.
[SystemDataCreatedAt <DateTime?>]: The timestamp of resource creation (UTC).
[SystemDataCreatedBy <String>]: The identity that created the resource.
[SystemDataCreatedByType <CreatedByType?>]: The type of identity that created the resource.
[SystemDataLastModifiedAt <DateTime?>]: The timestamp of resource modification (UTC).
[SystemDataLastModifiedBy <String>]: The identity that last modified the resource.
[SystemDataLastModifiedByType <LastModifiedByType?>]: The type of identity that last modified the resource.
[Tag <IResourceTags>]: The tags of the resource.
- [(Any) <String>]: This indicates any property can be added to this object.
[Action <WebhookAction[]>]: The list of actions that trigger the webhook to post notifications.
[Scope <String>]: The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.
[Status <WebhookStatus?>]: The status of the webhook at the time the operation was called.