Microsoft.ContainerRegistry registries/webhooks
Bicep resource definition
The registries/webhooks resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ContainerRegistry/registries/webhooks resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ContainerRegistry/registries/webhooks@2023-01-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
actions: [
'string'
]
customHeaders: {}
scope: 'string'
serviceUri: 'string'
status: 'string'
}
}
Property values
registries/webhooks
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 5-50 Valid characters: Alphanumerics. |
| location | The location of the webhook. This cannot be changed after the resource is created. | string (required) |
| tags | The tags for the webhook. | Dictionary of tag names and values. See Tags in templates |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: registries |
| properties | The properties that the webhook will be created with. | WebhookPropertiesCreateParametersOrWebhookProperties |
WebhookPropertiesCreateParametersOrWebhookProperties
| Name | Description | Value |
|---|---|---|
| actions | The list of actions that trigger the webhook to post notifications. | String array containing any of: 'chart_delete' 'chart_push' 'delete' 'push' 'quarantine' (required) |
| customHeaders | Custom headers that will be added to the webhook notifications. | object |
| 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. | string |
| serviceUri | The service URI for the webhook to post notifications. | string (required) |
| status | The status of the webhook at the time the operation was called. | 'disabled' 'enabled' |
ARM template resource definition
The registries/webhooks resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ContainerRegistry/registries/webhooks resource, add the following JSON to your template.
{
"type": "Microsoft.ContainerRegistry/registries/webhooks",
"apiVersion": "2023-01-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"actions": [ "string" ],
"customHeaders": {},
"scope": "string",
"serviceUri": "string",
"status": "string"
}
}
Property values
registries/webhooks
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ContainerRegistry/registries/webhooks' |
| apiVersion | The resource api version | '2023-01-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 5-50 Valid characters: Alphanumerics. |
| location | The location of the webhook. This cannot be changed after the resource is created. | string (required) |
| tags | The tags for the webhook. | Dictionary of tag names and values. See Tags in templates |
| properties | The properties that the webhook will be created with. | WebhookPropertiesCreateParametersOrWebhookProperties |
WebhookPropertiesCreateParametersOrWebhookProperties
| Name | Description | Value |
|---|---|---|
| actions | The list of actions that trigger the webhook to post notifications. | String array containing any of: 'chart_delete' 'chart_push' 'delete' 'push' 'quarantine' (required) |
| customHeaders | Custom headers that will be added to the webhook notifications. | object |
| 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. | string |
| serviceUri | The service URI for the webhook to post notifications. | string (required) |
| status | The status of the webhook at the time the operation was called. | 'disabled' 'enabled' |
Terraform (AzAPI provider) resource definition
The registries/webhooks resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ContainerRegistry/registries/webhooks resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerRegistry/registries/webhooks@2023-01-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
actions = [
"string"
]
customHeaders = {}
scope = "string"
serviceUri = "string"
status = "string"
}
})
}
Property values
registries/webhooks
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ContainerRegistry/registries/webhooks@2023-01-01-preview" |
| name | The resource name | string (required) Character limit: 5-50 Valid characters: Alphanumerics. |
| location | The location of the webhook. This cannot be changed after the resource is created. | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: registries |
| tags | The tags for the webhook. | Dictionary of tag names and values. |
| properties | The properties that the webhook will be created with. | WebhookPropertiesCreateParametersOrWebhookProperties |
WebhookPropertiesCreateParametersOrWebhookProperties
| Name | Description | Value |
|---|---|---|
| actions | The list of actions that trigger the webhook to post notifications. | String array containing any of: "chart_delete" "chart_push" "delete" "push" "quarantine" (required) |
| customHeaders | Custom headers that will be added to the webhook notifications. | object |
| 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. | string |
| serviceUri | The service URI for the webhook to post notifications. | string (required) |
| status | The status of the webhook at the time the operation was called. | "disabled" "enabled" |