/
azure.graphrbac.models.UserCreateParameters.yml
232 lines (211 loc) · 7.28 KB
/
azure.graphrbac.models.UserCreateParameters.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
### YamlMime:PythonClass
uid: azure.graphrbac.models.UserCreateParameters
name: UserCreateParameters
fullName: azure.graphrbac.models.UserCreateParameters
module: azure.graphrbac.models
inheritances:
- azure.graphrbac.models.user_base_py3.UserBase
summary: 'Request parameters for creating a new work or school account user.
All required parameters must be populated in order to send to Azure.'
constructor:
syntax: 'UserCreateParameters(*, account_enabled: bool, display_name: str, password_profile,
user_principal_name: str, mail_nickname: str, additional_properties=None, immutable_id:
str = None, usage_location: str = None, given_name: str = None, surname: str =
None, user_type=None, mail: str = None, **kwargs)'
parameters:
- name: additional_properties
description: 'Unmatched properties from the message are
deserialized this collection'
isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:object>]
- name: immutable_id
description: '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.'
isRequired: true
types:
- <xref:str>
- name: usage_location
description: '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".'
isRequired: true
types:
- <xref:str>
- name: given_name
description: The given name for the user.
isRequired: true
types:
- <xref:str>
- name: surname
description: The user's surname (family name or last name).
isRequired: true
types:
- <xref:str>
- name: user_type
description: 'A string value that can be used to classify user types
in your directory, such as ''Member'' and ''Guest''. Possible values include:
''Member'', ''Guest'''
isRequired: true
types:
- <xref:str>
- <xref:azure.graphrbac.models.UserType>
- name: account_enabled
description: Required. Whether the account is enabled.
isRequired: true
types:
- <xref:bool>
- name: display_name
description: Required. The display name of the user.
isRequired: true
types:
- <xref:str>
- name: password_profile
description: Required. Password Profile
isRequired: true
types:
- <xref:azure.graphrbac.models.PasswordProfile>
- name: user_principal_name
description: 'Required. The user principal name
(<xref:mailto:someuser@contoso.com>). It must contain one of the verified domains
for
the tenant.'
isRequired: true
types:
- <xref:str>
- name: mail_nickname
description: Required. The mail alias for the user.
isRequired: true
types:
- <xref:str>
- name: mail
description: The primary email address of the user.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: account_enabled
isRequired: true
- name: display_name
isRequired: true
- name: password_profile
isRequired: true
- name: user_principal_name
isRequired: true
- name: mail_nickname
isRequired: true
- name: additional_properties
isRequired: true
- name: immutable_id
isRequired: true
- name: usage_location
isRequired: true
- name: given_name
isRequired: true
- name: surname
isRequired: true
- name: user_type
isRequired: true
- name: mail
isRequired: true
methods:
- uid: azure.graphrbac.models.UserCreateParameters.as_dict
name: as_dict
summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\
\ optionally use a callback as parameter:\n\nKey is the attribute name used in\
\ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\
msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\
\ in this object.\n\nThe string returned will be used to serialize the key.\n\
If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
\ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
\ pass the kwargs is_xml=True."
signature: as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>,
**kwargs)
parameters:
- name: key_transformer
description: A key transformer function.
types:
- <xref:function>
- name: keep_readonly
defaultValue: 'True'
return:
description: A dict JSON compatible object
types:
- <xref:dict>
- uid: azure.graphrbac.models.UserCreateParameters.deserialize
name: deserialize
summary: Parse a str using the RestAPI syntax and return a model.
signature: deserialize(data, content_type=None)
parameters:
- name: data
description: A str using RestAPI structure. JSON by default.
isRequired: true
types:
- <xref:str>
- name: content_type
description: JSON by default, set application/xml if XML.
defaultValue: None
types:
- <xref:str>
return:
description: An instance of this model
exceptions:
- type: DeserializationError if something went wrong
- uid: azure.graphrbac.models.UserCreateParameters.enable_additional_properties_sending
name: enable_additional_properties_sending
signature: enable_additional_properties_sending()
- uid: azure.graphrbac.models.UserCreateParameters.from_dict
name: from_dict
summary: 'Parse a dict using given key extractor return a model.
By default consider key
extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor
and last_rest_key_case_insensitive_extractor)'
signature: from_dict(data, key_extractors=None, content_type=None)
parameters:
- name: data
description: A dict using RestAPI structure
isRequired: true
types:
- <xref:dict>
- name: content_type
description: JSON by default, set application/xml if XML.
defaultValue: None
types:
- <xref:str>
- name: key_extractors
defaultValue: None
return:
description: An instance of this model
exceptions:
- type: DeserializationError if something went wrong
- uid: azure.graphrbac.models.UserCreateParameters.is_xml_model
name: is_xml_model
signature: is_xml_model()
- uid: azure.graphrbac.models.UserCreateParameters.serialize
name: serialize
summary: 'Return the JSON that would be sent to azure from this model.
This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*.
If you want XML serialization, you can pass the kwargs is_xml=True.'
signature: serialize(keep_readonly=False, **kwargs)
parameters:
- name: keep_readonly
description: If you want to serialize the readonly attributes
defaultValue: 'False'
types:
- <xref:bool>
return:
description: A dict JSON compatible object
types:
- <xref:dict>
- uid: azure.graphrbac.models.UserCreateParameters.validate
name: validate
summary: Validate this model recursively and return a list of ValidationError.
signature: validate()
return:
description: A list of validation error
types:
- <xref:list>