exec.azurerm.containerregistry.webhook

Azure Resource Manager (ARM) Container Registry Webhook Execution Module

New in version 3.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

  • AZURE_PUBLIC_CLOUD (default)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.containerregistry.webhook.create_or_update(hub, ctx, name, registry_name, resource_group, service_uri, actions, custom_headers=None, status=None, scope=None, tags=None, **kwargs)

New in version 3.0.0.

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

Parameters:
  • name – The name of the webhook.
  • registry_name – The name of the container registry.
  • resource_group – The name of the resource group to which the container registry belongs.
  • service_uri – The service URI for the webhook to post notifications.
  • actions – The list of actions that trigger the webhook to post notifications. Possible values include ‘chart_delete’, ‘chart_push’, ‘delete’, ‘push’, and ‘quarantine’.
  • custom_headers – A dictionary of custom headers that will be added to the webhook notifications.
  • status – The status of the webhook at the time the operation was called. Possible values are ‘enabled’ and ‘disabled’.
  • 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.
  • tags – The tags of the resource.

CLI Example:

azurerm.containerregistry.webhook.create_or_update testhook testrepo testgroup
idem_azurerm.exec.azurerm.containerregistry.webhook.delete(hub, ctx, name, registry_name, resource_group, **kwargs)

New in version 3.0.0.

Deletes a webhook from a container registry.

Parameters:
  • name – The name of the webhook.
  • registry_name – The name of the container registry.
  • resource_group – The name of the resource group to which the container registry belongs.

CLI Example:

azurerm.containerregistry.webhook.delete testhook testrepo testgroup
idem_azurerm.exec.azurerm.containerregistry.webhook.get(hub, ctx, name, registry_name, resource_group, callback_config=False, **kwargs)

New in version 3.0.0.

Gets the properties of the specified webhook.

Parameters:
  • name – The name of the webhook.
  • registry_name – The name of the container registry.
  • resource_group – The name of the resource group to which the container registry belongs.
  • callback_config – Gets the configuration of service URI and custom headers for the webhook.

CLI Example:

azurerm.containerregistry.webhook.get testhook testrepo testgroup
idem_azurerm.exec.azurerm.containerregistry.webhook.list_(hub, ctx, name, resource_group, **kwargs)

New in version 3.0.0.

Lists all the webhooks for the specified container registry.

Parameters:
  • name – The name of the container registry.
  • resource_group – The name of the resource group to which the container registry belongs.

CLI Example:

azurerm.containerregistry.webhook.list testrepo testgroup
idem_azurerm.exec.azurerm.containerregistry.webhook.list_events(hub, ctx, name, registry_name, resource_group, **kwargs)

New in version 3.0.0.

Lists recent events for the specified webhook.

Parameters:
  • name – The name of the webhook.
  • registry_name – The name of the container registry.
  • resource_group – The name of the resource group to which the container registry belongs.

CLI Example:

azurerm.containerregistry.registry.list_events testhook testrepo testgroup
idem_azurerm.exec.azurerm.containerregistry.webhook.ping(hub, ctx, name, registry_name, resource_group, **kwargs)

New in version 3.0.0.

Triggers a ping event to be sent to the webhook.

Parameters:
  • name – The name of the webhook.
  • registry_name – The name of the container registry.
  • resource_group – The name of the resource group to which the container registry belongs.

CLI Example:

azurerm.containerregistry.webhook.ping testhook testrepo testgroup