exec.azurerm.graphrbac.service_principal

Azure Resource Manager (ARM) Graph RBAC Service Principal Execution Module

New in version 2.4.0.

Changed in version 4.0.0.

maintainer:

<devops@eitr.tech>
configuration:

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)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.graphrbac.service_principal.get(hub, ctx, object_id, **kwargs)

New in version 4.0.0.

Gets service principal information from the directory.

Parameters:object_id – The object ID of the service principal to get.

CLI Example:

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

New in version 2.4.0.

Changed in version 4.0.0.

Gets list of service principals from the current tenant.

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

CLI Example:

azurerm.graphrbc.service_principal.list sp_filter="displayName eq 'Test Buddy'"