Public/Group/Set-UsersToOrgGroups.ps1
|
<# .SYNOPSIS Add mutiple users to an existing group using names and ids strings .DESCRIPTION A utility to support batch assigns users to a group when only ids are available .PARAMETER OrgIds An array of the organization identifiers .PARAMETER UserIds An array of user identiviers to assign to the group .PARAMETER GroupName The group name to assign the users. This group must exist. .EXAMPLE Set-UsersToOrgGroups -OrgIds @(...) -UserIds @(...) -GroupName "My Group" .NOTES Users that are already memebers of the group will be skipped #> function Set-UsersToOrgGroups { [CmdletBinding(SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(Mandatory, Position = 0)] [ValidateNotNullOrEmpty()] [array] $OrgIds, [Parameter(Mandatory, Position = 1)] [ValidateNotNullOrEmpty()] [array] $UserIds, [Parameter(Mandatory, Position = 2)] [ValidateNotNullOrEmpty()] [string] $GroupName, [Parameter()] [switch] $Force ) begin { Write-Verbose "[$($MyInvocation.MyCommand.Name)] Function started" if (-not $PSBoundParameters.ContainsKey('Verbose')) { $VerbosePreference = $PSCmdlet.SessionState.PSVariable.GetValue('VerbosePreference') } if (-not $PSBoundParameters.ContainsKey('Confirm')) { $ConfirmPreference = $PSCmdlet.SessionState.PSVariable.GetValue('ConfirmPreference') } if (-not $PSBoundParameters.ContainsKey('WhatIf')) { $WhatIfPreference = $PSCmdlet.SessionState.PSVariable.GetValue('WhatIfPreference') } } process { Write-Debug "[$($MyInvocation.MyCommand.Name)] PSBoundParameters: $($PSBoundParameters | Out-String)" $ConfirmPreference = 'None' $invalidOrgs = Test-OrgIds -Ids $OrgIds $invalidUsers = Test-UserIds -Ids $UserIds # Just write warnings. do not use result Test-GroupInOrgs -OrgIds $OrgIds -GroupName $GroupName if ($invalidOrgs.Count -gt 0 -or $invalidUsers.Count -gt 0) { throw "Unable to continue -- Check warnings" } if ($Force -or $PSCmdlet.ShouldProcess("ShouldProcess?")) { Get-Orgs | Where-Object { $orgIds.Contains( $_.id) } | ForEach-Object { Set-UsersInGroup -Org $_ -GroupName $GroupName -UserIds $UserIds } } } end { Write-Verbose "[$($MyInvocation.MyCommand.Name)] Complete" } } |