/ home / azure / azure.azcollection / 0.3.0 / module / azure_rm_containerregistrywebhook

azure.azcollection.azure_rm_containerregistrywebhook (0.3.0) — module

Manage Webhook instance.

| "added in version" 2.5 of azure.azcollection"

Authors: Zim Kalinowski (@zikalino)

preview | supported by community

Install collection

Install with ansible-galaxy collection install azure.azcollection:==0.3.0

Add to requirements.yml

  collections:
    - name: azure.azcollection
      version: 0.3.0

Description

Create, update and delete instance of Webhook.

Requirements

python >= 2.7
azure >= 2.0.0

Usage examples

Scanned by Steampunk Spotter

  - name: Create (or update) Webhook
    azure_rm_containerregistrywebhook:
      resource_group: myResourceGroup
      registry_name: myRegistry
      webhook_name: myWebhook
      location: eastus

Inputs

scope:
description:
- The scope of repositories where the event can be triggered. For example, 'foo:*'
means events for all tags under repository 'foo'. 'foo:bar' m eans events for 'foo:bar'
only. 'foo' is equivalent to 'foo:latest'. Empty means all events.

secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str

status:
choices:
- enabled
- disabled
description:
- The status of the webhook at the time the operation was called.

tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str

actions:
description:
- The list of actions that trigger the webhook to post notifications.
type: list

ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str

profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str

location:
description:
- Resource location. If not set, location from the resource group will be used as
default.

password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str

client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
type: str

api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: '2.5'
version_added_collection: azure.azcollection

auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
description:
- Controls the source of the credentials to use for authentication.
- If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and
default to C(auto) if variable is not defined.
- C(auto) will follow the default precedence of module parameters -> environment variables
-> default profile in credential file C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the default Azure CLI profile.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID)
can be used to identify the subscription ID if the resource is granted access to
more than one subscription, otherwise the first subscription is chosen.
- The C(msi) was added in Ansible 2.6.
type: str
version_added: '2.5'
version_added_collection: azure.azcollection

service_uri:
description:
- The service URI for the webhook to post notifications.

webhook_name:
description:
- The name of the webhook.
required: true

registry_name:
description:
- The name of the container registry.
required: true

custom_headers:
description:
- Custom headers that will be added to the webhook notifications.

resource_group:
description:
- The name of the resource group to which the container registry belongs.
required: true

subscription_id:
description:
- Your Azure subscription Id.
type: str

cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: '2.4'
version_added_collection: azure.azcollection

adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: '2.6'
version_added_collection: azure.azcollection

cert_validation_mode:
choices:
- ignore
- validate
description:
- Controls the certificate validation behavior for Azure endpoints. By default, all
modules will validate the server certificate, but when an HTTPS proxy is in use,
or against Azure Stack, it may be necessary to disable this behavior by passing
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: '2.5'
version_added_collection: azure.azcollection

Outputs

id:
  description:
  - The resource ID.
  returned: always
  sample: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/w
    ebhooks/myWebhook
  type: str
status:
  description:
  - 'The status of the webhook at the time the operation was called. Possible values
    include: ''enabled'', ''disabled'''
  returned: always
  sample: enabled
  type: str