az acr webhook

Manage webhooks for Azure Container Registries.

Commands

az acr webhook create

Create a webhook for an Azure Container Registry.

az acr webhook delete

Delete a webhook from an Azure Container Registry.

az acr webhook get-config

Get the service URI and custom headers for the webhook.

az acr webhook list

List all of the webhooks for an Azure Container Registry.

az acr webhook list-events

List recent events for a webhook.

az acr webhook ping

Trigger a ping event for a webhook.

az acr webhook show

Get the details of a webhook.

az acr webhook update

Update a webhook.

az acr webhook create

Create a webhook for an Azure Container Registry.

az acr webhook create --actions {chart_delete, chart_push, delete, push, quarantine}
                      --name
                      --registry
                      --uri
                      [--headers]
                      [--location]
                      [--resource-group]
                      [--scope]
                      [--status {disabled, enabled}]
                      [--subscription]
                      [--tags]

Examples

Create a webhook for an Azure Container Registry that will deliver docker push and delete events to a service URI.

az acr webhook create -n MyWebhook -r MyRegistry --uri http://myservice.com --actions push delete

Create a webhook for an Azure Container Registry that will deliver docker push events to a service URI with a basic authentication header.

az acr webhook create -n MyWebhook -r MyRegistry --uri http://myservice.com --actions push --headers "Authorization=Basic 000000"

Create a webhook for an Azure Container Registry that will deliver helm chart push and delete events to a service URI.

az acr webhook create -n MyWebhook -r MyRegistry --uri http://myservice.com --actions chart_push chart_delete

Required Parameters

--actions

Space-separated list of actions that trigger the webhook to post notifications.

accepted values: chart_delete, chart_push, delete, push, quarantine
--name -n

The name of the webhook.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

--uri

The service URI for the webhook to post notifications.

Optional Parameters

--headers

Space-separated custom headers in 'key[=value]' format that will be added to the webhook notifications. Use "" to clear existing headers.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--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 events for all repositories.

--status

Indicates whether the webhook is enabled.

accepted values: disabled, enabled
default value: enabled
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az acr webhook delete

Delete a webhook from an Azure Container Registry.

az acr webhook delete --name
                      --registry
                      [--resource-group]
                      [--subscription]

Examples

Delete a webhook from an Azure Container Registry.

az acr webhook delete -n MyWebhook -r MyRegistry

Required Parameters

--name -n

The name of the webhook.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az acr webhook get-config

Get the service URI and custom headers for the webhook.

az acr webhook get-config --name
                          --registry
                          [--resource-group]
                          [--subscription]

Examples

Get the configuration information for a webhook.

az acr webhook get-config -n MyWebhook -r MyRegistry

Required Parameters

--name -n

The name of the webhook.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az acr webhook list

List all of the webhooks for an Azure Container Registry.

az acr webhook list --registry
                    [--query-examples]
                    [--resource-group]
                    [--subscription]

Examples

List webhooks and show the results in a table.

az acr webhook list -r MyRegistry -o table

Required Parameters

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az acr webhook list-events

List recent events for a webhook.

az acr webhook list-events --name
                           --registry
                           [--resource-group]
                           [--subscription]

Examples

List recent events for a webhook.

az acr webhook list-events -n MyWebhook -r MyRegistry

Required Parameters

--name -n

The name of the webhook.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az acr webhook ping

Trigger a ping event for a webhook.

az acr webhook ping --name
                    --registry
                    [--resource-group]
                    [--subscription]

Examples

Trigger a ping event for a webhook.

az acr webhook ping -n MyWebhook -r MyRegistry

Required Parameters

--name -n

The name of the webhook.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az acr webhook show

Get the details of a webhook.

az acr webhook show --name
                    --registry
                    [--query-examples]
                    [--resource-group]
                    [--subscription]

Examples

Get the details of a webhook.

az acr webhook show -n MyWebhook -r MyRegistry

Required Parameters

--name -n

The name of the webhook.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az acr webhook update

Update a webhook.

az acr webhook update --name
                      --registry
                      [--actions {chart_delete, chart_push, delete, push, quarantine}]
                      [--add]
                      [--force-string]
                      [--headers]
                      [--remove]
                      [--resource-group]
                      [--scope]
                      [--set]
                      [--status {disabled, enabled}]
                      [--subscription]
                      [--tags]
                      [--uri]

Examples

Update headers for a webhook.

az acr webhook update -n MyWebhook -r MyRegistry --headers "Authorization=Basic 000000"

Update the service URI and actions for a webhook.

az acr webhook update -n MyWebhook -r MyRegistry --uri http://myservice.com --actions push delete

Disable a webhook.

az acr webhook update -n MyWebhook -r MyRegistry --status disabled

Required Parameters

--name -n

The name of the webhook.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--actions

Space-separated list of actions that trigger the webhook to post notifications.

accepted values: chart_delete, chart_push, delete, push, quarantine
--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--headers

Space-separated custom headers in 'key[=value]' format that will be added to the webhook notifications. Use "" to clear existing headers.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--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 events for all repositories.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--status

Indicates whether the webhook is enabled.

accepted values: disabled, enabled
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--uri

The service URI for the webhook to post notifications.