azure.azcollection.azure_rm_managementgroup_info module – Get Azure Management Group facts

Note

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

New in azure.azcollection 1.5.0

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

  • 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

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"

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"

children

boolean

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.

Choices:

  • false ← (default)

  • true

client_id

string

Azure client ID. Use when authenticating with a Service Principal.

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"

flatten

boolean

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.

Choices:

  • false ← (default)

  • true

id

string

Limit results to a specific management group by id.

Mutually exclusive with name.

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

aliases: management_group_name

string

Limit results to a specific management group by name.

Mutually exclusive with 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.

recurse

boolean

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.

Choices:

  • false ← (default)

  • true

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

  • 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

Description

management_groups

list / elements=string

List of Management Group dicts.

Returned: always

children

list / elements=string

Child management groups or subscriptions.

Returned: if children is c(True)

Sample: ["Nested list of children. Same as top groups", " but without tenant_id."]

display_name

string

Management Group display name.

Returned: always

Sample: "My Management Group"

id

string

Management Group fully qualified id.

Returned: always

Sample: "/providers/Microsoft.Management/managementGroups/group-name"

name

string

Management Group display name.

Returned: always

Sample: "group-name"

tenant_id

string

Management Group tenant id

Returned: always

Sample: "00000000-0000-0000-0000-000000000000"

type

string

Management Group type

Returned: always

Sample: "/providers/Microsoft.Management/managementGroups"

subscriptions

list / elements=string

List of subscription objects.

Returned: if children and flatten are both c(True)

display_name

string

subscription display name.

Returned: always

Sample: "some-subscription-name"

id

string

subscription fully qualified id.

Returned: always

Sample: "/subscriptions/00000000-0000-0000-0000-feedc0ffee000000"

subscription_id

string

subscription guid.

Returned: always

Sample: "00000000-0000-0000-0000-feedc0ffee000000"

type

string

Management Group type

Returned: always

Sample: "/subscriptions"

Authors

  • Paul Aiton (@paultaiton)