Class: Azure::Graph::Mgmt::V1_6::Models::UserBase

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/1.6/generated/azure_mgmt_graph/models/user_base.rb

Overview

Model object.

Direct Known Subclasses

User, UserCreateParameters, UserUpdateParameters

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#given_name ⇒ String

Returns The given name for the user.

Returns:

  • (String) —

    The given name for the user.



29
30
31
 
# File 'lib/1.6/generated/azure_mgmt_graph/models/user_base.rb', line 29

def given_name
  @given_name
end

#immutable_id ⇒ String

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.

Returns:

  • (String) —

    This must be specified if you are using a federated



20
21
22
 
# File 'lib/1.6/generated/azure_mgmt_graph/models/user_base.rb', line 20

def immutable_id
  @immutable_id
end

#surname ⇒ String

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

Returns:

  • (String) —

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



32
33
34
 
# File 'lib/1.6/generated/azure_mgmt_graph/models/user_base.rb', line 32

def surname
  @surname
end

#usage_location ⇒ String

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”.

Returns:

  • (String) —

    A two letter country code (ISO standard 3166).



26
27
28
 
# File 'lib/1.6/generated/azure_mgmt_graph/models/user_base.rb', line 26

def usage_location
  @usage_location
end

#user_type ⇒ UserType

types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’

Returns:

  • (UserType) —

    A string value that can be used to classify user



37
38
39
 
# File 'lib/1.6/generated/azure_mgmt_graph/models/user_base.rb', line 37

def user_type
  @user_type
end

Class Method Details

.mapper ⇒ Object

Mapper for UserBase class as Ruby Hash. This will be used for serialization/deserialization.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/1.6/generated/azure_mgmt_graph/models/user_base.rb', line 44

def self.mapper()
  {
    required: false,
    serialized_name: 'UserBase',
    type: {
      name: 'Composite',
      class_name: 'UserBase',
      model_properties: {
        immutable_id: {
          required: false,
          serialized_name: 'immutableId',
          type: {
            name: 'String'
          }
        },
        usage_location: {
          required: false,
          serialized_name: 'usageLocation',
          type: {
            name: 'String'
          }
        },
        given_name: {
          required: false,
          serialized_name: 'givenName',
          type: {
            name: 'String'
          }
        },
        surname: {
          required: false,
          serialized_name: 'surname',
          type: {
            name: 'String'
          }
        },
        user_type: {
          required: false,
          serialized_name: 'userType',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end