azure.azcollection.azure_rm_managementgroup_info – Get Azure Management Group facts

Note

This plugin is part of the azure.azcollection collection (version 1.5.0).

To install it use: ansible-galaxy collection install azure.azcollection.

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

New in version 1.5.0: of azure.azcollection

Synopsis

  • Get facts for a specific Management Group or all Management Groups.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults 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 0.0.1 of azure.azcollection
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
string
added in 0.0.1 of azure.azcollection
Default:
"latest"
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.
auth_source
string
added in 0.0.1 of azure.azcollection
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
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.
cert_validation_mode
string
added in 0.0.1 of azure.azcollection
    Choices:
  • ignore
  • validate
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.
children
boolean
    Choices:
  • no ←
  • yes
If c(False), then only name or id group will be fetched, or only the list of root groups.
If c(True), then the children groups will also be returned.
client_id
string
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
string
added in 0.0.1 of azure.azcollection
Default:
"AzureCloud"
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.
flatten
boolean
    Choices:
  • no ←
  • yes
If c(True) then child management_groups and subscriptions will be copied to the root of the management_groups and subscriptions return list respectively.
By default c(False), child elements will only apear in the nested complex.
Option only matters when children is c(True), and will otherwise be silently ignored.
id
string
Limit results to a specific management group by id.
Mutually exclusive with name.
name
string
Limit results to a specific management group by name.
Mutually exclusive with id.

aliases: management_group_name
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.
recurse
boolean
    Choices:
  • no ←
  • yes
By default, c(False), only the direct children are returned if children is c(True).
If c(True), then all descendants of the heirarchy are returned.
Option only matters when children is c(True), and will otherwise be silently ignored.
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.

Notes

Note

  • 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 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

azure_rm_subscription_info

module to look up more in depth information on subscriptions; for example tags.

azure_rm_roleassignment_info

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 az login command.

Examples

- 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

Return Values

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

Key Returned Description
management_groups
list / elements=string
always
List of Management Group dicts.
 
children
list / elements=string
if children is c(True)
Child management groups or subscriptions.

Sample:
Nested list of children. Same as top groups, but without tenant_id.
 
display_name
string
always
Management Group display name.

Sample:
My Management Group
 
id
string
always
Management Group fully qualified id.

Sample:
/providers/Microsoft.Management/managementGroups/group-name
 
name
string
always
Management Group display name.

Sample:
group-name
 
tenant_id
string
always
Management Group tenant id

Sample:
00000000-0000-0000-0000-000000000000
 
type
string
always
Management Group type

Sample:
/providers/Microsoft.Management/managementGroups
subscriptions
list / elements=string
if children and flatten are both c(True)
List of subscription objects.
 
display_name
string
always
subscription display name.

Sample:
some-subscription-name
 
id
string
always
subscription fully qualified id.

Sample:
/subscriptions/00000000-0000-0000-0000-feedc0ffee000000
 
subscription_id
string
always
subscription guid.

Sample:
00000000-0000-0000-0000-feedc0ffee000000
 
type
string
always
Management Group type

Sample:
/subscriptions


Authors

  • Paul Aiton (@paultaiton)