-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
Microsoft.PowerPlatform.Administration.UserManagement.psm1
497 lines (371 loc) · 17.1 KB
/
Microsoft.PowerPlatform.Administration.UserManagement.psm1
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
<#
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT license.
# These scripts are only supported in .NET framework compatiable powershell versions (5.1 - default with windows 10 & 11)
#>
# Verify powershell version is supported
if($PSVersionTable.PSVersion.Major -gt 5)
{
Write-Host("Script is supported only in powershell versions 5 and below")
}
#install Azure powershell modules
$moduleAzure = Get-Module -ListAvailable -Name Az*
if ($null -eq $moduleAzure)
{
Install-Module -Name Az -AllowClobber -Force
}
# Pre load and resolve versions for all required assemblies
$OnAssemblyResolve = [System.ResolveEventHandler] {
param($sender, $e)
foreach($a in [System.AppDomain]::CurrentDomain.GetAssemblies())
{
if ($a.FullName -eq $e.Name)
{
return $a
}
}
return $null
}
[System.AppDomain]::CurrentDomain.add_AssemblyResolve($OnAssemblyResolve)
$dlls = (Get-ChildItem -path ".").fullname
# Load references assemblies needed by the helper module
$dlls = Get-ChildItem -path "." -Filter "*.dll"
foreach($dll in $dlls)
{
try
{
$DLLName = $dll.Name
$fullDLLPath = $dll.FullName
[System.Reflection.Assembly]::LoadFrom($fullDLLPath)
Write-Debug "Loaded $DLLName"
}
catch
{
$message = $_.Exception.GetBaseException().LoaderExceptions
Write-Host "Error loading" $dll.name
Write-Host "exception" $message
exit
}
}
$OnAssemblyResolve = [System.ResolveEventHandler] {
param($sender, $e)
foreach($a in [System.AppDomain]::CurrentDomain.GetAssemblies())
{
if ($a.FullName -eq $e.Name)
{
return $a
}
}
return $null
}
[System.AppDomain]::CurrentDomain.add_AssemblyResolve($OnAssemblyResolve)
$helpersDll = 'Microsoft.PowerPlatform.Administration.Helpers.dll'
$dllPath = Join-Path $PSScriptRoot $helpersDll
Add-Type -Path $dllPath
<#
.SYNOPSIS
Removes specified role from users
.DESCRIPTION
Removes specified role from users in an environment / all environments in geo / all environments in the tenant.
.PARAMETER usersFilePath
Path to file containing list of user princiapl names (one per line)
.PARAMETER roleName
Localized role name in dataverse (Ex: System Administrator)
.PARAMETER environmentUrl
Url of Environment, if admin wants to get reports from only one environment
.PARAMETER processAllEnvironments
Removes roles from all environments the admin user has access to
.PARAMETER geo
Removes roles from environments in given geo. Valid Geo codes - [NA, EMEA, APAC, SAM, OCE, JPN, IND, CAN, GBR, FRA, UAE,ZAF, GER, CHE, KOR, NOR, SGP]
.PARAMETER outputLogsDirectory
Location folder for the logs & reports to be written to.
#>
function Remove-RoleAssignmentFromUsers
{
[CmdletBinding()]
Param(
[Parameter(Mandatory=$true,
HelpMessage = "Role name in Dataverse. Ex : 'System Administrator', 'System Customizer' etc.,")]
[ValidateNotNullOrEmpty()]
[String]$roleName,
[Parameter(Mandatory=$false,
HelpMessage = "Geo name if you want to clean up role assignments only in specific geo.Processes all geos by default. Valid Geo codes - [NA, EMEA, APAC, SAM, OCE, JPN, IND, CAN, GBR, FRA, UAE,ZAF, GER, CHE, KOR, NOR, SGP]")]
[String]$geo = "",
[Parameter(Mandatory=$false,
HelpMessage = "Url of the environment to clean up role assignments from.")]
[String]$environmentUrl = "",
[Parameter(Mandatory=$false,
HelpMessage = "Clean up role assignments in all environments. Clean up only in specific geo if geo is supplied, otherwise global")]
[boolean]$processAllEnvironments = $false,
[Parameter(Mandatory=$true,
HelpMessage = "File path to the list of users (one user principal name per line) to remove role assignments from")]
[ValidateNotNullOrEmpty()]
[String]$usersFilePath,
[Parameter(Mandatory=$true,
HelpMessage = "Directory to write output logs and reports to")]
[ValidateNotNullOrEmpty()]
[String]$outputLogsDirectory
)
try
{
if($PSBoundParameters.ContainsKey('environmentUrl') -eq $false -and $PSBoundParameters.ContainsKey('processAllEnvironments') -eq $false)
{
Write-Host "One of the following parameters must be provided : environmentUrl, processAllEnvironments";
return;
}
if($PSBoundParameters.ContainsKey('environmentUrl') -eq $true -and $PSBoundParameters.ContainsKey('processAllEnvironments') -eq $true)
{
Write-Host "ONLY one of the following parameters must be provided : environmentUrl, processAllEnvironments";
return;
}
if (Test-Path $outputLogsDirectory) {
Write-Host "Output Directory Exists"
}
else
{
#PowerShell Create directory if not exists
New-Item $outputLogsDirectory -ItemType Directory
Write-Host "Output Directory created successfully"
}
$outputLogsDirectory = Convert-Path -LiteralPath $outputLogsDirectory
$usersFilePath = Convert-Path -LiteralPath $usersFilePath
$tenantOperationsHelper = New-Object -TypeName 'Microsoft.PowerPlatform.Administration.Helpers.TenantOperationsHelper'
$credentials = Get-Credential -Message "Provide user credentials to connect to dataverse"
$userName = $credentials.UserName
$password = $credentials.GetNetworkCredential().Password
#Connect to Azure AD
Connect-AzureAD -Credential $credentials
$tenantOperationsHelper.RemoveRoleAssignmentFromUsers($credentials.UserName, $password, $roleName, $usersFilePath, $environmentUrl, $geo, $processAllEnvironments, $outputLogsDirectory);
}catch
{
$message = $_.Exception.GetBaseException();
Write-Host $message
}
}
<#
.SYNOPSIS
Adds specified role to users
.DESCRIPTION
Adds specified role to users in an environment / all environments in geo / all environments in the tenant.
.PARAMETER usersFilePath
Path to file containing list of user princiapl names (one per line)
.PARAMETER roleName
Localized role name in dataverse (Ex: System Administrator)
.PARAMETER environmentUrl
Url of Environment, if admin wants to get reports from only one environment
.PARAMETER processAllEnvironments
Generate reports for all environments the admin user has access to
.PARAMETER geo
Adds roles to users for environments in given geo. Valid Geo codes - [NA, EMEA, APAC, SAM, OCE, JPN, IND, CAN, GBR, FRA, UAE,ZAF, GER, CHE, KOR, NOR, SGP]
.PARAMETER outputLogsDirectory
Location folder for the logs & reports to be written to.
#>
function Add-RoleToUsers
{
[CmdletBinding()]
Param(
[Parameter(Mandatory=$true,
HelpMessage = "Role name in Dataverse. Ex : 'System Administrator', 'System Customizer' etc.,")]
[ValidateNotNullOrEmpty()]
[String]$roleName,
[Parameter(Mandatory=$false,
HelpMessage = "Adds roles to users for environments in given geo. Valid Geo codes - [NA, EMEA, APAC, SAM, OCE, JPN, IND, CAN, GBR, FRA, UAE,ZAF, GER, CHE, KOR, NOR, SGP]")]
[String]$geo = "",
[Parameter(Mandatory=$false,
HelpMessage = "Url of the environment to add role assignments from.")]
[String]$environmentUrl = "",
[Parameter(Mandatory=$false,
HelpMessage = "Add roles to users in all environments. Addonly in specific geo if geo is supplied, otherwise from all geos")]
[boolean]$processAllEnvironments = $false,
[Parameter(Mandatory=$true,
HelpMessage = "File path to the list of users (one user principal name per line) to add role")]
[ValidateNotNullOrEmpty()]
[String]$usersFilePath,
[Parameter(Mandatory=$true,
HelpMessage = "Directory to write output logs and reports to")]
[ValidateNotNullOrEmpty()]
[String]$outputLogsDirectory
)
try
{
if($PSBoundParameters.ContainsKey('environmentUrl') -eq $false -and $PSBoundParameters.ContainsKey('processAllEnvironments') -eq $false)
{
Write-Host "One of the following parameters must be provided : environmentUrl, processAllEnvironments";
return;
}
if($PSBoundParameters.ContainsKey('environmentUrl') -eq $true -and $PSBoundParameters.ContainsKey('processAllEnvironments') -eq $true)
{
Write-Host "ONLY one of the following parameters must be provided : environmentUrl, processAllEnvironments";
return;
}
if (Test-Path $outputLogsDirectory) {
Write-Host "Output Directory Exists"
}
else
{
#PowerShell Create directory if not exists
New-Item $outputLogsDirectory -ItemType Directory
Write-Host "Output Directory created successfully"
}
$outputLogsDirectory = Convert-Path -LiteralPath $outputLogsDirectory
$usersFilePath = Convert-Path -LiteralPath $usersFilePath
$tenantOperationsHelper = New-Object -TypeName 'Microsoft.PowerPlatform.Administration.Helpers.TenantOperationsHelper'
$credentials = Get-Credential -Message "Provide user credentials to connect to dataverse"
$userName = $credentials.UserName
$password = $credentials.GetNetworkCredential().Password
#Connect to Azure AD
Connect-AzureAD -Credential $credentials
$tenantOperationsHelper.AddRoleToUsers($credentials.UserName, $password, $roleName, $usersFilePath, $environmentUrl, $geo, $processAllEnvironments, $outputLogsDirectory);
}catch
{
$message = $_.Exception.GetBaseException();
Write-Host $message
}
}
<#
.SYNOPSIS
Generates user role assignment reports for environments
.DESCRIPTION
Generates a report of users having the supplied role in an environment / all environments in geo / all environments in the tenant.
.PARAMETER roleName
Localized role name in dataverse (Ex: System Administrator)
.PARAMETER environmentUrl
Url of Environment, if admin wants to get reports from only one environment
.PARAMETER processAllEnvironments
Generate reports for all environments the admin user has access to
.PARAMETER geo
Generate reports for environments in given geo. Valid Geo codes - [NA, EMEA, APAC, SAM, OCE, JPN, IND, CAN, GBR, FRA, UAE,ZAF, GER, CHE, KOR, NOR, SGP]
.PARAMETER outputLogsDirectory
Location folder for the logs & reports to be written to.
#>
function Get-UsersWithRoleAssignment
{
[CmdletBinding()]
Param(
[Parameter(Mandatory=$true,
HelpMessage = "Role name in Dataverse. Ex : 'System Administrator', 'System Customizer' etc.,")]
[ValidateNotNullOrEmpty()]
[String]$roleName,
[Parameter(Mandatory=$false,
HelpMessage = "Generate reports for environments in given geo. Valid Geo codes - [NA, EMEA, APAC, SAM, OCE, JPN, IND, CAN, GBR, FRA, UAE,ZAF, GER, CHE, KOR, NOR, SGP]")]
[String]$geo = "",
[Parameter(Mandatory=$false,
HelpMessage = "Url of environment to get role assignments from")]
[String]$environmentUrl = "",
[Parameter(Mandatory=$false,
HelpMessage = "Get reports from all environments. Gets geo specific reports if geo is supplied, processes all geos otherwise")]
[boolean]$processAllEnvironments = $false,
[Parameter(Mandatory=$true,
HelpMessage = "Directory to write logs & reports to")]
[ValidateNotNullOrEmpty()]
[String]$outputLogsDirectory
)
try
{
if($PSBoundParameters.ContainsKey('environmentUrl') -eq $false -and $PSBoundParameters.ContainsKey('processAllEnvironments') -eq $false)
{
Write-Host "One of the following parameters must be provided : environmentUrl, processAllEnvironments";
return;
}
if($PSBoundParameters.ContainsKey('environmentUrl') -eq $true -and $PSBoundParameters.ContainsKey('processAllEnvironments') -eq $true)
{
Write-Host "ONLY one of the following parameters must be provided : environmentUrl, processAllEnvironments";
return;
}
if (Test-Path $outputLogsDirectory) {
Write-Host "Output Directory Exists"
}
else
{
#PowerShell Create directory if not exists
New-Item $outputLogsDirectory -ItemType Directory
Write-Host "Output Directory created successfully"
}
$outputLogsDirectory = Convert-Path -LiteralPath $outputLogsDirectory
$tenantOperationsHelper = New-Object -TypeName 'Microsoft.PowerPlatform.Administration.Helpers.TenantOperationsHelper'
$credentials = Get-Credential -Message "Provide user credentials to connect to dataverse"
$userName = $credentials.UserName
$password = $credentials.GetNetworkCredential().Password
#Connect to Azure AD
Connect-AzureAD -Credential $credentials
$tenantOperationsHelper.GetUsersWithRoleAssignment($credentials.UserName, $password, $roleName, $environmentUrl, $geo, $processAllEnvironments, $outputLogsDirectory);
}catch
{
$message = $_.Exception.GetBaseException();
Write-Host $message
}
}
<#
.SYNOPSIS
Bulk assign user records to users
.DESCRIPTION
Bulk assign user records to users in an environment / all environments in geo / all environments in the tenant.
.PARAMETER usersFilePath
Path to file containing list of user princiapl names (source and target user principals separated by commas)
.PARAMETER environmentUrl
Url of Environment, if admin wants to get reports from only one environment
.PARAMETER processAllEnvironments
Removes roles from all environments the admin user has access to
.PARAMETER geo
Removes roles from environments in given geo. Valid Geo codes - [NA, EMEA, APAC, SAM, OCE, JPN, IND, CAN, GBR, FRA, UAE,ZAF, GER, CHE, KOR, NOR, SGP]
.PARAMETER outputLogsDirectory
Location folder for the logs & reports to be written to.
#>
function Add-BulkRecordsToUsers
{
[CmdletBinding()]
Param(
[Parameter(Mandatory=$false,
HelpMessage = "Geo name if you want to clean up role assignments only in specific geo.Processes all geos by default. Valid Geo codes - [NA, EMEA, APAC, SAM, OCE, JPN, IND, CAN, GBR, FRA, UAE,ZAF, GER, CHE, KOR, NOR, SGP]")]
[String]$geo = "",
[Parameter(Mandatory=$false,
HelpMessage = "Url of the environment to clean up role assignments from.")]
[String]$environmentUrl = "",
[Parameter(Mandatory=$false,
HelpMessage = "Clean up role assignments in all environments. Clean up only in specific geo if geo is supplied, otherwise global")]
[boolean]$processAllEnvironments = $false,
[Parameter(Mandatory=$true,
HelpMessage = "File path to the list of users (source user principal and target user principal separated by comma) to assign records from")]
[ValidateNotNullOrEmpty()]
[String]$usersFilePath,
[Parameter(Mandatory=$true,
HelpMessage = "Directory to write output logs and reports to")]
[ValidateNotNullOrEmpty()]
[String]$outputLogsDirectory
)
try
{
if($PSBoundParameters.ContainsKey('environmentUrl') -eq $false -and $PSBoundParameters.ContainsKey('processAllEnvironments') -eq $false)
{
Write-Host "One of the following parameters must be provided : environmentUrl, processAllEnvironments";
return;
}
if($PSBoundParameters.ContainsKey('environmentUrl') -eq $true -and $PSBoundParameters.ContainsKey('processAllEnvironments') -eq $true)
{
Write-Host "ONLY one of the following parameters must be provided : environmentUrl, processAllEnvironments";
return;
}
if (Test-Path $outputLogsDirectory) {
Write-Host "Output Directory Exists"
}
else
{
#PowerShell Create directory if not exists
New-Item $outputLogsDirectory -ItemType Directory
Write-Host "Output Directory created successfully"
}
$outputLogsDirectory = Convert-Path -LiteralPath $outputLogsDirectory
$usersFilePath = Convert-Path -LiteralPath $usersFilePath
$tenantOperationsHelper = New-Object -TypeName 'Microsoft.PowerPlatform.Administration.Helpers.TenantOperationsHelper'
$credentials = Get-Credential -Message "Provide user credentials to connect to dataverse"
$userName = $credentials.UserName
$password = $credentials.GetNetworkCredential().Password
#Connect to Azure AD
Connect-AzureAD -Credential $credentials
$tenantOperationsHelper.BulkAssignRecordsToUsers($credentials.UserName, $password, $usersFilePath, $environmentUrl, $geo, $processAllEnvironments, $outputLogsDirectory);
}catch
{
$message = $_.Exception.GetBaseException();
Write-Host $message
}
}