Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::UserContract

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01/generated/azure_mgmt_api_management/models/user_contract.rb

Overview

User details.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#email ⇒ String

Returns Email address.

Returns:

  • (String) —

    Email address.



35
36
37
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/user_contract.rb', line 35

def email
  @email
end

#first_name ⇒ String

Returns First name.

Returns:

  • (String) —

    First name.



29
30
31
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/user_contract.rb', line 29

def first_name
  @first_name
end

#groups ⇒ Array<GroupContract>

Returns Collection of groups user is part of.

Returns:

  • (Array<GroupContract>) —

    Collection of groups user is part of.



44
45
46
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/user_contract.rb', line 44

def groups
  @groups
end

#identities ⇒ Array<UserIdentityContract>

Returns Collection of user identities.

Returns:



26
27
28
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/user_contract.rb', line 26

def identities
  @identities
end

#last_name ⇒ String

Returns Last name.

Returns:

  • (String) —

    Last name.



32
33
34
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/user_contract.rb', line 32

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.



23
24
25
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/user_contract.rb', line 23

def note
  @note
end

#registration_date ⇒ DateTime

following format: ‘yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.

Returns:

  • (DateTime) —

    Date of user registration. The date conforms to the



41
42
43
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/user_contract.rb', line 41

def registration_date
  @registration_date
end

#state ⇒ UserState

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’, ‘pending’, ‘deleted’. Default value: ‘active’ .

Returns:

  • (UserState) —

    Account state. Specifies whether the user is active



20
21
22
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/user_contract.rb', line 20

def state
  @state
end

Class Method Details

.mapper ⇒ Object

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



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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/user_contract.rb', line 51

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'UserContract',
    type: {
      name: 'Composite',
      class_name: 'UserContract',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.state',
          default_value: 'active',
          type: {
            name: 'String'
          }
        },
        note: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.note',
          type: {
            name: 'String'
          }
        },
        identities: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.identities',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'UserIdentityContractElementType',
                type: {
                  name: 'Composite',
                  class_name: 'UserIdentityContract'
                }
            }
          }
        },
        first_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.firstName',
          type: {
            name: 'String'
          }
        },
        last_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.lastName',
          type: {
            name: 'String'
          }
        },
        email: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.email',
          type: {
            name: 'String'
          }
        },
        registration_date: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.registrationDate',
          type: {
            name: 'DateTime'
          }
        },
        groups: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.groups',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'GroupContractElementType',
                type: {
                  name: 'Composite',
                  class_name: 'GroupContract'
                }
            }
          }
        }
      }
    }
  }
end