Skip to content

Latest commit

 

History

History
152 lines (113 loc) · 2.66 KB

Get-KshGroup.md

File metadata and controls

152 lines (113 loc) · 2.66 KB
external help file Module Name online version schema
SPClientCore.dll-Help.xml
SPClientCore
2.0.0

Get-KshGroup

SYNOPSIS

Retrieves one or more groups.

SYNTAX

ParamSet1

Get-KshGroup [-Identity] <Group> [-ProgressAction <ActionPreference>] [<CommonParameters>]

ParamSet2

Get-KshGroup [-GroupId] <Int32> [-ProgressAction <ActionPreference>] [<CommonParameters>]

ParamSet3

Get-KshGroup [-GroupTitle] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

ParamSet4

Get-KshGroup [-NoEnumerate] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Get-KshGroup cmdlet retrieves groups of the current site.

EXAMPLES

Example 1

PS C:\> Get-KshGroup -GroupId 1

Retrieves a group by group ID.

Example 2

PS C:\> Get-KshGroup -GroupName 'Blog Owners'

Retrieves a group by group title.

Example 3

PS C:\> Get-KshGroup

Retrieves all groups.

PARAMETERS

-GroupId

Specifies the group ID.

Type: Int32
Parameter Sets: ParamSet2
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GroupTitle

Specifies the group title.

Type: String
Parameter Sets: ParamSet3
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

Specifies the group.

Type: Group
Parameter Sets: ParamSet1
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-NoEnumerate

If specified, suppresses to enumerate objects.

Type: SwitchParameter
Parameter Sets: ParamSet4
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider.

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Karamem0.SharePoint.PowerShell.Models.V1.Group

OUTPUTS

Karamem0.SharePoint.PowerShell.Models.V1.Group

NOTES

RELATED LINKS