webhooks

Creates, updates, deletes, gets or lists a webhooks resource.

Overview

Name	webhooks
Type	Resource
Id	azure.container_registry.webhooks

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
location	string	The location of the resource. This cannot be changed after the resource is created.
properties	object	The properties of the webhook.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.

list

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
location	string	The location of the resource. This cannot be changed after the resource is created.
properties	object	The properties of the webhook.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, registryName, webhookName		Gets the properties of the specified webhook.
list	select	subscriptionId, resourceGroupName, registryName		Lists all the webhooks for the specified container registry.
create	insert	subscriptionId, resourceGroupName, registryName, webhookName, data__location		Creates a webhook for a container registry with the specified parameters.
update	update	subscriptionId, resourceGroupName, registryName, webhookName		Updates a webhook with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, registryName, webhookName		Deletes a webhook from a container registry.
ping	exec	subscriptionId, resourceGroupName, registryName, webhookName		Triggers a ping event to be sent to the webhook.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
registryName	string	The name of the container registry.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
webhookName	string	The name of the webhook.

SELECT examples

get

Gets the properties of the specified webhook.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.container_registry.webhooks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
AND webhookName = '{{ webhookName }}' -- required
;

list

Lists all the webhooks for the specified container registry.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.container_registry.webhooks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.container_registry.webhooks (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
registryName,
webhookName
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ registryName }}',
'{{ webhookName }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: webhooks
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the webhooks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the webhooks resource.
    - name: registryName
      value: string
      description: Required parameter for the webhooks resource.
    - name: webhookName
      value: string
      description: Required parameter for the webhooks resource.
    - name: tags
      value: object
      description: |
        The tags for the webhook.
    - name: location
      value: string
      description: |
        The location of the webhook. This cannot be changed after the resource is created.
    - name: properties
      value: object
      description: |
        The properties that the webhook will be created with.

UPDATE examples

update

Updates a webhook with the specified parameters.

UPDATE azure.container_registry.webhooks
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND webhookName = '{{ webhookName }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a webhook from a container registry.

DELETE FROM azure.container_registry.webhooks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND webhookName = '{{ webhookName }}' --required
;

Lifecycle Methods

ping

Triggers a ping event to be sent to the webhook.

EXEC azure.container_registry.webhooks.ping 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@registryName='{{ registryName }}' --required, 
@webhookName='{{ webhookName }}' --required
;