azure.azcollection.azure_rm_containerappenvironment module – Manage 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_containerappenvironment.

New in azure.azcollection 4.0.0

Synopsis

  • Create, update and delete an Azure Container Apps Managed Environment.

  • Managed environments are the shared runtime that hosts one or more Container Apps.

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"

app_logs_configuration

dictionary

Cluster configuration which enables the log daemon to export app logs.

destination

string

Logs destination.

Choices:

  • "log-analytics"

  • "azure-monitor"

  • "none"

log_analytics_configuration

dictionary

Log Analytics configuration. Required when destination=log-analytics.

customer_id

string

Log Analytics workspace customer ID.

shared_key

string

Log Analytics workspace shared key.

append_tags

boolean

Use to control if tags field is canonical or just appends to existing tags.

When canonical, any tags not found in the tags parameter will be removed from the object’s metadata.

Choices:

  • false

  • true ← (default)

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"

dapr_ai_connection_string

string

Application Insights connection string used by Dapr to export Service to Service communication telemetry.

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

infrastructure_resource_group

string

Name of the platform-managed resource group created for the managed environment infrastructure.

Read-only unless workload_profiles is set and vnet_configuration.infrastructure_subnet_id is provided.

location

string

Resource location. If not set, location from the resource group will be used.

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string / required

Name of the managed environment.

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.

peer_authentication_mtls_enabled

boolean

Whether mutual TLS authentication is enabled between apps in the environment.

Choices:

  • false

  • true

peer_traffic_encryption_enabled

boolean

Whether peer-to-peer traffic encryption is enabled in the environment.

Choices:

  • false

  • true

profile

string

Security profile found in ~/.azure/credentials file.

public_network_access

string

Whether the environment accepts traffic from the public network.

Choices:

  • "Enabled"

  • "Disabled"

resource_group

string / required

The name of the resource group.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

state

string

Assert the state of the managed environment.

Use present to create or update, absent to delete.

Choices:

  • "present" ← (default)

  • "absent"

subscription_id

string

Your Azure subscription Id.

tags

dictionary

Dictionary of string:string pairs to assign as metadata to the object.

Metadata tags on the object will be updated with any provided values.

To remove tags set append_tags option to false.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

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.

vnet_configuration

dictionary

VNet configuration for the environment.

docker_bridge_cidr

string

CIDR notation IP range assigned to the Docker bridge network.

infrastructure_subnet_id

string

Resource ID of a subnet for infrastructure components.

internal

boolean

Whether the environment only has an internal load balancer.

Requires infrastructure_subnet_id to be set.

Choices:

  • false

  • true

platform_reserved_cidr

string

IP range in CIDR notation reserved for environment infrastructure IP addresses.

platform_reserved_dns_ip

string

IP address from the range defined by platform_reserved_cidr reserved for the internal DNS server.

workload_profiles

list / elements=dictionary

Workload profiles configured for the managed environment.

When omitted, the environment is created in the Consumption-only workload profile.

maximum_count

integer

Maximum capacity for dedicated workload profiles.

minimum_count

integer

Minimum capacity for dedicated workload profiles.

name

string / required

Workload profile display name.

workload_profile_type

string / required

Workload profile type. Common values are Consumption, D4, D8, D16, D32, E4, E8, E16, E32.

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.

zone_redundant

boolean

Whether the managed environment is zone-redundant.

Requires vnet_configuration.infrastructure_subnet_id to be set.

Choices:

  • false

  • true

Notes

Note

  • 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 managed environment (Consumption profile, no VNet)
  azure.azcollection.azure_rm_containerappenvironment:
    resource_group: myResourceGroup
    name: myenv
    location: eastus
    app_logs_configuration:
      destination: log-analytics
      log_analytics_configuration:
        customer_id: "{{ workspace_customer_id }}"
        shared_key: "{{ workspace_shared_key }}"

- name: Create a VNet-integrated environment with dedicated workload profile
  azure.azcollection.azure_rm_containerappenvironment:
    resource_group: myResourceGroup
    name: myenv-vnet
    location: eastus
    zone_redundant: true
    vnet_configuration:
      internal: true
      infrastructure_subnet_id: "/subscriptions/xxxx/resourceGroups/net/providers/Microsoft.Network/virtualNetworks/vnet/subnets/aca-infra"
    workload_profiles:
      - name: Consumption
        workload_profile_type: Consumption
      - name: dedicated-d4
        workload_profile_type: D4
        minimum_count: 1
        maximum_count: 3
    peer_authentication_mtls_enabled: true
    tags:
      environment: prod

- name: Delete the managed environment
  azure.azcollection.azure_rm_containerappenvironment:
    resource_group: myResourceGroup
    name: myenv
    state: absent

Return Values

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

Key

Description

state

complex

Current state of the managed environment.

Returned: always

app_logs_configuration

dictionary

App logs configuration for the environment.

Returned: always

default_domain

string

Default domain name for the environment.

Returned: always

Sample: "myenv.polite-1234abcd.eastus.azurecontainerapps.io"

id

string

Fully qualified resource ID of the managed environment.

Returned: always

Sample: "/subscriptions/xxxx/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/myenv"

location

string

Resource location.

Returned: always

Sample: "eastus"

name

string

Name of the managed environment.

Returned: always

Sample: "myenv"

provisioning_state

string

Provisioning state of the environment.

Returned: always

Sample: "Succeeded"

public_network_access

string

Whether the environment accepts public network traffic.

Returned: always

Sample: "Enabled"

static_ip

string

Static IP of the environment.

Returned: always

Sample: "20.10.20.30"

tags

dictionary

Resource tags.

Returned: always

Sample: {"environment": "prod"}

type

string

Resource type.

Returned: always

Sample: "Microsoft.App/managedEnvironments"

vnet_configuration

dictionary

VNet configuration used by the environment.

Returned: always

workload_profiles

list / elements=string

Workload profiles configured on the environment.

Returned: always

zone_redundant

boolean

Whether the environment is zone redundant.

Returned: always

Sample: false

Authors

  • Zun Yang (@zunyangc)