azure.azcollection.azure_rm_roleassignment_info – Gets Azure Role Assignment facts

Note

This plugin is part of the azure.azcollection collection (version 1.3.1).

To install it use: ansible-galaxy collection install azure.azcollection.

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

New in version 0.1.2: of azure.azcollection

Synopsis

  • Gets facts of Azure Role Assignment.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • azure >= 2.0.0

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.
assignee
string
Object id of a user, group or service principal.
Mutually exclusive with name and id.
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.
id
string
Fqid of role assignment to look up.
If set, role_definition_id and scope will be silently ignored.
Mutually exclusive with assignee and name.
name
string
Name of role assignment.
Requires that scope also be set.
Mutual exclusive with assignee and id.
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.
role_definition_id
string
Resource id of role definition.
scope
string
The scope to query for role assignments.
For example, use /subscriptions/{subscription-id}/ for a subscription.
/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name} for a resource group.
/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name}/providers/{resource-provider}/{resource-type}/{resource-name} for a resource.
By default will return all inhereted assignments from parent scopes, see strict_scope_match.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
strict_scope_match
boolean
    Choices:
  • no ←
  • yes
If strict_scope_match is True, role assignments will only be returned for the exact scope defined.
Inherited role assignments will be excluded from results.
Option will be silently ignored if no scope is provided.
subscription_id
string
Your Azure subscription Id.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.

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: Get role assignments for specific service principal
  azure_rm_roleassignment_info:
    assignee: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Get role assignments for specific scope that matches specific role definition
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    role_definition_id: /subscriptions/xxx-sub-guid-xxx/providers/Microsoft.Authorization/roleDefinitions/xxx-role-guid-xxxx

- name: Get role assignments for specific scope with no inherited assignments
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    strict_scope_match: True

- name: Get role assignments by name
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    name: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Get role assignments by id
  azure_rm_roleassignment_info:
    id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Return Values

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

Key Returned Description
roleassignments
complex
always
List of role assignments.
id
string
always
Id of role assignment.

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
name
string
always
Name of role assignment.

Sample:
myRoleAssignment
principal_id
string
always
Principal Id of the role assigned to.

Sample:
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
principal_type
string
always
Principal type of the role assigned to.

Sample:
ServicePrincipal
role_definition_id
string
always
Role definition id that was assigned to principal_id.

Sample:
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
scope
string
always
The role assignment scope.

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
type
string
always
Type of role assignment.

Sample:
custom


Authors

  • Yunge Zhu(@yungezz)
  • Paul Aiton(@paultaiton)

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