azure.azcollection.azure_service_principal_attribute lookup – Look up Azure service principal attributes.

Note

This lookup plugin is part of the azure.azcollection collection (version 3.11.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 lookup plugin, see Requirements for details.

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

New in azure.azcollection 1.12.0

Synopsis

  • Describes object id of your Azure service principal account.

Requirements

The below requirements are needed on the local controller node that executes this lookup.

  • msgraph-sdk

Keyword parameters

This describes keyword parameters of the lookup. These are the values key1=value1, key2=value2 and so on in the following examples: lookup('azure.azcollection.azure_service_principal_attribute', key1=value1, key2=value2, ...) and query('azure.azcollection.azure_service_principal_attribute', key1=value1, key2=value2, ...)

Parameter

Comments

client_id

aliases: azure_client_id

string

azure service principal client id.

cloud_environment

aliases: azure_cloud_environment

string

azure cloud environment

secret

aliases: azure_secret

string

azure service principal secret

tenant

aliases: azure_tenant

string

azure tenant

Notes

Note

  • If MSI is not enabled on ansible host, it’s required to provide a valid service principal which has access to the key vault.

  • To authenticate via service principal, pass client_id, secret and tenant or set environment variables AZURE_CLIENT_ID, AZURE_CLIENT_SECRET and AZURE_TENANT_ID.

  • Authentication via az login is also supported.

Examples

set_fact:
  object_id: "{{ lookup('azure_service_principal_attribute',
                         client_id=azure_client_id,
                         secret=azure_secret,
                         tenant=azure_secret) }}"

Return Value

Key

Description

Return value

string

Returns object id of service principal.

Returned: success

Authors

  • Yunge Zhu (@yungezz)