azure / azure.azcollection / 2.3.0 / module / azure_rm_managementgroup_info Get Azure Management Group facts | "added in version" 1.5.0 of azure.azcollection" Authors: Paul Aiton (@paultaiton)azure.azcollection.azure_rm_managementgroup_info (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Get facts for a specific Management Group or all Management Groups.
- 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
id: description: - Limit results to a specific management group by id. - Mutually exclusive with I(name). type: str name: aliases: - management_group_name description: - Limit results to a specific management group by name. - Mutually exclusive with I(id). 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 flatten: default: false description: - 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 I(children) is c(True), and will otherwise be silently ignored. type: bool profile: description: - Security profile found in ~/.azure/credentials file. type: str recurse: default: false description: - By default, c(False), only the direct children are returned if I(children) is c(True). - If c(True), then all descendants of the heirarchy are returned. - Option only matters when I(children) is c(True), and will otherwise be silently ignored. type: bool children: default: false description: - If c(False), then only I(name) or I(id) group will be fetched, or only the list of root groups. - If c(True), then the children groups will also be returned. type: bool 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 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 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
management_groups: contains: children: description: Child management groups or subscriptions. returned: if I(children) is c(True) sample: Nested list of children. Same as top groups, but without tenant_id. type: list display_name: description: Management Group display name. returned: always sample: My Management Group type: str id: description: Management Group fully qualified id. returned: always sample: /providers/Microsoft.Management/managementGroups/group-name type: str name: description: Management Group display name. returned: always sample: group-name type: str tenant_id: description: Management Group tenant id returned: always sample: 00000000-0000-0000-0000-000000000000 type: str type: description: Management Group type returned: always sample: /providers/Microsoft.Management/managementGroups type: str description: - List of Management Group dicts. returned: always type: list subscriptions: contains: display_name: description: subscription display name. returned: always sample: some-subscription-name type: str id: description: subscription fully qualified id. returned: always sample: /subscriptions/00000000-0000-0000-0000-feedc0ffee000000 type: str subscription_id: description: subscription guid. returned: always sample: 00000000-0000-0000-0000-feedc0ffee000000 type: str type: description: Management Group type returned: always sample: /subscriptions type: str description: - List of subscription objects. returned: if I(children) and I(flatten) are both c(True) type: list