azure.azcollection.azure_rm_adapplication_info module – Get Azure Active Directory application info

Note

This module is part of the azure.azcollection collection (version 3.1.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_adapplication_info.

New in azure.azcollection 1.6.0

Synopsis

• Get Azure Active Directory application 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.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
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"
app_diff list / elements=dictionary	A list of applications The application name or application ID is mandatory All fields of the applications can also be provided (parsing from a JSON or YAML). With this option, you can compare your self-defined applications with the current state using an application list. The applications that are present only in current state but not in your list will be returned as a list with all fields and will receive an additional status of ABSENT. This allows you to first add applications with azure_rm_adapplication and then use azure_rm_adapplication_info (option diff) to identify the applications that should not be in the current state and subsequently delete them with azure_rm_adapplication
app_display_name string	The application Name.
app_id string	The application ID.
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"
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"
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
identifier_uri string	The identifier_uri’s object ID.
log_mode string	Parent argument.
log_path string	Parent argument.
object_id string	The application’s object ID.
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 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.
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.

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: get ad app info by App ID
  azure_rm_adapplication_info:
    app_id: "{{ app_id }}"

- name: get ad app info ---- by object ID
  azure_rm_adapplication_info:
    object_id: "{{ object_id }}"

- name: get ad app info ---- by identifier uri
  azure_rm_adapplication_info:
    identifier_uri: "{{ identifier_uri }}"

- name: get ad app info ---- by display name
  azure_rm_adapplication_info:
    app_display_name: "{{ display_name }}"

- name: get ad app diff ---- by display name
  azure_rm_adapplication_info:
    app_diff:
      - app_display_name: "{{ display_name }}"
      - app_id: "{{ app_id }}"

Return Values

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

Key	Description
app_diff complex	The info of the ad application. Returned: aways
app_display_name string	Object’s display name or its prefix. Returned: always Sample: "app"
app_id string	The application ID. Returned: always Sample: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
identifier_uris list / elements=string	The identifiers_uri list of app. Returned: always Sample: ["http://ansible-atodorov"]
object_id string	It’s application’s object ID. Returned: always Sample: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
optional_claims complex	Declare the optional claims for the application. Returned: always
access_token_claims list / elements=string	The optional claims returned in the JWT access token Returned: always Sample: [{"name": "aud"}, {"source": null}, {"essential": false}, {"additional_properties": []}]
id_token_claims list / elements=string	The optional claims returned in the JWT ID token Returned: always Sample: [{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]
saml2_token_claims list / elements=string	The optional claims returned in the SAML token Returned: always Sample: [{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]
public_client_reply_urls list / elements=string	The public client redirect urls. Space-separated URIs to which Azure AD will redirect in response to an OAuth 2.0 request. Returned: always Sample: []
sign_in_audience string	The application can be used from any Azure AD tenants Returned: always Sample: "AzureADandPersonalMicrosoftAccount"
spa_reply_urls list / elements=string	The spa redirect urls. Space-separated URIs to which Azure AD will redirect in response to an OAuth 2.0 request. Returned: always Sample: []
state string	absent –> The app isn’t in the app_diff. Returned: always Sample: "absent"
web_reply_urls list / elements=string	The web redirect urls. Space-separated URIs to which Azure AD will redirect in response to an OAuth 2.0 request. Returned: always Sample: []
applications complex	The info of the ad application. Returned: aways
app_display_name string	Object’s display name or its prefix. Returned: always Sample: "app"
app_id string	The application ID. Returned: always Sample: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
identifier_uris list / elements=string	The identifiers_uri list of app. Returned: always Sample: ["http://ansible-atodorov"]
object_id string	It’s application’s object ID. Returned: always Sample: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
optional_claims complex	Declare the optional claims for the application. Returned: always
access_token_claims list / elements=string	The optional claims returned in the JWT access token Returned: always Sample: [{"name": "aud"}, {"source": null}, {"essential": false}, {"additional_properties": []}]
id_token_claims list / elements=string	The optional claims returned in the JWT ID token Returned: always Sample: [{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]
saml2_token_claims list / elements=string	The optional claims returned in the SAML token Returned: always Sample: [{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]
public_client_reply_urls list / elements=string	The public client redirect urls. Space-separated URIs to which Azure AD will redirect in response to an OAuth 2.0 request. Returned: always Sample: []
sign_in_audience string	The application can be used from any Azure AD tenants Returned: always Sample: "AzureADandPersonalMicrosoftAccount"
spa_reply_urls list / elements=string	The spa redirect urls. Space-separated URIs to which Azure AD will redirect in response to an OAuth 2.0 request. Returned: always Sample: []
web_reply_urls list / elements=string	The web redirect urls. Space-separated URIs to which Azure AD will redirect in response to an OAuth 2.0 request. Returned: always Sample: []

Authors

• haiyuan_zhang (@haiyuazhang) Fred-sun (@Fred-sun) guopeng_lin (@guopenglin) Xu Zhang (@xuzhang)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)