azure_rm_adgroup_info

Get Azure Active Directory group info

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_adgroup_info

Synopsis

Get Azure Active Directory group info

Parameters

Name	Type	Default	Description
ad_user	string		Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string		Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
all	bool	`false`	If True, will return all groups in tenant.
If False will return no users.
It is recommended that you instead identify a subset of groups and use filter.
api_profile	string	`latest`	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.
attribute_name	string		The name of an attribute that you want to match to I(attribute_value).
If I(attribute_name) is not a collection type it will return groups where I(attribute_name) is equal to I(attribute_value).
If I(attribute_name) is a collection type it will return groups where I(attribute_value) is in I(attribute_name).
attribute_value	string		The value to match attribute_name to.
If I(attribute_name) is not a collection type it will return groups where I(attribute_name) is equal to I(attribute_value).
If I(attribute_name) is a collection type it will groups users where I(attribute_value) is in I(attribute_name).
auth_source	string	`auto`	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.
cert_validation_mode	string		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.
check_membership	string		The object ID of the contact, group, user, or service principal to check for membership against returned groups.
client_id	string		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.
cloud_environment	string	`AzureCloud`	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.
disable_instance_discovery	bool	`false`	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.
log_mode	string		Parent argument.
log_path	string		Parent argument.
object_id	string		The object id for the ad group.
returns the group which has this object ID.
odata_filter	string		returns groups based on the the OData filter passed into this parameter.
oidc_token	string		Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
This token is exchanged with Azure AD using OIDC federated identity.
Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.
Can also be set via the C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string		Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
The file must contain only raw token.
This method is commonly used in platforms that materialize OIDC tokens as files
Can also be set via the C(AZURE_FEDERATED_TOKEN_FILE) environment variable.
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.
raw_membership	bool	`false`	By default the group_members return property is flattened and partially filtered of non-User objects before return. This argument disables those transformations.
return_group_members	bool	`false`	Indicate whether the members of a group should be returned with the returned groups.
return_member_groups	bool	`false`	Indicate whether the groups in which a groups is a member should be returned with the returned groups.
return_owners	bool	`false`	Indicate whether the owners of a group should be returned with the returned groups.
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		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.
x509_certificate_path	string		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.

Example

yaml

- name: Return a specific group using object_id
  azure.azcollection.azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Return a specific group using object_id and  return the owners of the group
  azure.azcollection.azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_owners: true

- name: Return a specific group using object_id and return the owners and members of the group
  azure.azcollection.azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_owners: true
    return_group_members: true
- name: Return a specific group using object_id and return the owners and members of the group. Return service principals and nested groups.
  azure.azcollection.azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_owners: true
    return_group_members: true
    raw_membership: true

- name: Return a specific group using object_id and return the groups the group is a member of
  azure.azcollection.azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_member_groups: true

- name: Return a specific group using object_id and check an ID for membership
  azure.azcollection.azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    check_membership: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Return a specific group using displayName for attribute_name
  azure.azcollection.azure_rm_adgroup_info:
    attribute_name: "displayName"
    attribute_value: "Display-Name-Of-AD-Group"

- name: Return groups matching odata_filter
  azure.azcollection.azure_rm_adgroup_info:
    odata_filter: "mailNickname eq 'Mail-Nickname-Of-AD-Group'"

- name: Return all groups
  azure.azcollection.azure_rm_adgroup_info:
    all: true