Resource Type: azure_graphrbac_user

Defined in:

lib/puppet/type/azure_graphrbac_user.rb

Providers:

arm

Overview

Active Directory user information.

Properties

• account_enabled

  Whether the account is enabled.

• deletion_timestamp

  The time at which the directory object was deleted.

• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• given_name

  The given name for the user.

• immutable_id

  This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.

• mail

  The primary email address of the user.

• mail_nickname

  The mail alias for the user.

• object_id

  The object ID.

• object_type

  The object type.

• sign_in_names

  The sign-in names of the user.

• surname

  The user’s surname (family name or last name).

• usage_location

  A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: ‘US’, ‘JP’, and ‘GB’.

• user_principal_name

  The principal name of the user.

• user_type

  A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’.

Parameters

• api_version

  Client API version.

• display_name (namevar)

  The display name of the user.

• parameters

  Parameters to create a user.

• provider

  The specific backend to use for this ‘azure_graphrbac_user` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

• tenant_id

  The tenant ID.

• upn_or_object_id

  The object ID or principal name of the user to delete.