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"

cache

boolean

Toggle to enable/disable the caching of the inventory’s source data, requires a cache plugin setup to work.

Choices:

• false ← (default)
• true

Configuration:

• INI entry:

  [inventory]
  cache = false
  

• Environment variable: ANSIBLE_INVENTORY_CACHE

cache_connection

string

Cache connection data or path, read cache plugin documentation for specifics.

Configuration:

• INI entries:

  [defaults]
  fact_caching_connection = VALUE
  

  [inventory]
  cache_connection = VALUE
  

• Environment variable: ANSIBLE_CACHE_PLUGIN_CONNECTION
• Environment variable: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

string

Cache plugin to use for the inventory’s source data.

Default: "memory"

Configuration:

• INI entries:

  [defaults]
  fact_caching = memory
  

  [inventory]
  cache_plugin = memory
  

• Environment variable: ANSIBLE_CACHE_PLUGIN
• Environment variable: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

string

Prefix to use for cache plugin files/tables.

Default: "ansible_inventory_"

Configuration:

• INI entries:

  [defaults]
  fact_caching_prefix = ansible_inventory_
  

  [inventory]
  cache_prefix = ansible_inventory_
  

• Environment variable: ANSIBLE_CACHE_PLUGIN_PREFIX
• Environment variable: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

cache_timeout

integer

Cache duration in seconds.

Default: 3600

Configuration:

• INI entries:

  [defaults]
  fact_caching_timeout = 3600
  

  [inventory]
  cache_timeout = 3600
  

• Environment variable: ANSIBLE_CACHE_PLUGIN_TIMEOUT
• Environment variable: ANSIBLE_INVENTORY_CACHE_TIMEOUT

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"

compose

dictionary

A mapping of hostvar names to Jinja2 expressions. The value for each host is the result of the Jinja2 expression (which may refer to any of the host’s existing variables at the time this inventory plugin runs).

Default: {}

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

fail_on_template_errors

string

When false, template failures during group and filter processing are silently ignored (eg, if a filter or group expression refers to an undefined host variable)

Choices:

• true ← (default)
• false

graph_query

string

A graph query which will retrieve the inventory of hosts you are interested in. You must return inventory_hostname as a field from your query.

groups

dictionary

A mapping of group names to Jinja2 expressions. When the mapped expression is true, the host is added to the named group.

Default: {}

hostnames

list / elements=string

A list of Jinja2 expressions in order of precedence to compose inventory_hostname.

Ignores expression if result is an empty string or None value.

An expression of default will force using the default hostname generator if no previous hostname expression resulted in a valid hostname.

Use default_inventory_hostname to access the default hostname generator’s value in any of the Jinja2 expressions.

Default: ["default"]

keyed_groups

list / elements=dictionary

Creates groups based on the value of a host variable. Requires a list of dictionaries, defining key (the source dictionary-typed variable), prefix (the prefix to use for the new group name), and optionally separator (which defaults to _)

Default: []

default_value

string

added in ansible-core 2.12

The default value when the host variable’s value is an empty string.

This option is mutually exclusive with keyed_groups[].trailing_separator.

key

string

The key from input dictionary used to generate groups.

parent_group

string

parent group for keyed group.

prefix

string

A keyed group name will start with this prefix.

Default: ""

separator

string

separator used to build the keyed group name.

Default: "_"

trailing_separator

boolean

added in ansible-core 2.12

Set this option to false to omit the keyed_groups[].separator after the host variable when the value is an empty string.

This option is mutually exclusive with keyed_groups[].default_value.

Choices:

• false
• true ← (default)

leading_separator

boolean

added in ansible-core 2.11

Use in conjunction with keyed_groups.

By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore.

This is because the default prefix is "" and the default separator is "_".

Set this option to false to omit the leading underscore (or other separator) if no prefix is given.

If the group name is derived from a mapping the separator is still used to concatenate the items.

To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead.

Choices:

• false
• true ← (default)

log_mode

string

Parent argument.

log_path

string

Parent argument.

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

plugin

string / required

marks this as an instance of the ‘azure_rm’ plugin

Choices:

• "azure_kql"
• "azure.azcollection.azure_kql"

profile

string

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

secret

string

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

strict

boolean

If yes make invalid entries a fatal error, otherwise skip and continue.

Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default.

Choices:

• false ← (default)
• true

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.

use_extra_vars

boolean

added in ansible-core 2.11

Merge extra vars into the available variables for composition (highest precedence).

Choices:

• false ← (default)
• true

Configuration:

• INI entry:

  [inventory_plugins]
  use_extra_vars = false
  

• Environment variable: ANSIBLE_INVENTORY_USE_EXTRA_VARS

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.