azure.azcollection.azure_rm_managementgroup_info – Get Azure Management Group facts
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
It is not included in
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:
New in version 1.5.0: of azure.azcollection
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
azure_rm_managementgroup_info - The roles assigned to the principal executing the playbook will determine what is a root management_group. You may also be able to request the details of a parent management group, but unable to fetch that group. It is highly recommended that if children is set c(True) that specific management groups are requested since a list of all groups will require an additional Azure API call for each returned group.
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
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.
module to look up more in depth information on subscriptions; for example tags.
module to look up RBAC role assignments, which can use management group id as scope.
- Sign in with Azure CLI
How to authenticate using the
- name: Get facts for all root management groups for authenticated principal azure_rm_managementgroup_info: - name: Get facts for one management group by id with direct children azure_rm_managementgroup_info: id: /providers/Microsoft.Management/managementGroups/contoso-group children: True - name: Get facts for one management group by name with all children, flattened into top list azure_rm_managementgroup_info: name: "contoso-group" children: True recurse: True flatten: True
Common return values are documented here, the following are the fields unique to this module: