Class: Azure::ApiManagement::Mgmt::V2016_10_10::Models::UserCreateParameters

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-10-10/generated/azure_mgmt_api_management/models/user_create_parameters.rb

Overview

Parameters supplied to the Create User operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#email ⇒ String

within the service instance.

Returns:

  • (String) —

    Email address. Must not be empty and must be unique



17
18
19
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/user_create_parameters.rb', line 17

def email
  @email
end

#first_name ⇒ String

Returns First name.

Returns:

  • (String) —

    First name.



23
24
25
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/user_create_parameters.rb', line 23

def first_name
  @first_name
end

#last_name ⇒ String

Returns Last name.

Returns:

  • (String) —

    Last name.



26
27
28
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/user_create_parameters.rb', line 26

def last_name
  @last_name
end

#note ⇒ String

Returns Optional note about a user set by the administrator.

Returns:

  • (String) —

    Optional note about a user set by the administrator.



36
37
38
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/user_create_parameters.rb', line 36

def note
  @note
end

#password ⇒ String

Returns User Password.

Returns:

  • (String) —

    User Password.



20
21
22
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/user_create_parameters.rb', line 20

def password
  @password
end

#state ⇒ UserStateContract

is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: ‘Active’, ‘Blocked’. Default value: ‘Active’ .

Returns:



33
34
35
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/user_create_parameters.rb', line 33

def state
  @state
end

Class Method Details

.mapper ⇒ Object

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



43
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/user_create_parameters.rb', line 43

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'UserCreateParameters',
    type: {
      name: 'Composite',
      class_name: 'UserCreateParameters',
      model_properties: {
        email: {
          client_side_validation: true,
          required: true,
          serialized_name: 'email',
          constraints: {
            MaxLength: 254,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        password: {
          client_side_validation: true,
          required: true,
          serialized_name: 'password',
          type: {
            name: 'String'
          }
        },
        first_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'firstName',
          constraints: {
            MaxLength: 100,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        last_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'lastName',
          constraints: {
            MaxLength: 100,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'state',
          default_value: 'Active',
          type: {
            name: 'Enum',
            module: 'UserStateContract'
          }
        },
        note: {
          client_side_validation: true,
          required: false,
          serialized_name: 'note',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end