azure_rm_aduser_info
Get Azure Active Directory user info
Collection: azure.azcollection
Full Name: azure.azcollection.azure_rm_aduser_info
Synopsis
Get Azure Active Directory user info
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| ad_user | string | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | ||
| adfs_authority_url | string | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | ||
| all | bool | If C(True), will return all users in tenant. | ||
| If C(False) will return no users. | ||||
| It is recommended that you instead identify a subset of users and use filter. | ||||
| Mutually exclusive with I(object_id), I(attribute_name), I(odata_filter) and I(user_principal_name). | ||||
| api_profile | string | latest | Selects an API profile to use when communicating with Azure services. Default value of C(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 I(attribute_name) is not a collection type it will return users where I(attribute_name) is equal to I(attribute_value). | ||||
| If I(attribute_name) is a collection type it will return users where I(attribute_value) is in I(attribute_name). | ||||
| Mutually exclusive with I(object_id), I(user_principal_name), I(odata_filter) and I(all). | ||||
| Required together with I(attribute_value). | ||||
| attribute_value | string | The value to match attribute_name to. | ||
| If I(attribute_name) is not a collection type it will return users where I(attribute_name) is equal to I(attribute_value). | ||||
| If I(attribute_name) is a collection type it will return users where I(attribute_value) is in I(attribute_name). | ||||
| Required together with I(attribute_name). | ||||
| auth_source | string | auto | Controls the source of the credentials to use for authentication. | |
| Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | ||||
| When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). | ||||
| When set to C(env), the credentials will be read from the environment variables. | ||||
| When set to C(credential_file), it will read the profile from C(~/.azure/credentials). | ||||
| When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. | ||||
| cert_validation_mode | string | 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | ||
| client_id | string | Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). | ||
| Can also be set via the C(AZURE_CLIENT_ID) environment variable. | ||||
| cloud_environment | string | AzureCloud | For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
| disable_instance_discovery | bool | false | 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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) 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 I(user_principal_name), I(attribute_name), I(odata_filter) and I(all). | ||||
| odata_filter | string | Returns users based on the the OData filter passed into this parameter. | ||
| Mutually exclusive with I(object_id), I(attribute_name), I(user_principal_name) and I(all). | ||||
| oidc_token | string | 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 C(AZURE_FEDERATED_TOKEN) environment variable. | ||||
| oidc_token_file_path | string | 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 C(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. | ||
| secret | string | Azure client secret. Use when authenticating with a Service Principal. | ||
| subscription_id | string | Your Azure subscription Id. | ||
| tenant | string | Azure tenant ID. Use when authenticating with a Service Principal. | ||
| thumbprint | string | The thumbprint of the private key specified in I(x509_certificate_path). | ||
| Use when authenticating with a Service Principal. | ||||
| Required if I(x509_certificate_path) is defined. | ||||
| user_principal_name | string | The principal name of the user. | ||
| returns the user who has this principal name. | ||||
| Mutually exclusive with I(object_id), I(attribute_name), I(odata_filter) and I(all). | ||||
| x509_certificate_path | string | 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. |
Example
yaml
- name: Using user_principal_name
azure.azcollection.azure_rm_aduser_info:
user_principal_name: user@contoso.com
- name: Using object_id
azure.azcollection.azure_rm_aduser_info:
object_id: 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
- name: Using attribute proxyAddresses - a collection
azure.azcollection.azure_rm_aduser_info:
attribute_name: proxyAddresses
attribute_value: SMTP:user@contoso.com
- name: Using Filter mailNickname
azure.azcollection.azure_rm_aduser_info:
odata_filter: mailNickname eq 'user@contoso.com'
- name: Using Filter proxyAddresses
azure.azcollection.azure_rm_aduser_info:
odata_filter: proxyAddresses/any(c:c eq 'SMTP:user@contoso.com')