azure.azcollection.azure_rm_containerappdaprcomponent module – Manage a Dapr component in an Azure Container Apps managed environment

Note

This module is part of the azure.azcollection collection (version 4.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_containerappdaprcomponent.

New in azure.azcollection 4.2.0

Synopsis

• Create, update and delete a Dapr component in an Azure Container Apps managed environment.

• Dapr components (state stores, pub/sub brokers, secret stores, input and output bindings) are shared by the container apps in the environment that reference the component in their dapr configuration or in the component’s scopes.

• The managed environment itself is managed with azure.azcollection.azure_rm_containerappenvironment.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7

• The host that executes this module must have the azure.azcollection collection installed via galaxy

• All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection

• Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter	Comments
ad_user string	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in azure.azcollection 0.0.1	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in azure.azcollection 0.0.1	Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack. Default: "latest"
auth_source string added in azure.azcollection 0.0.1	Controls the source of the credentials to use for authentication. Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable. When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli. When set to env, the credentials will be read from the environment variables. When set to credential_file, it will read the profile from ~/.azure/credentials. When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable 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 msi was added in Ansible 2.6. Choices: "auto" ← (default) "cli" "credential_file" "env" "msi"
cert_validation_mode string added in azure.azcollection 0.0.1	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 ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. Choices: "ignore" "validate"
client_id string	Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the AZURE_CLIENT_ID environment variable.
cloud_environment string added in azure.azcollection 0.0.1	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable. Default: "AzureCloud"
component_type string	Dapr component type, for example state.azure.blobstorage, pubsub.redis, secretstores.azure.keyvault or bindings.kafka. Required when creating the component.
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the AZURE_DISABLE_INSTANCE_DISCOVERY environment variable. Choices: false ← (default) true
environment_name string / required	Name of the managed environment that hosts the Dapr component.
ignore_errors boolean	Ignore Dapr component errors when the component fails to start. Choices: false true
init_timeout string	Dapr component initialization timeout, in the <h>h<m>m<s>s format, for example 30s or 1m30s.
log_mode string	Parent argument.
log_path string	Parent argument.
metadata list / elements=dictionary	Dapr component configuration metadata. Each entry is either a plain name/value pair or a name/secret_ref pair referencing an entry in secrets.
name string / required	Metadata property name.
secret_ref string	Name of the secret in secrets to pull the value from.
value string	Metadata property value.
name string / required	Name of the Dapr component.
oidc_token string added in azure.azcollection 3.17.0	Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication. This token is exchanged with Azure AD using OIDC federated identity. Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform. Can also be set via the AZURE_FEDERATED_TOKEN environment variable.
oidc_token_file_path path added in azure.azcollection 3.17.0	Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication. The file must contain only raw token. This method is commonly used in platforms that materialize OIDC tokens as files Can also be set via the AZURE_FEDERATED_TOKEN_FILE environment variable.
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string	Security profile found in ~/.azure/credentials file.
resource_group string / required	Name of the resource group containing the managed environment.
scopes list / elements=string	Names of the container apps that can use this Dapr component. When omitted, all container apps in the environment can use it.
secret string	Azure client secret. Use when authenticating with a Service Principal.
secret_store_component string	Name of a Dapr secret store component to retrieve component secrets from.
secrets list / elements=dictionary	Collection of secrets used by the Dapr component. Secret values are referenced from metadata entries by secret name. Each entry is an inline name/value pair. Azure Key Vault references are not supported for Dapr component secrets (the service rejects keyVaultUrl with DaprComponentSecretNull); to consume Key Vault secrets, deploy a secretstores.azure.keyvault Dapr component instead. Inline secret values are write-only and never returned by Azure, so an update of a component that has secrets must resupply them when the update changes anything - the module fails instead of silently dropping them. Pass an empty list to remove all secrets.
name string / required	Secret name.
value string	Secret value.
state string	Assert the state of the Dapr component. Use present to create or update, absent to delete. Choices: "present" ← (default) "absent"
subscription_id string	Your Azure subscription Id.
tenant string	Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint string added in azure.azcollection 1.14.0	The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined.
update_secrets string	When secrets is sent to Azure for an existing component. Inline secret values are write-only and cannot be compared against the stored values, so a run that only changes a secret value is not detected as a change. With on_create (the default), secrets is included when the component is created and when an update is triggered by other changes, but a run that only supplies secrets does not update the component. With always, supplying secrets always triggers an update, which rotates the secret values of the existing component. Choices: "on_create" ← (default) "always"
version string	Version of the Dapr component, for example v1. Required when creating the component.
x509_certificate_path path added in azure.azcollection 1.14.0	Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal.

Notes

Note

• On update, fields that are omitted are carried forward from the existing component. Secret values are write-only, so an update of a component that has secrets must resupply secrets when the update changes anything, and the module fails otherwise. Use update_secrets=always to rotate secret values.

• Azure Key Vault references are not supported for Dapr component secrets (the service rejects them with DaprComponentSecretNull). To consume Key Vault secrets, deploy a secretstores.azure.keyvault Dapr component with the vault name in metadata and give the environment’s or apps’ managed identity access to the vault.

• For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

• Authentication is also possible using a service principal or Active Directory user.

• To authenticate via OIDC, pass client_id, tenant and oidc_token or oidc_token_file_path, or set environment variables AZURE_CLIENT_ID, AZURE_TENANT and AZURE_FEDERATED_TOKEN or AZURE_FEDERATED_TOKEN_FILE.

• To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

• To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

• Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create a Dapr state store backed by Azure Blob Storage
  azure.azcollection.azure_rm_containerappdaprcomponent:
    resource_group: myResourceGroup
    environment_name: myenvironment
    name: statestore
    component_type: state.azure.blobstorage
    version: v1
    metadata:
      - name: accountName
        value: mystorageaccount
      - name: containerName
        value: dapr-state
      - name: accountKey
        secret_ref: storage-account-key
    secrets:
      - name: storage-account-key
        value: "{{ vault_storage_account_key }}"
    scopes:
      - mycontainerapp

- name: Create a Redis pub/sub component restricted to two apps
  azure.azcollection.azure_rm_containerappdaprcomponent:
    resource_group: myResourceGroup
    environment_name: myenvironment
    name: pubsub
    component_type: pubsub.redis
    version: v1
    init_timeout: 1m
    metadata:
      - name: redisHost
        value: myredis.redis.cache.windows.net:6379
      - name: redisPassword
        secret_ref: redis-password
    secrets:
      - name: redis-password
        value: "{{ vault_redis_password }}"
    scopes:
      - orders-api
      - notifications-worker

- name: Update the scopes of the state store (secrets resupplied)
  azure.azcollection.azure_rm_containerappdaprcomponent:
    resource_group: myResourceGroup
    environment_name: myenvironment
    name: statestore
    scopes:
      - mycontainerapp
      - anotherapp
    secrets:
      - name: storage-account-key
        value: "{{ vault_storage_account_key }}"

- name: Rotate the secret value of the state store
  azure.azcollection.azure_rm_containerappdaprcomponent:
    resource_group: myResourceGroup
    environment_name: myenvironment
    name: statestore
    secrets:
      - name: storage-account-key
        value: "{{ vault_storage_account_key }}"
    update_secrets: always

- name: Delete the pub/sub component
  azure.azcollection.azure_rm_containerappdaprcomponent:
    resource_group: myResourceGroup
    environment_name: myenvironment
    name: pubsub
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
daprcomponent dictionary	The Dapr component definition. Secret values are write-only and are never returned. Returned: when state=present Sample: {"component_type": "state.azure.blobstorage", "metadata": [{"name": "accountName", "value": "mystorageaccount"}], "name": "statestore", "scopes": ["mycontainerapp"], "secrets": [{"name": "storage-account-key"}], "version": "v1"}

Authors

• Bill Peck (@p3ck)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)