New-AzContainerRegistryWebhook

Reference

Module:: Az.ContainerRegistry

Creates a webhook for a container registry with the specified parameters.

Syntax

New-AzContainerRegistryWebhook
   -Name <String>
   -RegistryName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -Action <WebhookAction[]>
   [-Location <String>]
   [-CustomHeader <Hashtable>]
   [-Scope <String>]
   [-ServiceUri <String>]
   [-Status <WebhookStatus>]
   [-Tag <Hashtable>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzContainerRegistryWebhook
   -Name <String>
   [-SubscriptionId <String>]
   -Registry <IRegistry>
   -Action <WebhookAction[]>
   [-Location <String>]
   [-CustomHeader <Hashtable>]
   [-Scope <String>]
   [-ServiceUri <String>]
   [-Status <WebhookStatus>]
   [-Tag <Hashtable>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Creates a webhook for a container registry with the specified parameters.

Examples

Example 1: The New-AzContainerRegistryWebhook cmdlet creates a container registry webhook.

New-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" -Uri http://www.bing.com -Action Delete,Push -Header @{SpecialHeader='headerVal'} -Tag @{Key="val"} -Location "east us" -Status Enabled -Scope "foo:*"

Name       Location Status  Scope ProvisioningState
----       -------- ------  ----- -----------------
webhook001 eastus   enabled foo:* Succeeded

Create a container registry webhook. Please notice that some parameters are required in this cmdlets but not marked as required in syntax, we would change it later.

Parameters

-Action

The list of actions that trigger the webhook to post notifications.

Type:	WebhookAction[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

Run the command as a job

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

-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

-CustomHeader

Custom headers that will be added to the webhook notifications.

Type:	Hashtable
Aliases:	Header
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

-Location

The location of the webhook. This cannot be changed after the resource is created.

Type:	String
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

-NoWait

Run the command asynchronously

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

-Registry

The Registry Object. To construct, see NOTES section for REGISTRY properties and create a hash table.

Type:	IRegistry
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

-Scope

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.

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

-ServiceUri

The service URI for the webhook to post notifications.

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

-Status

The status of the webhook at the time the operation was called.

Type:	WebhookStatus
Position:	Named
Default value:	None
Required:	False
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

-Tag

The tags for the webhook.

Type:	Hashtable
Aliases:	Tags
Position:	Named
Default value:	None
Required:	False
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

IWebhook

Share via