Try SpotterGet GroupUser info.
| "added in version" 2.9 of azure.rm"
Authors: Zim Kalinowski (@zikalino)
preview | supported by community
Install with ansible-galaxy collection install azure.rm:==0.0.6
collections:
- name: azure.rm
version: 0.0.6Get info of GroupUser.
- name: ApiManagementListGroupUsers
azure.rm.apimanagementgroupuser_info:
resource_group: myResourceGroup
service_name: myService
group_id: myGroup
value:
description:
- Page values.
suboptions:
email:
description:
- Email address.
type: str
first_name:
description:
- First name.
type: str
groups:
description:
- Collection of groups user is part of.
suboptions:
built_in:
description:
- true if the group is one of the three system groups (Administrators, Developers,
or Guests); otherwise false.
type: boolean
description:
description:
- Group description. Can contain HTML formatting tags.
type: str
display_name:
description:
- Group name.
required: true
type: str
external_id:
description:
- For external groups, this property contains the id of the group from the
external identity provider, e.g. for Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group
object id>`; otherwise the value is null.
type: str
type:
description:
- Group type.
type: str
type: list
id:
description:
- Resource ID.
type: str
identities:
description:
- Collection of user identities.
suboptions:
id:
description:
- Identifier value within provider.
type: str
provider:
description:
- Identity provider name.
type: str
type: list
last_name:
description:
- Last name.
type: str
name:
description:
- Resource name.
type: str
note:
description:
- Optional note about a user set by the administrator.
type: str
registration_date:
description:
- 'Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ`
as specified by the ISO 8601 standard.<br>'
type: datetime
state:
description:
- Account state. Specifies whether the user is active or not. Blocked users are
unable to sign into the developer portal or call any APIs of subscribed products.
Default state is Active.
type: str
type:
description:
- Resource type for API Management resource.
type: str
type: list
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:
- Group identifier. Must be unique in the current API Management service instance.
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.
type: str
next_link:
description:
- Next page link if any.
type: str
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
service_name:
description:
- The name of the API Management service.
required: true
type: str
resource_group:
description:
- The name of the resource group.
required: true
type: str
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
group_user:
contains:
groupuser_name:
contains:
next_link:
description:
- Next page link if any.
returned: always
sample: null
type: str
value:
contains:
email:
description:
- Email address.
returned: always
sample: null
type: str
first_name:
description:
- First name.
returned: always
sample: null
type: str
groups:
contains:
built_in:
description:
- true if the group is one of the three system groups (Administrators,
Developers, or Guests); otherwise false.
returned: always
sample: null
type: boolean
description:
description:
- Group description. Can contain HTML formatting tags.
returned: always
sample: null
type: str
display_name:
description:
- Group name.
returned: always
sample: null
type: str
external_id:
description:
- For external groups, this property contains the id of the group
from the external identity provider, e.g. for Azure Active Directory
`aad://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise
the value is null.
returned: always
sample: null
type: str
type:
description:
- Group type.
returned: always
sample: null
type: str
description:
- Collection of groups user is part of.
returned: always
sample: null
type: dict
id:
description:
- Resource ID.
returned: always
sample: null
type: str
identities:
contains:
id:
description:
- Identifier value within provider.
returned: always
sample: null
type: str
provider:
description:
- Identity provider name.
returned: always
sample: null
type: str
description:
- Collection of user identities.
returned: always
sample: null
type: dict
last_name:
description:
- Last name.
returned: always
sample: null
type: str
name:
description:
- Resource name.
returned: always
sample: null
type: str
note:
description:
- Optional note about a user set by the administrator.
returned: always
sample: null
type: str
properties:
description:
- User entity contract properties.
returned: always
sample: null
type: dict
registration_date:
description:
- 'Date of user registration. The date conforms to the following format:
`yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.<br>'
returned: always
sample: null
type: datetime
state:
description:
- Account state. Specifies whether the user is active or not. Blocked
users are unable to sign into the developer portal or call any APIs
of subscribed products. Default state is Active.
returned: always
sample: null
type: str
type:
description:
- Resource type for API Management resource.
returned: always
sample: null
type: str
description:
- Page values.
returned: always
sample: null
type: dict
description: The key is the name of the server that the values relate to.
type: complex
description: A list of dict results where the key is the name of the GroupUser and
the values are the facts for that GroupUser.
returned: always
type: complex