W3cubDocs

/Ansible

azure.azcollection.azure_rm_aduser_info – Get Azure Active Directory user info

Note

This plugin is part of the azure.azcollection collection (version 1.10.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.

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

New in version 1.4.0: of azure.azcollection

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

Synopsis

Get Azure Active Directory user info.

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-azure.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	Choices/Defaults	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 0.0.1 of azure.azcollection		Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
all boolean	Choices: no yes	If True, will return all users in tenant. If False will return no users. It is recommended that you instead identify a subset of users and use filter. Mutually exclusive with object_id, attribute_name, odata_filter and user_principal_name.
api_profile string added in 0.0.1 of azure.azcollection	Default: "latest"	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.
attribute_name string		The name of an attribute that you want to match to attribute_value. If attribute_name is not a collection type it will return users where attribute_name is equal to attribute_value. If attribute_name is a collection type it will return users where attribute_value is in attribute_name. Mutually exclusive with object_id, user_principal_name, odata_filter and all. Required together with attribute_value.
attribute_value string		The value to match attribute_name to. If attribute_name is not a collection type it will return users where attribute_name is equal to attribute_value. If attribute_name is a collection type it will return users where attribute_value is in attribute_name. Required together with attribute_name.
auth_source string added in 0.0.1 of azure.azcollection	Choices: auto ← cli credential_file env msi	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.
cert_validation_mode string added in 0.0.1 of azure.azcollection	Choices: ignore validate	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.
client_id string		Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 0.0.1 of azure.azcollection	Default: "AzureCloud"	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.
log_mode string		Parent argument.
log_path string		Parent argument.
object_id string		The object id for the user. returns the user who has this object ID. Mutually exclusive with user_principal_name, attribute_name, odata_filter and all.
odata_filter string		returns users based on the the OData filter passed into this parameter. Mutually exclusive with object_id, attribute_name, user_principal_name and all.
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.
secret string		Azure client secret. Use when authenticating with a Service Principal.
subscription_id string		Your Azure subscription Id.
tenant string / required		The tenant ID.
user_principal_name string		The principal name of the user. returns the user who has this principal name. Mutually exclusive with object_id, attribute_name, odata_filter and all.

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.

Examples

- name: Using user_principal_name
  azure.azcollection.azure_rm_aduser_info:
    user_principal_name: [email protected]
    tenant: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Using object_id
  azure.azcollection.azure_rm_aduser_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    tenant: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Using attribute mailNickname - not a collection
  azure.azcollection.azure_rm_aduser_info:
    attribute_name: mailNickname
    attribute_value: users_mailNickname
    tenant: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Using attribute proxyAddresses - a collection
  azure.azcollection.azure_rm_aduser_info:
    attribute_name: proxyAddresses
    attribute_value: SMTP:[email protected]
    tenant: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Using Filter mailNickname
  azure.azcollection.azure_rm_aduser_info:
    odata_filter: mailNickname eq '[email protected]'
    tenant: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Using Filter proxyAddresses
  azure.azcollection.azure_rm_aduser_info:
    odata_filter: proxyAddresses/any(c:c eq 'SMTP:[email protected]')
    tenant: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Return Values

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

Key	Returned	Description
account_enabled boolean	always	Whether the account is enabled.
display_name string	always	The display name of the user. Sample: John Smith
mail string	always	The primary email address of the user. Sample: [email protected]
mail_nickname string	always	The mail alias for the user. Sample: jsmith
object_id string	always	The object_id for the user. Sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
user_principal_name string	always	The principal name of the user. Sample: [email protected]
user_type string	always	A string value that can be used to classify user types in your directory. Sample: Member

Authors

Cole Neubauer(@coleneubauer)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_aduser_info_module.html