pulumi-azuread 5.48.0a1706744699__py3-none-any.whl → 6.8.0a1766208344__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of pulumi-azuread might be problematic. Click here for more details.
- pulumi_azuread/__init__.py +48 -1
- pulumi_azuread/_inputs.py +3803 -919
- pulumi_azuread/_utilities.py +52 -12
- pulumi_azuread/access_package.py +84 -78
- pulumi_azuread/access_package_assignment_policy.py +202 -196
- pulumi_azuread/access_package_catalog.py +82 -76
- pulumi_azuread/access_package_catalog_role_assignment.py +73 -67
- pulumi_azuread/access_package_resource_catalog_association.py +73 -67
- pulumi_azuread/access_package_resource_package_association.py +79 -73
- pulumi_azuread/administrative_unit.py +120 -100
- pulumi_azuread/administrative_unit_member.py +66 -50
- pulumi_azuread/administrative_unit_role_member.py +75 -69
- pulumi_azuread/app_role_assignment.py +164 -264
- pulumi_azuread/application.py +766 -692
- pulumi_azuread/application_api_access.py +84 -80
- pulumi_azuread/application_app_role.py +120 -116
- pulumi_azuread/application_certificate.py +349 -211
- pulumi_azuread/application_fallback_public_client.py +50 -44
- pulumi_azuread/application_federated_identity_credential.py +142 -197
- pulumi_azuread/application_from_template.py +90 -84
- pulumi_azuread/application_identifier_uri.py +56 -52
- pulumi_azuread/application_known_clients.py +50 -44
- pulumi_azuread/application_optional_claims.py +87 -81
- pulumi_azuread/application_owner.py +76 -42
- pulumi_azuread/application_password.py +159 -205
- pulumi_azuread/application_permission_scope.py +160 -156
- pulumi_azuread/application_pre_authorized.py +120 -236
- pulumi_azuread/application_redirect_uris.py +75 -69
- pulumi_azuread/application_registration.py +315 -309
- pulumi_azuread/authentication_strength_policy.py +73 -67
- pulumi_azuread/claims_mapping_policy.py +48 -42
- pulumi_azuread/conditional_access_policy.py +248 -232
- pulumi_azuread/config/__init__.py +2 -1
- pulumi_azuread/config/__init__.pyi +23 -17
- pulumi_azuread/config/vars.py +47 -37
- pulumi_azuread/custom_directory_role.py +128 -122
- pulumi_azuread/directory_role.py +60 -54
- pulumi_azuread/directory_role_assignment.py +194 -181
- pulumi_azuread/directory_role_eligibility_schedule_request.py +86 -80
- pulumi_azuread/directory_role_member.py +54 -48
- pulumi_azuread/get_access_package.py +45 -31
- pulumi_azuread/get_access_package_catalog.py +40 -27
- pulumi_azuread/get_access_package_catalog_role.py +39 -25
- pulumi_azuread/get_administrative_unit.py +42 -27
- pulumi_azuread/get_application.py +135 -94
- pulumi_azuread/get_application_published_app_ids.py +42 -47
- pulumi_azuread/get_application_template.py +49 -33
- pulumi_azuread/get_client_config.py +24 -15
- pulumi_azuread/get_directory_object.py +32 -21
- pulumi_azuread/get_directory_role_templates.py +20 -12
- pulumi_azuread/get_directory_roles.py +23 -14
- pulumi_azuread/get_domains.py +65 -46
- pulumi_azuread/get_group.py +147 -88
- pulumi_azuread/get_group_role_management_policy.py +178 -0
- pulumi_azuread/get_groups.py +71 -51
- pulumi_azuread/get_named_location.py +47 -22
- pulumi_azuread/get_service_principal.py +108 -90
- pulumi_azuread/get_service_principals.py +60 -64
- pulumi_azuread/get_user.py +186 -118
- pulumi_azuread/get_users.py +96 -53
- pulumi_azuread/group.py +622 -464
- pulumi_azuread/group_member.py +56 -50
- pulumi_azuread/group_role_management_policy.py +544 -0
- pulumi_azuread/group_without_members.py +1610 -0
- pulumi_azuread/invitation.py +126 -120
- pulumi_azuread/named_location.py +90 -76
- pulumi_azuread/outputs.py +2844 -1308
- pulumi_azuread/privileged_access_group_assignment_schedule.py +695 -0
- pulumi_azuread/privileged_access_group_eligibility_schedule.py +695 -0
- pulumi_azuread/provider.py +292 -246
- pulumi_azuread/pulumi-plugin.json +2 -1
- pulumi_azuread/service_principal.py +400 -461
- pulumi_azuread/service_principal_certificate.py +230 -145
- pulumi_azuread/service_principal_claims_mapping_policy_assignment.py +53 -47
- pulumi_azuread/service_principal_delegated_permission_grant.py +146 -140
- pulumi_azuread/service_principal_password.py +156 -141
- pulumi_azuread/service_principal_token_signing_certificate.py +119 -124
- pulumi_azuread/synchronization_job.py +105 -111
- pulumi_azuread/synchronization_job_provision_on_demand.py +396 -0
- pulumi_azuread/synchronization_secret.py +64 -70
- pulumi_azuread/user.py +776 -730
- pulumi_azuread/user_flow_attribute.py +76 -70
- {pulumi_azuread-5.48.0a1706744699.dist-info → pulumi_azuread-6.8.0a1766208344.dist-info}/METADATA +21 -20
- pulumi_azuread-6.8.0a1766208344.dist-info/RECORD +87 -0
- {pulumi_azuread-5.48.0a1706744699.dist-info → pulumi_azuread-6.8.0a1766208344.dist-info}/WHEEL +1 -1
- pulumi_azuread-5.48.0a1706744699.dist-info/RECORD +0 -81
- {pulumi_azuread-5.48.0a1706744699.dist-info → pulumi_azuread-6.8.0a1766208344.dist-info}/top_level.txt +0 -0
pulumi_azuread/get_user.py
CHANGED
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
# coding=utf-8
|
|
2
|
-
# *** WARNING: this file was generated by
|
|
2
|
+
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
-
import
|
|
5
|
+
import builtins as _builtins
|
|
6
6
|
import warnings
|
|
7
|
+
import sys
|
|
7
8
|
import pulumi
|
|
8
9
|
import pulumi.runtime
|
|
9
10
|
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
11
|
+
if sys.version_info >= (3, 11):
|
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
|
13
|
+
else:
|
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
10
15
|
from . import _utilities
|
|
11
16
|
|
|
12
17
|
__all__ = [
|
|
@@ -21,7 +26,7 @@ class GetUserResult:
|
|
|
21
26
|
"""
|
|
22
27
|
A collection of values returned by getUser.
|
|
23
28
|
"""
|
|
24
|
-
def __init__(__self__, account_enabled=None, age_group=None, business_phones=None, city=None, company_name=None, consent_provided_for_minor=None, cost_center=None, country=None, creation_type=None, department=None, display_name=None, division=None, employee_id=None, employee_type=None, external_user_state=None, fax_number=None, given_name=None, id=None, im_addresses=None, job_title=None, mail=None, mail_nickname=None, manager_id=None, mobile_phone=None, object_id=None, office_location=None, onpremises_distinguished_name=None, onpremises_domain_name=None, onpremises_immutable_id=None, onpremises_sam_account_name=None, onpremises_security_identifier=None, onpremises_sync_enabled=None, onpremises_user_principal_name=None, other_mails=None, postal_code=None, preferred_language=None, proxy_addresses=None, show_in_address_list=None, state=None, street_address=None, surname=None, usage_location=None, user_principal_name=None, user_type=None):
|
|
29
|
+
def __init__(__self__, account_enabled=None, age_group=None, business_phones=None, city=None, company_name=None, consent_provided_for_minor=None, cost_center=None, country=None, creation_type=None, department=None, display_name=None, division=None, employee_hire_date=None, employee_id=None, employee_type=None, external_user_state=None, fax_number=None, given_name=None, id=None, im_addresses=None, job_title=None, mail=None, mail_nickname=None, manager_id=None, mobile_phone=None, object_id=None, office_location=None, onpremises_distinguished_name=None, onpremises_domain_name=None, onpremises_immutable_id=None, onpremises_sam_account_name=None, onpremises_security_identifier=None, onpremises_sync_enabled=None, onpremises_user_principal_name=None, other_mails=None, postal_code=None, preferred_language=None, proxy_addresses=None, show_in_address_list=None, state=None, street_address=None, surname=None, usage_location=None, user_principal_name=None, user_type=None):
|
|
25
30
|
if account_enabled and not isinstance(account_enabled, bool):
|
|
26
31
|
raise TypeError("Expected argument 'account_enabled' to be a bool")
|
|
27
32
|
pulumi.set(__self__, "account_enabled", account_enabled)
|
|
@@ -58,6 +63,9 @@ class GetUserResult:
|
|
|
58
63
|
if division and not isinstance(division, str):
|
|
59
64
|
raise TypeError("Expected argument 'division' to be a str")
|
|
60
65
|
pulumi.set(__self__, "division", division)
|
|
66
|
+
if employee_hire_date and not isinstance(employee_hire_date, str):
|
|
67
|
+
raise TypeError("Expected argument 'employee_hire_date' to be a str")
|
|
68
|
+
pulumi.set(__self__, "employee_hire_date", employee_hire_date)
|
|
61
69
|
if employee_id and not isinstance(employee_id, str):
|
|
62
70
|
raise TypeError("Expected argument 'employee_id' to be a str")
|
|
63
71
|
pulumi.set(__self__, "employee_id", employee_id)
|
|
@@ -155,353 +163,361 @@ class GetUserResult:
|
|
|
155
163
|
raise TypeError("Expected argument 'user_type' to be a str")
|
|
156
164
|
pulumi.set(__self__, "user_type", user_type)
|
|
157
165
|
|
|
158
|
-
@property
|
|
166
|
+
@_builtins.property
|
|
159
167
|
@pulumi.getter(name="accountEnabled")
|
|
160
|
-
def account_enabled(self) -> bool:
|
|
168
|
+
def account_enabled(self) -> _builtins.bool:
|
|
161
169
|
"""
|
|
162
170
|
Whether or not the account is enabled.
|
|
163
171
|
"""
|
|
164
172
|
return pulumi.get(self, "account_enabled")
|
|
165
173
|
|
|
166
|
-
@property
|
|
174
|
+
@_builtins.property
|
|
167
175
|
@pulumi.getter(name="ageGroup")
|
|
168
|
-
def age_group(self) -> str:
|
|
176
|
+
def age_group(self) -> _builtins.str:
|
|
169
177
|
"""
|
|
170
178
|
The age group of the user. Supported values are `Adult`, `NotAdult` and `Minor`.
|
|
171
179
|
"""
|
|
172
180
|
return pulumi.get(self, "age_group")
|
|
173
181
|
|
|
174
|
-
@property
|
|
182
|
+
@_builtins.property
|
|
175
183
|
@pulumi.getter(name="businessPhones")
|
|
176
|
-
def business_phones(self) -> Sequence[str]:
|
|
184
|
+
def business_phones(self) -> Sequence[_builtins.str]:
|
|
177
185
|
"""
|
|
178
186
|
A list of telephone numbers for the user.
|
|
179
187
|
"""
|
|
180
188
|
return pulumi.get(self, "business_phones")
|
|
181
189
|
|
|
182
|
-
@property
|
|
190
|
+
@_builtins.property
|
|
183
191
|
@pulumi.getter
|
|
184
|
-
def city(self) -> str:
|
|
192
|
+
def city(self) -> _builtins.str:
|
|
185
193
|
"""
|
|
186
194
|
The city in which the user is located.
|
|
187
195
|
"""
|
|
188
196
|
return pulumi.get(self, "city")
|
|
189
197
|
|
|
190
|
-
@property
|
|
198
|
+
@_builtins.property
|
|
191
199
|
@pulumi.getter(name="companyName")
|
|
192
|
-
def company_name(self) -> str:
|
|
200
|
+
def company_name(self) -> _builtins.str:
|
|
193
201
|
"""
|
|
194
202
|
The company name which the user is associated. This property can be useful for describing the company that an external user comes from.
|
|
195
203
|
"""
|
|
196
204
|
return pulumi.get(self, "company_name")
|
|
197
205
|
|
|
198
|
-
@property
|
|
206
|
+
@_builtins.property
|
|
199
207
|
@pulumi.getter(name="consentProvidedForMinor")
|
|
200
|
-
def consent_provided_for_minor(self) -> str:
|
|
208
|
+
def consent_provided_for_minor(self) -> _builtins.str:
|
|
201
209
|
"""
|
|
202
210
|
Whether consent has been obtained for minors. Supported values are `Granted`, `Denied` and `NotRequired`.
|
|
203
211
|
"""
|
|
204
212
|
return pulumi.get(self, "consent_provided_for_minor")
|
|
205
213
|
|
|
206
|
-
@property
|
|
214
|
+
@_builtins.property
|
|
207
215
|
@pulumi.getter(name="costCenter")
|
|
208
|
-
def cost_center(self) -> str:
|
|
216
|
+
def cost_center(self) -> _builtins.str:
|
|
209
217
|
"""
|
|
210
218
|
The cost center associated with the user.
|
|
211
219
|
"""
|
|
212
220
|
return pulumi.get(self, "cost_center")
|
|
213
221
|
|
|
214
|
-
@property
|
|
222
|
+
@_builtins.property
|
|
215
223
|
@pulumi.getter
|
|
216
|
-
def country(self) -> str:
|
|
224
|
+
def country(self) -> _builtins.str:
|
|
217
225
|
"""
|
|
218
226
|
The country/region in which the user is located, e.g. `US` or `UK`.
|
|
219
227
|
"""
|
|
220
228
|
return pulumi.get(self, "country")
|
|
221
229
|
|
|
222
|
-
@property
|
|
230
|
+
@_builtins.property
|
|
223
231
|
@pulumi.getter(name="creationType")
|
|
224
|
-
def creation_type(self) -> str:
|
|
232
|
+
def creation_type(self) -> _builtins.str:
|
|
225
233
|
"""
|
|
226
234
|
Indicates whether the user account was created as a regular school or work account (`null`), an external account (`Invitation`), a local account for an Azure Active Directory B2C tenant (`LocalAccount`) or self-service sign-up using email verification (`EmailVerified`).
|
|
227
235
|
"""
|
|
228
236
|
return pulumi.get(self, "creation_type")
|
|
229
237
|
|
|
230
|
-
@property
|
|
238
|
+
@_builtins.property
|
|
231
239
|
@pulumi.getter
|
|
232
|
-
def department(self) -> str:
|
|
240
|
+
def department(self) -> _builtins.str:
|
|
233
241
|
"""
|
|
234
242
|
The name for the department in which the user works.
|
|
235
243
|
"""
|
|
236
244
|
return pulumi.get(self, "department")
|
|
237
245
|
|
|
238
|
-
@property
|
|
246
|
+
@_builtins.property
|
|
239
247
|
@pulumi.getter(name="displayName")
|
|
240
|
-
def display_name(self) -> str:
|
|
248
|
+
def display_name(self) -> _builtins.str:
|
|
241
249
|
"""
|
|
242
250
|
The display name of the user.
|
|
243
251
|
"""
|
|
244
252
|
return pulumi.get(self, "display_name")
|
|
245
253
|
|
|
246
|
-
@property
|
|
254
|
+
@_builtins.property
|
|
247
255
|
@pulumi.getter
|
|
248
|
-
def division(self) -> str:
|
|
256
|
+
def division(self) -> _builtins.str:
|
|
249
257
|
"""
|
|
250
258
|
The name of the division in which the user works.
|
|
251
259
|
"""
|
|
252
260
|
return pulumi.get(self, "division")
|
|
253
261
|
|
|
254
|
-
@property
|
|
262
|
+
@_builtins.property
|
|
263
|
+
@pulumi.getter(name="employeeHireDate")
|
|
264
|
+
def employee_hire_date(self) -> _builtins.str:
|
|
265
|
+
"""
|
|
266
|
+
The hire date of the user, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`).
|
|
267
|
+
"""
|
|
268
|
+
return pulumi.get(self, "employee_hire_date")
|
|
269
|
+
|
|
270
|
+
@_builtins.property
|
|
255
271
|
@pulumi.getter(name="employeeId")
|
|
256
|
-
def employee_id(self) -> str:
|
|
272
|
+
def employee_id(self) -> _builtins.str:
|
|
257
273
|
"""
|
|
258
274
|
The employee identifier assigned to the user by the organisation.
|
|
259
275
|
"""
|
|
260
276
|
return pulumi.get(self, "employee_id")
|
|
261
277
|
|
|
262
|
-
@property
|
|
278
|
+
@_builtins.property
|
|
263
279
|
@pulumi.getter(name="employeeType")
|
|
264
|
-
def employee_type(self) -> str:
|
|
280
|
+
def employee_type(self) -> _builtins.str:
|
|
265
281
|
"""
|
|
266
282
|
Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor.
|
|
267
283
|
"""
|
|
268
284
|
return pulumi.get(self, "employee_type")
|
|
269
285
|
|
|
270
|
-
@property
|
|
286
|
+
@_builtins.property
|
|
271
287
|
@pulumi.getter(name="externalUserState")
|
|
272
|
-
def external_user_state(self) -> str:
|
|
288
|
+
def external_user_state(self) -> _builtins.str:
|
|
273
289
|
"""
|
|
274
290
|
For an external user invited to the tenant, this property represents the invited user's invitation status. Possible values are `PendingAcceptance` or `Accepted`.
|
|
275
291
|
"""
|
|
276
292
|
return pulumi.get(self, "external_user_state")
|
|
277
293
|
|
|
278
|
-
@property
|
|
294
|
+
@_builtins.property
|
|
279
295
|
@pulumi.getter(name="faxNumber")
|
|
280
|
-
def fax_number(self) -> str:
|
|
296
|
+
def fax_number(self) -> _builtins.str:
|
|
281
297
|
"""
|
|
282
298
|
The fax number of the user.
|
|
283
299
|
"""
|
|
284
300
|
return pulumi.get(self, "fax_number")
|
|
285
301
|
|
|
286
|
-
@property
|
|
302
|
+
@_builtins.property
|
|
287
303
|
@pulumi.getter(name="givenName")
|
|
288
|
-
def given_name(self) -> str:
|
|
304
|
+
def given_name(self) -> _builtins.str:
|
|
289
305
|
"""
|
|
290
306
|
The given name (first name) of the user.
|
|
291
307
|
"""
|
|
292
308
|
return pulumi.get(self, "given_name")
|
|
293
309
|
|
|
294
|
-
@property
|
|
310
|
+
@_builtins.property
|
|
295
311
|
@pulumi.getter
|
|
296
|
-
def id(self) -> str:
|
|
312
|
+
def id(self) -> _builtins.str:
|
|
297
313
|
"""
|
|
298
314
|
The provider-assigned unique ID for this managed resource.
|
|
299
315
|
"""
|
|
300
316
|
return pulumi.get(self, "id")
|
|
301
317
|
|
|
302
|
-
@property
|
|
318
|
+
@_builtins.property
|
|
303
319
|
@pulumi.getter(name="imAddresses")
|
|
304
|
-
def im_addresses(self) -> Sequence[str]:
|
|
320
|
+
def im_addresses(self) -> Sequence[_builtins.str]:
|
|
305
321
|
"""
|
|
306
322
|
A list of instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user.
|
|
307
323
|
"""
|
|
308
324
|
return pulumi.get(self, "im_addresses")
|
|
309
325
|
|
|
310
|
-
@property
|
|
326
|
+
@_builtins.property
|
|
311
327
|
@pulumi.getter(name="jobTitle")
|
|
312
|
-
def job_title(self) -> str:
|
|
328
|
+
def job_title(self) -> _builtins.str:
|
|
313
329
|
"""
|
|
314
330
|
The user’s job title.
|
|
315
331
|
"""
|
|
316
332
|
return pulumi.get(self, "job_title")
|
|
317
333
|
|
|
318
|
-
@property
|
|
334
|
+
@_builtins.property
|
|
319
335
|
@pulumi.getter
|
|
320
|
-
def mail(self) -> str:
|
|
336
|
+
def mail(self) -> _builtins.str:
|
|
321
337
|
"""
|
|
322
338
|
The SMTP address for the user.
|
|
323
339
|
"""
|
|
324
340
|
return pulumi.get(self, "mail")
|
|
325
341
|
|
|
326
|
-
@property
|
|
342
|
+
@_builtins.property
|
|
327
343
|
@pulumi.getter(name="mailNickname")
|
|
328
|
-
def mail_nickname(self) -> str:
|
|
344
|
+
def mail_nickname(self) -> _builtins.str:
|
|
329
345
|
"""
|
|
330
346
|
The email alias of the user.
|
|
331
347
|
"""
|
|
332
348
|
return pulumi.get(self, "mail_nickname")
|
|
333
349
|
|
|
334
|
-
@property
|
|
350
|
+
@_builtins.property
|
|
335
351
|
@pulumi.getter(name="managerId")
|
|
336
|
-
def manager_id(self) -> str:
|
|
352
|
+
def manager_id(self) -> _builtins.str:
|
|
337
353
|
"""
|
|
338
354
|
The object ID of the user's manager.
|
|
339
355
|
"""
|
|
340
356
|
return pulumi.get(self, "manager_id")
|
|
341
357
|
|
|
342
|
-
@property
|
|
358
|
+
@_builtins.property
|
|
343
359
|
@pulumi.getter(name="mobilePhone")
|
|
344
|
-
def mobile_phone(self) -> str:
|
|
360
|
+
def mobile_phone(self) -> _builtins.str:
|
|
345
361
|
"""
|
|
346
362
|
The primary cellular telephone number for the user.
|
|
347
363
|
"""
|
|
348
364
|
return pulumi.get(self, "mobile_phone")
|
|
349
365
|
|
|
350
|
-
@property
|
|
366
|
+
@_builtins.property
|
|
351
367
|
@pulumi.getter(name="objectId")
|
|
352
|
-
def object_id(self) -> str:
|
|
368
|
+
def object_id(self) -> _builtins.str:
|
|
353
369
|
"""
|
|
354
370
|
The object ID of the user.
|
|
355
371
|
"""
|
|
356
372
|
return pulumi.get(self, "object_id")
|
|
357
373
|
|
|
358
|
-
@property
|
|
374
|
+
@_builtins.property
|
|
359
375
|
@pulumi.getter(name="officeLocation")
|
|
360
|
-
def office_location(self) -> str:
|
|
376
|
+
def office_location(self) -> _builtins.str:
|
|
361
377
|
"""
|
|
362
378
|
The office location in the user's place of business.
|
|
363
379
|
"""
|
|
364
380
|
return pulumi.get(self, "office_location")
|
|
365
381
|
|
|
366
|
-
@property
|
|
382
|
+
@_builtins.property
|
|
367
383
|
@pulumi.getter(name="onpremisesDistinguishedName")
|
|
368
|
-
def onpremises_distinguished_name(self) -> str:
|
|
384
|
+
def onpremises_distinguished_name(self) -> _builtins.str:
|
|
369
385
|
"""
|
|
370
386
|
The on-premises distinguished name (DN) of the user, synchronised from the on-premises directory when Azure AD Connect is used.
|
|
371
387
|
"""
|
|
372
388
|
return pulumi.get(self, "onpremises_distinguished_name")
|
|
373
389
|
|
|
374
|
-
@property
|
|
390
|
+
@_builtins.property
|
|
375
391
|
@pulumi.getter(name="onpremisesDomainName")
|
|
376
|
-
def onpremises_domain_name(self) -> str:
|
|
392
|
+
def onpremises_domain_name(self) -> _builtins.str:
|
|
377
393
|
"""
|
|
378
394
|
The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
|
|
379
395
|
"""
|
|
380
396
|
return pulumi.get(self, "onpremises_domain_name")
|
|
381
397
|
|
|
382
|
-
@property
|
|
398
|
+
@_builtins.property
|
|
383
399
|
@pulumi.getter(name="onpremisesImmutableId")
|
|
384
|
-
def onpremises_immutable_id(self) -> str:
|
|
400
|
+
def onpremises_immutable_id(self) -> _builtins.str:
|
|
385
401
|
"""
|
|
386
402
|
The value used to associate an on-premise Active Directory user account with their Azure AD user object.
|
|
387
403
|
"""
|
|
388
404
|
return pulumi.get(self, "onpremises_immutable_id")
|
|
389
405
|
|
|
390
|
-
@property
|
|
406
|
+
@_builtins.property
|
|
391
407
|
@pulumi.getter(name="onpremisesSamAccountName")
|
|
392
|
-
def onpremises_sam_account_name(self) -> str:
|
|
408
|
+
def onpremises_sam_account_name(self) -> _builtins.str:
|
|
393
409
|
"""
|
|
394
410
|
The on-premise SAM account name of the user.
|
|
395
411
|
"""
|
|
396
412
|
return pulumi.get(self, "onpremises_sam_account_name")
|
|
397
413
|
|
|
398
|
-
@property
|
|
414
|
+
@_builtins.property
|
|
399
415
|
@pulumi.getter(name="onpremisesSecurityIdentifier")
|
|
400
|
-
def onpremises_security_identifier(self) -> str:
|
|
416
|
+
def onpremises_security_identifier(self) -> _builtins.str:
|
|
401
417
|
"""
|
|
402
418
|
The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
|
|
403
419
|
"""
|
|
404
420
|
return pulumi.get(self, "onpremises_security_identifier")
|
|
405
421
|
|
|
406
|
-
@property
|
|
422
|
+
@_builtins.property
|
|
407
423
|
@pulumi.getter(name="onpremisesSyncEnabled")
|
|
408
|
-
def onpremises_sync_enabled(self) -> bool:
|
|
424
|
+
def onpremises_sync_enabled(self) -> _builtins.bool:
|
|
409
425
|
"""
|
|
410
426
|
Whether this user is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).
|
|
411
427
|
"""
|
|
412
428
|
return pulumi.get(self, "onpremises_sync_enabled")
|
|
413
429
|
|
|
414
|
-
@property
|
|
430
|
+
@_builtins.property
|
|
415
431
|
@pulumi.getter(name="onpremisesUserPrincipalName")
|
|
416
|
-
def onpremises_user_principal_name(self) -> str:
|
|
432
|
+
def onpremises_user_principal_name(self) -> _builtins.str:
|
|
417
433
|
"""
|
|
418
434
|
The on-premise user principal name of the user.
|
|
419
435
|
"""
|
|
420
436
|
return pulumi.get(self, "onpremises_user_principal_name")
|
|
421
437
|
|
|
422
|
-
@property
|
|
438
|
+
@_builtins.property
|
|
423
439
|
@pulumi.getter(name="otherMails")
|
|
424
|
-
def other_mails(self) -> Sequence[str]:
|
|
440
|
+
def other_mails(self) -> Sequence[_builtins.str]:
|
|
425
441
|
"""
|
|
426
442
|
A list of additional email addresses for the user.
|
|
427
443
|
"""
|
|
428
444
|
return pulumi.get(self, "other_mails")
|
|
429
445
|
|
|
430
|
-
@property
|
|
446
|
+
@_builtins.property
|
|
431
447
|
@pulumi.getter(name="postalCode")
|
|
432
|
-
def postal_code(self) -> str:
|
|
448
|
+
def postal_code(self) -> _builtins.str:
|
|
433
449
|
"""
|
|
434
450
|
The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.
|
|
435
451
|
"""
|
|
436
452
|
return pulumi.get(self, "postal_code")
|
|
437
453
|
|
|
438
|
-
@property
|
|
454
|
+
@_builtins.property
|
|
439
455
|
@pulumi.getter(name="preferredLanguage")
|
|
440
|
-
def preferred_language(self) -> str:
|
|
456
|
+
def preferred_language(self) -> _builtins.str:
|
|
441
457
|
"""
|
|
442
458
|
The user's preferred language, in ISO 639-1 notation.
|
|
443
459
|
"""
|
|
444
460
|
return pulumi.get(self, "preferred_language")
|
|
445
461
|
|
|
446
|
-
@property
|
|
462
|
+
@_builtins.property
|
|
447
463
|
@pulumi.getter(name="proxyAddresses")
|
|
448
|
-
def proxy_addresses(self) -> Sequence[str]:
|
|
464
|
+
def proxy_addresses(self) -> Sequence[_builtins.str]:
|
|
449
465
|
"""
|
|
450
466
|
List of email addresses for the user that direct to the same mailbox.
|
|
451
467
|
"""
|
|
452
468
|
return pulumi.get(self, "proxy_addresses")
|
|
453
469
|
|
|
454
|
-
@property
|
|
470
|
+
@_builtins.property
|
|
455
471
|
@pulumi.getter(name="showInAddressList")
|
|
456
|
-
def show_in_address_list(self) -> bool:
|
|
472
|
+
def show_in_address_list(self) -> _builtins.bool:
|
|
457
473
|
"""
|
|
458
474
|
Whether or not the Outlook global address list should include this user.
|
|
459
475
|
"""
|
|
460
476
|
return pulumi.get(self, "show_in_address_list")
|
|
461
477
|
|
|
462
|
-
@property
|
|
478
|
+
@_builtins.property
|
|
463
479
|
@pulumi.getter
|
|
464
|
-
def state(self) -> str:
|
|
480
|
+
def state(self) -> _builtins.str:
|
|
465
481
|
"""
|
|
466
482
|
The state or province in the user's address.
|
|
467
483
|
"""
|
|
468
484
|
return pulumi.get(self, "state")
|
|
469
485
|
|
|
470
|
-
@property
|
|
486
|
+
@_builtins.property
|
|
471
487
|
@pulumi.getter(name="streetAddress")
|
|
472
|
-
def street_address(self) -> str:
|
|
488
|
+
def street_address(self) -> _builtins.str:
|
|
473
489
|
"""
|
|
474
490
|
The street address of the user's place of business.
|
|
475
491
|
"""
|
|
476
492
|
return pulumi.get(self, "street_address")
|
|
477
493
|
|
|
478
|
-
@property
|
|
494
|
+
@_builtins.property
|
|
479
495
|
@pulumi.getter
|
|
480
|
-
def surname(self) -> str:
|
|
496
|
+
def surname(self) -> _builtins.str:
|
|
481
497
|
"""
|
|
482
498
|
The user's surname (family name or last name).
|
|
483
499
|
"""
|
|
484
500
|
return pulumi.get(self, "surname")
|
|
485
501
|
|
|
486
|
-
@property
|
|
502
|
+
@_builtins.property
|
|
487
503
|
@pulumi.getter(name="usageLocation")
|
|
488
|
-
def usage_location(self) -> str:
|
|
504
|
+
def usage_location(self) -> _builtins.str:
|
|
489
505
|
"""
|
|
490
506
|
The usage location of the user.
|
|
491
507
|
"""
|
|
492
508
|
return pulumi.get(self, "usage_location")
|
|
493
509
|
|
|
494
|
-
@property
|
|
510
|
+
@_builtins.property
|
|
495
511
|
@pulumi.getter(name="userPrincipalName")
|
|
496
|
-
def user_principal_name(self) -> str:
|
|
512
|
+
def user_principal_name(self) -> _builtins.str:
|
|
497
513
|
"""
|
|
498
514
|
The user principal name (UPN) of the user.
|
|
499
515
|
"""
|
|
500
516
|
return pulumi.get(self, "user_principal_name")
|
|
501
517
|
|
|
502
|
-
@property
|
|
518
|
+
@_builtins.property
|
|
503
519
|
@pulumi.getter(name="userType")
|
|
504
|
-
def user_type(self) -> str:
|
|
520
|
+
def user_type(self) -> _builtins.str:
|
|
505
521
|
"""
|
|
506
522
|
The user type in the directory. Possible values are `Guest` or `Member`.
|
|
507
523
|
"""
|
|
@@ -526,6 +542,7 @@ class AwaitableGetUserResult(GetUserResult):
|
|
|
526
542
|
department=self.department,
|
|
527
543
|
display_name=self.display_name,
|
|
528
544
|
division=self.division,
|
|
545
|
+
employee_hire_date=self.employee_hire_date,
|
|
529
546
|
employee_id=self.employee_id,
|
|
530
547
|
employee_type=self.employee_type,
|
|
531
548
|
external_user_state=self.external_user_state,
|
|
@@ -560,11 +577,11 @@ class AwaitableGetUserResult(GetUserResult):
|
|
|
560
577
|
user_type=self.user_type)
|
|
561
578
|
|
|
562
579
|
|
|
563
|
-
def get_user(employee_id: Optional[str] = None,
|
|
564
|
-
mail: Optional[str] = None,
|
|
565
|
-
mail_nickname: Optional[str] = None,
|
|
566
|
-
object_id: Optional[str] = None,
|
|
567
|
-
user_principal_name: Optional[str] = None,
|
|
580
|
+
def get_user(employee_id: Optional[_builtins.str] = None,
|
|
581
|
+
mail: Optional[_builtins.str] = None,
|
|
582
|
+
mail_nickname: Optional[_builtins.str] = None,
|
|
583
|
+
object_id: Optional[_builtins.str] = None,
|
|
584
|
+
user_principal_name: Optional[_builtins.str] = None,
|
|
568
585
|
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetUserResult:
|
|
569
586
|
"""
|
|
570
587
|
Gets information about an Azure Active Directory user.
|
|
@@ -583,15 +600,15 @@ def get_user(employee_id: Optional[str] = None,
|
|
|
583
600
|
import pulumi
|
|
584
601
|
import pulumi_azuread as azuread
|
|
585
602
|
|
|
586
|
-
example = azuread.get_user(user_principal_name="user@
|
|
603
|
+
example = azuread.get_user(user_principal_name="user@example.com")
|
|
587
604
|
```
|
|
588
605
|
|
|
589
606
|
|
|
590
|
-
:param str employee_id: The employee identifier assigned to the user by the organisation.
|
|
591
|
-
:param str mail: The SMTP address for the user.
|
|
592
|
-
:param str mail_nickname: The email alias of the user.
|
|
593
|
-
:param str object_id: The object ID of the user.
|
|
594
|
-
:param str user_principal_name: The user principal name (UPN) of the user.
|
|
607
|
+
:param _builtins.str employee_id: The employee identifier assigned to the user by the organisation.
|
|
608
|
+
:param _builtins.str mail: The SMTP address for the user.
|
|
609
|
+
:param _builtins.str mail_nickname: The email alias of the user.
|
|
610
|
+
:param _builtins.str object_id: The object ID of the user.
|
|
611
|
+
:param _builtins.str user_principal_name: The user principal name (UPN) of the user.
|
|
595
612
|
|
|
596
613
|
> One of `user_principal_name`, `object_id`, `mail`, `mail_nickname` or `employee_id` must be specified.
|
|
597
614
|
"""
|
|
@@ -617,6 +634,7 @@ def get_user(employee_id: Optional[str] = None,
|
|
|
617
634
|
department=pulumi.get(__ret__, 'department'),
|
|
618
635
|
display_name=pulumi.get(__ret__, 'display_name'),
|
|
619
636
|
division=pulumi.get(__ret__, 'division'),
|
|
637
|
+
employee_hire_date=pulumi.get(__ret__, 'employee_hire_date'),
|
|
620
638
|
employee_id=pulumi.get(__ret__, 'employee_id'),
|
|
621
639
|
employee_type=pulumi.get(__ret__, 'employee_type'),
|
|
622
640
|
external_user_state=pulumi.get(__ret__, 'external_user_state'),
|
|
@@ -649,15 +667,12 @@ def get_user(employee_id: Optional[str] = None,
|
|
|
649
667
|
usage_location=pulumi.get(__ret__, 'usage_location'),
|
|
650
668
|
user_principal_name=pulumi.get(__ret__, 'user_principal_name'),
|
|
651
669
|
user_type=pulumi.get(__ret__, 'user_type'))
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
object_id: Optional[pulumi.Input[Optional[str]]] = None,
|
|
659
|
-
user_principal_name: Optional[pulumi.Input[Optional[str]]] = None,
|
|
660
|
-
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetUserResult]:
|
|
670
|
+
def get_user_output(employee_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
|
|
671
|
+
mail: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
|
|
672
|
+
mail_nickname: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
|
|
673
|
+
object_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
|
|
674
|
+
user_principal_name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
|
|
675
|
+
opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetUserResult]:
|
|
661
676
|
"""
|
|
662
677
|
Gets information about an Azure Active Directory user.
|
|
663
678
|
|
|
@@ -675,16 +690,69 @@ def get_user_output(employee_id: Optional[pulumi.Input[Optional[str]]] = None,
|
|
|
675
690
|
import pulumi
|
|
676
691
|
import pulumi_azuread as azuread
|
|
677
692
|
|
|
678
|
-
example = azuread.get_user(user_principal_name="user@
|
|
693
|
+
example = azuread.get_user(user_principal_name="user@example.com")
|
|
679
694
|
```
|
|
680
695
|
|
|
681
696
|
|
|
682
|
-
:param str employee_id: The employee identifier assigned to the user by the organisation.
|
|
683
|
-
:param str mail: The SMTP address for the user.
|
|
684
|
-
:param str mail_nickname: The email alias of the user.
|
|
685
|
-
:param str object_id: The object ID of the user.
|
|
686
|
-
:param str user_principal_name: The user principal name (UPN) of the user.
|
|
697
|
+
:param _builtins.str employee_id: The employee identifier assigned to the user by the organisation.
|
|
698
|
+
:param _builtins.str mail: The SMTP address for the user.
|
|
699
|
+
:param _builtins.str mail_nickname: The email alias of the user.
|
|
700
|
+
:param _builtins.str object_id: The object ID of the user.
|
|
701
|
+
:param _builtins.str user_principal_name: The user principal name (UPN) of the user.
|
|
687
702
|
|
|
688
703
|
> One of `user_principal_name`, `object_id`, `mail`, `mail_nickname` or `employee_id` must be specified.
|
|
689
704
|
"""
|
|
690
|
-
|
|
705
|
+
__args__ = dict()
|
|
706
|
+
__args__['employeeId'] = employee_id
|
|
707
|
+
__args__['mail'] = mail
|
|
708
|
+
__args__['mailNickname'] = mail_nickname
|
|
709
|
+
__args__['objectId'] = object_id
|
|
710
|
+
__args__['userPrincipalName'] = user_principal_name
|
|
711
|
+
opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
|
|
712
|
+
__ret__ = pulumi.runtime.invoke_output('azuread:index/getUser:getUser', __args__, opts=opts, typ=GetUserResult)
|
|
713
|
+
return __ret__.apply(lambda __response__: GetUserResult(
|
|
714
|
+
account_enabled=pulumi.get(__response__, 'account_enabled'),
|
|
715
|
+
age_group=pulumi.get(__response__, 'age_group'),
|
|
716
|
+
business_phones=pulumi.get(__response__, 'business_phones'),
|
|
717
|
+
city=pulumi.get(__response__, 'city'),
|
|
718
|
+
company_name=pulumi.get(__response__, 'company_name'),
|
|
719
|
+
consent_provided_for_minor=pulumi.get(__response__, 'consent_provided_for_minor'),
|
|
720
|
+
cost_center=pulumi.get(__response__, 'cost_center'),
|
|
721
|
+
country=pulumi.get(__response__, 'country'),
|
|
722
|
+
creation_type=pulumi.get(__response__, 'creation_type'),
|
|
723
|
+
department=pulumi.get(__response__, 'department'),
|
|
724
|
+
display_name=pulumi.get(__response__, 'display_name'),
|
|
725
|
+
division=pulumi.get(__response__, 'division'),
|
|
726
|
+
employee_hire_date=pulumi.get(__response__, 'employee_hire_date'),
|
|
727
|
+
employee_id=pulumi.get(__response__, 'employee_id'),
|
|
728
|
+
employee_type=pulumi.get(__response__, 'employee_type'),
|
|
729
|
+
external_user_state=pulumi.get(__response__, 'external_user_state'),
|
|
730
|
+
fax_number=pulumi.get(__response__, 'fax_number'),
|
|
731
|
+
given_name=pulumi.get(__response__, 'given_name'),
|
|
732
|
+
id=pulumi.get(__response__, 'id'),
|
|
733
|
+
im_addresses=pulumi.get(__response__, 'im_addresses'),
|
|
734
|
+
job_title=pulumi.get(__response__, 'job_title'),
|
|
735
|
+
mail=pulumi.get(__response__, 'mail'),
|
|
736
|
+
mail_nickname=pulumi.get(__response__, 'mail_nickname'),
|
|
737
|
+
manager_id=pulumi.get(__response__, 'manager_id'),
|
|
738
|
+
mobile_phone=pulumi.get(__response__, 'mobile_phone'),
|
|
739
|
+
object_id=pulumi.get(__response__, 'object_id'),
|
|
740
|
+
office_location=pulumi.get(__response__, 'office_location'),
|
|
741
|
+
onpremises_distinguished_name=pulumi.get(__response__, 'onpremises_distinguished_name'),
|
|
742
|
+
onpremises_domain_name=pulumi.get(__response__, 'onpremises_domain_name'),
|
|
743
|
+
onpremises_immutable_id=pulumi.get(__response__, 'onpremises_immutable_id'),
|
|
744
|
+
onpremises_sam_account_name=pulumi.get(__response__, 'onpremises_sam_account_name'),
|
|
745
|
+
onpremises_security_identifier=pulumi.get(__response__, 'onpremises_security_identifier'),
|
|
746
|
+
onpremises_sync_enabled=pulumi.get(__response__, 'onpremises_sync_enabled'),
|
|
747
|
+
onpremises_user_principal_name=pulumi.get(__response__, 'onpremises_user_principal_name'),
|
|
748
|
+
other_mails=pulumi.get(__response__, 'other_mails'),
|
|
749
|
+
postal_code=pulumi.get(__response__, 'postal_code'),
|
|
750
|
+
preferred_language=pulumi.get(__response__, 'preferred_language'),
|
|
751
|
+
proxy_addresses=pulumi.get(__response__, 'proxy_addresses'),
|
|
752
|
+
show_in_address_list=pulumi.get(__response__, 'show_in_address_list'),
|
|
753
|
+
state=pulumi.get(__response__, 'state'),
|
|
754
|
+
street_address=pulumi.get(__response__, 'street_address'),
|
|
755
|
+
surname=pulumi.get(__response__, 'surname'),
|
|
756
|
+
usage_location=pulumi.get(__response__, 'usage_location'),
|
|
757
|
+
user_principal_name=pulumi.get(__response__, 'user_principal_name'),
|
|
758
|
+
user_type=pulumi.get(__response__, 'user_type')))
|