azure.azcollection.azure_rm_appconfiguration module – Manage Azure App Configuration stores.
Note
This module is part of the azure.azcollection collection (version 3.15.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_appconfiguration.
New in azure.azcollection 3.15.0
Synopsis
Create, update and delete Azure App Configuration stores.
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 |
|---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
Name of the app configuration store. |
|
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:
|
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
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 Choices:
|
|
Property specifying whether local authentication (access keys) is enabled for the store. Choices:
|
|
Property specifying whether protection against purge is enabled for this store. Choices:
|
|
Managed identity configuration for the store. |
|
Type of the managed identity Choices:
|
|
List of user-assigned identity resource IDs (required when type includes UserAssigned). |
|
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:
|
|
Resource location. If not set, location from the resource group will be used as default. |
|
Parent argument. |
|
Parent argument. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Public network access setting for the store. If omitted at creation, Azure treats it as Choices:
|
|
List of replicas to manage for this store. |
|
Location of the replica. |
|
Name of the replica. |
|
The name of the Resource Group to which the App Configuration store belongs. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
SKU tier of the store. Choices:
|
|
Property specifying the number of days to retain deleted store. |
|
Assert the state of the App Configuration store. Use Choices:
|
|
Your Azure subscription Id. |
|
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. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
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. |
|
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
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 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 logincommand.
Examples
- name: Create a Standard App Configuration store with system-assigned identity
azure.azcollection.azure_rm_appconfiguration:
resource_group: myResourceGroup
appconfig_name: myAppConfigStore
location: eastus
sku: standard
identity:
type: SystemAssigned
enable_local_auth: true
tags:
env: prod
state: present
- name: Assign a user-assigned identity and enable purge protection
azure.azcollection.azure_rm_appconfiguration:
resource_group: myResourceGroup
appconfig_name: myAppConfigStore
identity:
type: UserAssigned
user_assigned_identity_ids:
- /subscriptions/xxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity
enable_purge_protection: true
soft_delete_retention_in_days: 7
state: present
- name: Delete an App Configuration store
azure.azcollection.azure_rm_appconfiguration:
resource_group: myRG
appconfig_name: my-appconf-legacy
state: absent
- name: Purge a soft-deleted App Configuration store (subscription-level permission required)
azure.azcollection.azure_rm_appconfiguration:
resource_group: myRG
appconfig_name: my-appconf-legacy
location: eastus
is_purge_deleted: true
state: absent
- name: Create store with two replicas
azure.azcollection.azure_rm_appconfiguration:
resource_group: myRG
appconfig_name: myappconf
location: eastus
sku: standard
replicas:
- name: r1
location: westus
- name: r2
location: northeurope
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The Azure Resource Manager resource ID for the App Configuration store. Returned: always Sample: |