New-AzContainerRegistryWebhook
Creates a webhook for a container registry with the specified parameters.
Syntax
CreateExpanded (Default)
New-AzContainerRegistryWebhook
-Name <String>
-RegistryName <String>
-ResourceGroupName <String>
-Action <WebhookAction[]>
[-SubscriptionId <String>]
[-Location <String>]
[-CustomHeader <Hashtable>]
[-Scope <String>]
[-ServiceUri <String>]
[-Status <WebhookStatus>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateByRegistry
New-AzContainerRegistryWebhook
-Name <String>
-Registry <IRegistry>
-Action <WebhookAction[]>
[-SubscriptionId <String>]
[-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.
Parameter properties
Type: WebhookAction [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Custom headers that will be added to the webhook notifications.
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False Aliases: Header
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
The location of the webhook.
This cannot be changed after the resource is created.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the webhook.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: WebhookName, ResourceName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Registry
The Registry Object.
To construct, see NOTES section for REGISTRY properties and create a hash table.
Parameter properties
Type: IRegistry
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateByRegistry
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RegistryName
The name of the container registry.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ContainerRegistryName
Parameter sets
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ServiceUri
The service URI for the webhook to post notifications.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Uri
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Status
The status of the webhook at the time the operation was called.
Parameter properties
Type: WebhookStatus
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
The tags for the webhook.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False Aliases: Tags
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
