azure.azcollection.azure_rm_aduser module – Modify an Azure Active Directory user
Note
This module is part of the azure.azcollection collection (version 2.7.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_aduser
.
New in azure.azcollection 1.5.0
Synopsis
Create, delete, and update an Azure Active Directory user.
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 |
---|---|
A boolean determing whether or not the user account is enabled. Used when either creating or updating a user account. Choices:
|
|
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: |
|
The name of an attribute that you want to match to attribute_value. If attribute_name is not a collection type it will update or delete the user where attribute_name is equal to attribute_value. If attribute_name is a collection type it will update or delete the user where attribute_value is in attribute_name. Mutually exclusive with object_id, user_principal_name, and odata_filter. Required together with attribute_value. |
|
The value to match attribute_name to. If attribute_name is not a collection type it will update or delete the user where attribute_name is equal to attribute_value. If attribute_name is a collection type it will update or delete the user where attribute_value is in attribute_name. Required together with attribute_name. |
|
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: |
|
The name of the company that the user is associated with. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
|
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:
|
|
The display name of the user. Used when either creating or updating a user account. |
|
The given name for the user. Used when either creating or updating a user account. |
|
Parent argument. |
|
Parent argument. |
|
The primary email address of the user. Used when either creating or updating a user account. |
|
The mail alias for the user. Used when either creating or updating a user account. |
|
Mobile phone number of the user. Used when either creating or updating a user account. |
|
The object id for the user. Updates or deletes the user who has this object ID. Mutually exclusive with user_principal_name, attribute_name, and odata_filter. |
|
Filter that can be used to specify a user to update or delete. Mutually exclusive with object_id, attribute_name, and user_principal_name. |
|
Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during the creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. |
|
The on_premises_immutable_id of the user. Used when either creating or updating a user account. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Whether or not the user will be forced to change their password at next logon. If unspecified, Azure defaults this to true for new users. Used when either creating or updating a user account. Choices:
|
|
Identical behavior to password_force_change except multi-factor authentication (MFA) must be performed prior to changing the password. Used when either creating or updating a user account. Choices:
|
|
The password for the user. Used when either creating or updating a user account. |
|
Security profile found in ~/.azure/credentials file. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
State of the ad user. Use Choices:
|
|
Your Azure subscription Id. |
|
The surname for the user. Used when either creating or updating a user account. |
|
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. |
|
A two letter country code, ISO standard 3166. Required for a user that will be assigned licenses due to legal requirement to check for availability of services in countries. Used when either creating or updating a user account. |
|
The principal name of the user. Creates, updates, or deletes the user who has this principal name. Mutually exclusive with object_id, attribute_name, and odata_filter. |
|
A string value that can be used to classify user types in your directory, such as Member and Guest. Used when either creating or updating a user account. |
|
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 login
command.
Examples
- name: Create user
azure_rm_aduser:
user_principal_name: "{{ user_id }}"
state: "present"
account_enabled: "True"
display_name: "Test_{{ user_principal_name }}_Display_Name"
password_profile: "password"
mail_nickname: "Test_{{ user_principal_name }}_mail_nickname"
on_premises_immutable_id: "{{ object_id }}"
given_name: "First"
surname: "Last"
user_type: "Member"
usage_location: "US"
mail: "{{ user_principal_name }}@contoso.com"
mobile_phone: "+1234567890123"
company_name: 'Test Company'
on_premises_extension_attributes:
extension_attribute1: "test_extension_attribute1"
extension_attribute2: "test_extension_attribute2"
extension_attribute11: "test_extension_attribute11"
- name: Update user with new value for account_enabled
azure_rm_aduser:
user_principal_name: "{{ user_id }}"
state: "present"
account_enabled: "False"
- name: Delete user
azure_rm_aduser:
user_principal_name: "{{ user_id }}"
state: "absent"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Whether the account is enabled. Returned: always Sample: |
|
The name of the company that the user is associated with. Returned: always Sample: |
|
The display name of the user. Returned: always Sample: |
|
The primary email address of the user. Returned: always Sample: |
|
The mail alias for the user. Returned: always Sample: |
|
The mobile phone number of the user. Returned: always Sample: |
|
The object_id for the user. Returned: always Sample: |
|
Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during the creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. Returned: always Sample: |
|
The principal name of the user. Returned: always Sample: |
|
A string value that can be used to classify user types in your directory. Returned: always Sample: |