azure / azure.azcollection / 2.3.0 / module / azure_rm_managementgroup Manage Azure ManagementGroup instance | "added in version" 0.1.1 of azure.azcollection" Authors: Zim Kalinowski (@zikalino)azure.azcollection.azure_rm_managementgroup (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Create, update and delete instance of Azure ManagementGroup.
- name: Create new management group azure_rm_managementgroup: group_id: test type: /providers/Microsoft.Management/managementGroups/ name: test
- name: create management group azure_rm_managementgroup: group_id: ChildGroup type: /providers/Microsoft.Management/managementGroups/ name: ChildGroup properties: tenant_id: 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
id: description: - The fully qualified ID for the management group. - For example /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000. type: str name: description: - The name of the management group. - For example 00000000-0000-0000-0000-000000000000. type: str tags: description: - 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. type: dict type: description: - The type of the resource. - For example /providers/Microsoft.Management/managementGroups. type: str state: choices: - absent - present default: present description: - Assert the state of the ManagementGroup. - Use C(present) to create or update an ManagementGroup and C(absent) to delete it. type: str secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str group_id: description: - Management Group ID. required: true type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. type: str properties: description: - The properties of the management group. suboptions: display_name: description: - The friendly name of the management group. type: str parent_id: description: - The parent of the management group. type: str tenant_id: description: - The AAD Tenant ID associated with the management group. - For example 00000000-0000-0000-0000-000000000000. type: str type: dict thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection append_tags: default: true description: - 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. type: bool auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection x509_certificate_path: description: - 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. type: path version_added: 1.14.0 version_added_collection: azure.azcollection disable_instance_discovery: default: false description: - Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. - Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection
id: description: - The fully qualified ID for the management group. - For example /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000. returned: always type: str name: description: - The name of the management group. - For example 00000000-0000-0000-0000-000000000000. returned: always type: str properties: contains: details: contains: children: contains: display_name: description: - The friendly name of the child resource. returned: always type: str id: description: - The fully qualified ID for the child resource (management group or subscription). - For example /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000. returned: always type: str name: description: - The name of the child entity. returned: always type: str type: description: - The fully qualified resource type which includes provider namespace. - For example /providers/Microsoft.Management/managementGroups. returned: always type: str description: - The list of children. returned: always type: complex parent: contains: display_name: description: - The friendly name of the parent management group. returned: always type: str id: description: - The fully qualified ID for the parent management group. - For example /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000. returned: always type: str name: description: - The name of the parent management group returned: always type: str description: - The parent of the management group. returned: always type: complex updated_by: description: - The identity of the principal or process that updated the object. returned: always type: str updated_time: description: - The date and time when this object was last updated. returned: always type: str version: description: - The version number of the object. returned: always type: str description: - The details of the management group. returned: always type: complex display_name: description: - The friendly name of the management group. returned: always type: str roles: description: - The role definitions associated with the management group. returned: always type: str tenant_id: description: - The AAD Tenant ID associated with the management group. - For example 00000000-0000-0000-0000-000000000000. returned: always type: str description: - The properties of the management group. returned: always type: complex type: description: - The type of the resource. - For example /providers/Microsoft.Management/managementGroups. returned: always type: str