functions/SPClientGroup/Get-SPClientGroup.ps1
|
#Requires -Version 3.0 <# Get-SPClientGroup.ps1 Copyright (c) 2017 karamem0 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #> function Get-SPClientGroup { <# .SYNOPSIS Gets one or more groups. .DESCRIPTION The Get-SPClientGroup function lists all site groups or retrieves the specified site group. If not specified filterable parameter, returns site all groups. Otherwise, returns a group which matches the parameter. .PARAMETER ClientContext Indicates the client context. If not specified, uses default context. .PARAMETER Identity Indicates the group ID. .PARAMETER Name Indicates the group name. .PARAMETER Retrievals Indicates the data retrieval expression. .EXAMPLE Get-SPClientGroup .EXAMPLE Get-SPClientGroup -Identity 7 .EXAMPLE Get-SPClientGroup -Name "Custom Group" .EXAMPLE Get-SPClientGroup -Retrievals "Title" .INPUTS None .OUTPUTS Microsoft.SharePoint.Client.GroupCollection Microsoft.SharePoint.Client.Group .LINK https://github.com/karamem0/SPClient/blob/master/doc/Get-SPClientGroup.md #> [CmdletBinding(DefaultParameterSetName = 'All')] param ( [Parameter(Mandatory = $false, ParameterSetName = 'All')] [Parameter(Mandatory = $false, ParameterSetName = 'Identity')] [Parameter(Mandatory = $false, ParameterSetName = 'Name')] [Microsoft.SharePoint.Client.ClientContext] $ClientContext = $SPClient.ClientContext, [Parameter(Mandatory = $true, ParameterSetName = 'Identity')] [Alias('Id')] [int] $Identity, [Parameter(Mandatory = $true, ParameterSetName = 'Name')] [Alias('Title')] [string] $Name, [Parameter(Mandatory = $false)] [string] $Retrievals ) process { if ($ClientContext -eq $null) { throw "Cannot bind argument to parameter 'ClientContext' because it is null." } $ClientObjectCollection = $ClientContext.Site.RootWeb.SiteGroups if ($PSCmdlet.ParameterSetName -eq 'All') { Invoke-SPClientLoadQuery ` -ClientContext $ClientContext ` -ClientObject $ClientObjectCollection ` -Retrievals $Retrievals Write-Output @(, $ClientObjectCollection) } if ($PSCmdlet.ParameterSetName -eq 'Identity') { $PathMethod = New-Object Microsoft.SharePoint.Client.ObjectPathMethod( ` $ClientContext, ` $ClientObjectCollection.Path, ` 'GetById', ` [object[]]$Identity) $ClientObject = New-Object Microsoft.SharePoint.Client.Group($ClientContext, $PathMethod) Invoke-SPClientLoadQuery ` -ClientContext $ClientContext ` -ClientObject $ClientObject ` -Retrievals $Retrievals Write-Output $ClientObject trap { throw 'The specified group could not be found.' } } if ($PSCmdlet.ParameterSetName -eq 'Name') { $PathMethod = New-Object Microsoft.SharePoint.Client.ObjectPathMethod( ` $ClientContext, ` $ClientObjectCollection.Path, ` 'GetByName', ` [object[]]$Name) $ClientObject = New-Object Microsoft.SharePoint.Client.Group($ClientContext, $PathMethod) Invoke-SPClientLoadQuery ` -ClientContext $ClientContext ` -ClientObject $ClientObject ` -Retrievals $Retrievals Write-Output $ClientObject trap { throw 'The specified group could not be found.' } } } } |