W3cubDocs

/Ansible

azure.azcollection.azure_rm_managementgroup – Manage Azure ManagementGroup instance

Note

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

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

New in version 0.1.1: of azure.azcollection

Synopsis

  • Create, update and delete instance of Azure ManagementGroup.

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 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.
append_tags
boolean
    Choices:
  • no
  • yes ←
Use to control if tags field is canonical or just appends to existing tags.
When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
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.
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.
group_id
string / required
Management Group ID.
id
string
The fully qualified ID for the management group.
For example /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.
log_mode
string
Parent argument.
log_path
string
Parent argument.
name
string
The name of the management group.
For example 00000000-0000-0000-0000-000000000000.
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.
properties
dictionary
The properties of the management group.
display_name
string
The friendly name of the management group.
parent_id
string
The parent of the management group.
tenant_id
string
The AAD Tenant ID associated with the management group.
For example 00000000-0000-0000-0000-000000000000.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
state
string
    Choices:
  • absent
  • present ←
Assert the state of the ManagementGroup.
Use present to create or update an ManagementGroup and absent to delete it.
subscription_id
string
Your Azure subscription Id.
tags
dictionary
Dictionary of string:string pairs to assign as metadata to the object.
Metadata tags on the object will be updated with any provided values.
To remove tags set append_tags option to false.
Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag.
Azure Front Door doesn't support the use of
Azure Automation and Azure CDN only support 15 tags on resources.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
type
string
The type of the resource.
For example /providers/Microsoft.Management/managementGroups.

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: create management group
  azure_rm_managementgroup:
    group_id: ChildGroup
    type: /providers/Microsoft.Management/managementGroups/
    name: ChildGroup
    properties:
      tenantId: 20000000-0000-0000-0000-000000000000
      display_name: ChildGroup
      parent_id: /providers/Microsoft.Management/managementGroups/RootGroup

- name: delete management group
  azure_rm_managementgroup:
    group_id: ChildGroup
    state: absent

Return Values

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

Key Returned Description
id
string
always
The fully qualified ID for the management group.
For example /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.
name
string
always
The name of the management group.
For example 00000000-0000-0000-0000-000000000000.
properties
complex
always
The properties of the management group.
details
complex
always
The details of the management group.
children
complex
always
The list of children.
display_name
string
always
The friendly name of the child resource.
id
string
always
The fully qualified ID for the child resource (management group or subscription).
For example /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.
name
string
always
The name of the child entity.
type
string
always
The fully qualified resource type which includes provider namespace.
For example /providers/Microsoft.Management/managementGroups.
parent
complex
always
The parent of the management group.
display_name
string
always
The friendly name of the parent management group.
id
string
always
The fully qualified ID for the parent management group.
For example /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.
name
string
always
The name of the parent management group
updated_by
string
always
The identity of the principal or process that updated the object.
updated_time
string
always
The date and time when this object was last updated.
version
string
always
The version number of the object.
display_name
string
always
The friendly name of the management group.
roles
string
always
The role definitions associated with the management group.
tenant_id
string
always
The AAD Tenant ID associated with the management group.
For example 00000000-0000-0000-0000-000000000000.
type
string
always
The type of the resource.
For example /providers/Microsoft.Management/managementGroups.


Authors

  • Zim Kalinowski (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_managementgroup_module.html