-
Notifications
You must be signed in to change notification settings - Fork 206
/
Copy pathSet-MsOGroupProperties.ps1
88 lines (76 loc) · 3.01 KB
/
Set-MsOGroupProperties.ps1
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
#Requires -Version 5.0
#Requires -Modules MSOnline
<#
.SYNOPSIS
Connect to MS Online and updates the properties of a Azure Active Directory group.
Only parameters with value are set
.DESCRIPTION
.NOTES
This PowerShell script was developed and optimized for ScriptRunner. The use of the scripts requires ScriptRunner.
The customer or user is authorized to copy the script from the repository and use them in ScriptRunner.
The terms of use for ScriptRunner do not apply to this script. In particular, ScriptRunner Software GmbH assumes no liability for the function,
the use and the consequences of the use of this freely available script.
PowerShell is a product of Microsoft Corporation. ScriptRunner is a product of ScriptRunner Software GmbH.
© ScriptRunner Software GmbH
.COMPONENT
Azure Active Directory Powershell Module
.LINK
https://github.com/scriptrunner/ActionPacks/tree/master/O365/MSOnline/Groups
.Parameter GroupObjectId
[sr-en] Unique ID of the group to update
.Parameter GroupName
[sr-en] Display name of the group to remove
.Parameter Description
[sr-en] Description of the group
.Parameter DisplayName
[sr-en] New display name of the group
.Parameter TenantId
[sr-en] Unique ID of the tenant on which to perform the operation
#>
param(
[Parameter(Mandatory = $true,ParameterSetName = "Group object id")]
[guid]$GroupObjectId,
[Parameter(Mandatory = $true,ParameterSetName = "Group name")]
[string]$GroupName,
[Parameter(ParameterSetName = "Group name")]
[Parameter(ParameterSetName = "Group object id")]
[string]$Description,
[Parameter(ParameterSetName = "Group name")]
[Parameter(ParameterSetName = "Group object id")]
[string]$DisplayName,
[Parameter(ParameterSetName = "Group name")]
[Parameter(ParameterSetName = "Group object id")]
[guid]$TenantId
)
try{
$Script:Grp
if($PSCmdlet.ParameterSetName -eq "Group object id"){
$Script:Grp = Get-MsolGroup -ObjectId $GroupObjectId -TenantId $TenantId
}
else{
$Script:Grp = Get-MsolGroup -TenantId $TenantId | Where-Object {$_.Displayname -eq $GroupName}
}
if($null -ne $Script:Grp){
if(-not [System.String]::IsNullOrWhiteSpace($Description)){
$null = Set-MsolGroup -ObjectId $Script:Grp.ObjectId -TenantId $TenantId -Description $Description
}
if(-not [System.String]::IsNullOrWhiteSpace($DisplayName)){
$null = Set-MsolGroup -ObjectId $Script:Grp.ObjectId -TenantId $TenantId -DisplayName $DisplayName
}
if($SRXEnv) {
$SRXEnv.ResultMessage = "Group $($Script:Grp.DisplayName) changed"
}
else{
Write-Output "Group $($Script:Grp.DisplayName) changed"
}
}
else{
if($SRXEnv) {
$SRXEnv.ResultMessage = "Group not found"
}
Throw "Group not found"
}
}
catch{
throw
}