Share via

Microsoft.ContainerRegistry registries/webhooks 2025-11-01

Bicep resource definition

The registries/webhooks resource type can be deployed with operations that target:

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@2025-11-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    actions: [
      'string'
    ]
    customHeaders: {
      {customized property}: 'string'
    }
    scope: 'string'
    serviceUri: 'string'
    status: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.ContainerRegistry/registries/webhooks

Name Description Value
location The location of the webhook. This cannot be changed after the resource is created. string (required)
name The resource name string

Constraints:
Min length = 5
Max length = 50
Pattern = ^[a-zA-Z0-9]*$ (required)
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
tags Resource tags Dictionary of tag names and values. See Tags in templates

WebhookCreateParametersTags

Name Description Value

WebhookPropertiesCreateParametersCustomHeaders

Name Description Value

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. WebhookPropertiesCreateParametersCustomHeaders
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

Constraints:
Sensitive value. Pass in as a secure parameter. (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:

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": "2025-11-01",
  "name": "string",
  "location": "string",
  "properties": {
    "actions": [ "string" ],
    "customHeaders": {
      "{customized property}": "string"
    },
    "scope": "string",
    "serviceUri": "string",
    "status": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.ContainerRegistry/registries/webhooks

Name Description Value
apiVersion The api version '2025-11-01'
location The location of the webhook. This cannot be changed after the resource is created. string (required)
name The resource name string

Constraints:
Min length = 5
Max length = 50
Pattern = ^[a-zA-Z0-9]*$ (required)
properties The properties that the webhook will be created with. WebhookPropertiesCreateParametersOrWebhookProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.ContainerRegistry/registries/webhooks'

WebhookCreateParametersTags

Name Description Value

WebhookPropertiesCreateParametersCustomHeaders

Name Description Value

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. WebhookPropertiesCreateParametersCustomHeaders
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

Constraints:
Sensitive value. Pass in as a secure parameter. (required)
status The status of the webhook at the time the operation was called. 'disabled'
'enabled'

Usage Examples

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@2025-11-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      actions = [
        "string"
      ]
      customHeaders = {
        {customized property} = "string"
      }
      scope = "string"
      serviceUri = "string"
      status = "string"
    }
  }
}

Property Values

Microsoft.ContainerRegistry/registries/webhooks

Name Description Value
location The location of the webhook. This cannot be changed after the resource is created. string (required)
name The resource name string

Constraints:
Min length = 5
Max length = 50
Pattern = ^[a-zA-Z0-9]*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: registries
properties The properties that the webhook will be created with. WebhookPropertiesCreateParametersOrWebhookProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.ContainerRegistry/registries/webhooks@2025-11-01"

WebhookCreateParametersTags

Name Description Value

WebhookPropertiesCreateParametersCustomHeaders

Name Description Value

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. WebhookPropertiesCreateParametersCustomHeaders
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

Constraints:
Sensitive value. Pass in as a secure parameter. (required)
status The status of the webhook at the time the operation was called. 'disabled'
'enabled'

Usage Examples

Terraform Samples

A basic example of deploying Azure Container Registry Webhook.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "registry" {
  type      = "Microsoft.ContainerRegistry/registries@2021-08-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      adminUserEnabled     = false
      anonymousPullEnabled = false
      dataEndpointEnabled  = false
      encryption = {
        status = "disabled"
      }
      networkRuleBypassOptions = "AzureServices"
      policies = {
        exportPolicy = {
          status = "enabled"
        }
        quarantinePolicy = {
          status = "disabled"
        }
        retentionPolicy = {
          status = "disabled"
        }
        trustPolicy = {
          status = "disabled"
        }
      }
      publicNetworkAccess = "Enabled"
      zoneRedundancy      = "Disabled"
    }
    sku = {
      name = "Standard"
      tier = "Standard"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "webHook" {
  type      = "Microsoft.ContainerRegistry/registries/webHooks@2021-08-01-preview"
  parent_id = azapi_resource.registry.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      actions = [
        "push",
      ]
      customHeaders = {
      }
      scope      = ""
      serviceUri = "https://mywebhookreceiver.example/mytag"
      status     = "enabled"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on