Azure Resource Manager (ARM) Graph RBAC User Execution Module

New in version 2.4.0.

Changed in version 4.0.0.




This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

  • AZURE_PUBLIC_CLOUD (default)
idem_azurerm.exec.azurerm.graphrbac.user.get(hub, ctx, upn_or_object_id, **kwargs)

New in version 4.0.0.

Gets service principal information from the directory.

Parameters:upn_or_object_id – The object ID or principal name of the user for which to get information.

CLI Example:

azurerm.graphrbac.user.get test_id
idem_azurerm.exec.azurerm.graphrbac.user.list_(hub, ctx, user_filter=None, **kwargs)

New in version 2.4.0.

Changed in version 4.0.0.

Gets list of users for the current tenant.

Parameters:user_filter – The filter to apply to the operation.

CLI Example:

azurerm.graphrbc.user.list user_filter="displayName eq 'Test Buddy'"