azure.azcollection.azure_rm_appconfiguration module – Manage Azure App Configuration stores.

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"

appconfig_name

string / required

Name of the app configuration store.

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"

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

disable_local_auth

boolean

Property specifying whether local authentication (access keys) is enabled for the store.

Choices:

• false ← (default)
• true

enable_purge_protection

boolean

Property specifying whether protection against purge is enabled for this store.

Choices:

• false ← (default)
• true

identity

dictionary

Managed identity configuration for the store.

type

string / required

Type of the managed identity

Choices:

• "SystemAssigned"
• "UserAssigned"
• "SystemAssigned, UserAssigned"

user_assigned_identity_ids

list / elements=string

List of user-assigned identity resource IDs (required when type includes UserAssigned).

is_purge_deleted

boolean

Whether permanently deletes the specified store. aka Purges the deleted Azure App Configuration store

When is_purge_deleted is specified, the location has to be configured.

If not configured, the default location of the resource group will be used.

Choices:

• false ← (default)
• true

location

string

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

log_mode

string

Parent argument.

log_path

string

Parent argument.

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.

public_network_access

string

Public network access setting for the store.

If omitted at creation, Azure treats it as Automatic. Once set to Enabled or Disabled, it cannot be returned to Automatic; omit the property in updates to leave unchanged.

Choices:

• "Disabled"
• "Enabled"

replicas

list / elements=dictionary

List of replicas to manage for this store.

location

string / required

Location of the replica.

name

string / required

Name of the replica.

resource_group

string / required

The name of the Resource Group to which the App Configuration store belongs.

secret

string

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

sku

string

SKU tier of the store.

Choices:

• "free"
• "developer"
• "standard"
• "premium"

soft_delete_retention_in_days

integer

Property specifying the number of days to retain deleted store.

state

string

Assert the state of the App Configuration store. Use present to create or update an App Configuration store and absent to delete it.

Choices:

• "absent"
• "present" ← (default)

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.

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.

id

string

The Azure Resource Manager resource ID for the App Configuration store.

Returned: always

Sample: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.AppConfiguration/configurationStores/myAppConfigStore"