az acr webhook
Manage webhooks for Azure Container Registries.
Name | Description | Type | Status |
---|---|---|---|
az acr webhook create |
Create a webhook for an Azure Container Registry. |
Core | GA |
az acr webhook delete |
Delete a webhook from an Azure Container Registry. |
Core | GA |
az acr webhook get-config |
Get the service URI and custom headers for the webhook. |
Core | GA |
az acr webhook list |
List all of the webhooks for an Azure Container Registry. |
Core | GA |
az acr webhook list-events |
List recent events for a webhook. |
Core | GA |
az acr webhook ping |
Trigger a ping event for a webhook. |
Core | GA |
az acr webhook show |
Get the details of a webhook. |
Core | GA |
az acr webhook update |
Update a webhook. |
Core | GA |
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}]
[--tags]
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
Space-separated list of actions that trigger the webhook to post notifications.
The name of the webhook.
The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>
.
The service URI for the webhook to post notifications.
Space-separated custom headers in 'key[=value]' format that will be added to the webhook notifications. Use "" to clear existing headers.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Indicates whether the webhook is enabled.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Delete a webhook from an Azure Container Registry.
az acr webhook delete --name
--registry
[--resource-group]
Delete a webhook from an Azure Container Registry.
az acr webhook delete -n mywebhook -r myregistry
The name of the webhook.
The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Get the service URI and custom headers for the webhook.
az acr webhook get-config --name
--registry
[--resource-group]
Get the configuration information for a webhook.
az acr webhook get-config -n mywebhook -r myregistry
The name of the webhook.
The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
List all of the webhooks for an Azure Container Registry.
az acr webhook list --registry
[--resource-group]
List webhooks and show the results in a table.
az acr webhook list -r myregistry -o table
The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
List recent events for a webhook.
az acr webhook list-events --name
--registry
[--resource-group]
List recent events for a webhook.
az acr webhook list-events -n mywebhook -r myregistry
The name of the webhook.
The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Trigger a ping event for a webhook.
az acr webhook ping --name
--registry
[--resource-group]
Trigger a ping event for a webhook.
az acr webhook ping -n mywebhook -r myregistry
The name of the webhook.
The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Get the details of a webhook.
az acr webhook show --name
--registry
[--resource-group]
Get the details of a webhook.
az acr webhook show -n mywebhook -r myregistry
The name of the webhook.
The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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}]
[--tags]
[--uri]
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
The name of the webhook.
The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>
.
Space-separated list of actions that trigger the webhook to post notifications.
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>
.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Space-separated custom headers in 'key[=value]' format that will be added to the webhook notifications. Use "" to clear existing headers.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Indicates whether the webhook is enabled.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The service URI for the webhook to post notifications.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: