Get-KshTenantUser.md

external help file	Module Name	online version	schema
SPClientCore.dll-Help.xml	SPClientCore		2.0.0

Get-KshTenantUser

SYNOPSIS

Retrieves one or more users.

SYNTAX

ParamSet1

Get-KshTenantUser [-SiteCollection] <TenantSiteCollection> [-UserId] <Int32>
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

ParamSet2

Get-KshTenantUser [-SiteCollection] <TenantSiteCollection> [-UserName] <String>
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

ParamSet3

Get-KshTenantUser [-SiteCollection] <TenantSiteCollection> [-NoEnumerate] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

ParamSet4

Get-KshTenantUser [-SiteCollectionUrl] <Uri> [-UserId] <Int32> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

ParamSet5

Get-KshTenantUser [-SiteCollectionUrl] <Uri> [-UserName] <String> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

ParamSet6

Get-KshTenantUser [-SiteCollectionUrl] <Uri> [-NoEnumerate] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

The Get-KshTenantUser cmdlet retrieves users of the specified site collection. This cmdlet can be used only when connected to the SharePoint admin center.

EXAMPLES

Example 1

PS C:\> Get-KshTenantUser -SiteCollectionUrl 'https://example.sharepoint.com/sites/japan' -UserId 1

Retrieves a user by user ID.

Example 2

PS C:\> Get-KshTenantUser -SiteCollectionUrl 'https://example.sharepoint.com/sites/japan' -UserName 'i:0#.f|membership|[email protected]'

Retrieves a user by user login name.

Example 3

PS C:\> Get-KshTenantUser -SiteCollectionUrl 'https://example.sharepoint.com/sites/japan' -UserName '[email protected]'

Retrieves a user by user e-mail address.

Example 4

PS C:\> Get-KshTenantUser -SiteCollectionUrl 'https://example.sharepoint.com/sites/japan'

Retrieves all users of the specified site collection.

PARAMETERS

-NoEnumerate

If specified, suppresses to enumerate objects.

Type: SwitchParameter
Parameter Sets: ParamSet3, ParamSet6
Aliases:

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

-SiteCollection

Specifies the site collection.

Type: TenantSiteCollection
Parameter Sets: ParamSet1, ParamSet2, ParamSet3
Aliases:

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

-SiteCollectionUrl

Specifies the site collection URL.

Type: Uri
Parameter Sets: ParamSet4, ParamSet5, ParamSet6
Aliases:

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

-UserId

Specifies the user ID.

Type: Int32
Parameter Sets: ParamSet1, ParamSet4
Aliases:

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

-UserName

Specifies the user name.

Type: String
Parameter Sets: ParamSet2, ParamSet5
Aliases:

Required: True
Position: 0
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

None

OUTPUTS

Karamem0.SharePoint.PowerShell.Models.V1.User

NOTES

RELATED LINKS