< Back
Get-BTUser
Post
NAME Get-BTUser
SYNOPSIS
Returns Power365 Users.
SYNTAX
Get-BTUser [-Identity] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Get-BTUser [-Filter <string>] [-Limit <int>] [-Profile <object>] [-Project <object>] [-Session <Session>] [-Wave
<object>] [<CommonParameters>]
DESCRIPTION
Get-BTUser -Identity returns the User identified by its UserId, identity, or a User object.
Get-BTUser [-Filter] [-Limit] [-Project] [-Wave] returns Users matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTUser cmdlet.
PARAMETERS
-Identity <object>
User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Project <object>
Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's
default Project, if any.
Required? false
Position? named
Default value System.Object
Accept pipeline input? false
Accept wildcard characters? false
-Wave <object>
Filter by Wave, specified by WaveId, WaveName, or Wave object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Profile <object>
Filter by Profile, specified by ProfileId, ProfileName, or Profile object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties
are ArchiveSize, DeliverToMailboxAndForward, Department, DisplayName, ErsRewriteGroup, ErsRewriteMode,
HiddenFromAddressListsEnabled, IsContact, IsEquipment, IsMailbox, IsMailUser, IsRoom, IsShared, IsTeam,
IsUnifiedGroup, Mail, MailNickname, MigrationState, ProfileId, ProfileName, LitigationHoldDate,
LitigationHoldDuration, LitigationHoldEnabled, LitigationHoldOwner, MailboxServicePlan, MailboxSize,
MatchReason, NewPrimarySmtpAddress, NewUserPrincipalName, OdbQuota, OdbServicePlan, OdbSize,
OnPremisesSamAccountName, OnPremisesUserPrincipalName, PercentComplete, PreferredLanguage, ProjectId,
ProjectName, RecipientType, RecipientTypeDetails, Region, SamAccountName, TargetMail, TargetMailNickname,
TargetSamAccountName, TargetTenantId, TargetTenantName, TargetUserPrincipalName, TenantId, TenantName, Uid,
UserId, UserPrincipalName, WaveId, and WaveName.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Limit <int>
Limit the number of returned items.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Session <Session>
The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Object
User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.
OUTPUTS
BinaryTree.Power365.SDK.User
---------- EXAMPLE 1 ----------
Get-BTUser -Identity 153
Get-BTUser -Identity bob.smith@contoso.com
Get-BTUser -Identity 'Bob Smith'
Get-BTUser -Identity $user
Returns a User by UserId, identity, or a User object.
---------- EXAMPLE 2 ----------
Get-BTUser
Returns all Users.
---------- EXAMPLE 3 ----------
Get-BTUser -Wave 'My Wave' -Filter "MigrationState -eq 'Ready'" -Limit 10
Returns the first 10 Users in the specified Wave where MigrationState is Ready.
RELATED LINKS
SYNOPSIS
Returns Power365 Users.
SYNTAX
Get-BTUser [-Identity] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Get-BTUser [-Filter <string>] [-Limit <int>] [-Profile <object>] [-Project <object>] [-Session <Session>] [-Wave
<object>] [<CommonParameters>]
DESCRIPTION
Get-BTUser -Identity returns the User identified by its UserId, identity, or a User object.
Get-BTUser [-Filter] [-Limit] [-Project] [-Wave] returns Users matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTUser cmdlet.
PARAMETERS
-Identity <object>
User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Project <object>
Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's
default Project, if any.
Required? false
Position? named
Default value System.Object
Accept pipeline input? false
Accept wildcard characters? false
-Wave <object>
Filter by Wave, specified by WaveId, WaveName, or Wave object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Profile <object>
Filter by Profile, specified by ProfileId, ProfileName, or Profile object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties
are ArchiveSize, DeliverToMailboxAndForward, Department, DisplayName, ErsRewriteGroup, ErsRewriteMode,
HiddenFromAddressListsEnabled, IsContact, IsEquipment, IsMailbox, IsMailUser, IsRoom, IsShared, IsTeam,
IsUnifiedGroup, Mail, MailNickname, MigrationState, ProfileId, ProfileName, LitigationHoldDate,
LitigationHoldDuration, LitigationHoldEnabled, LitigationHoldOwner, MailboxServicePlan, MailboxSize,
MatchReason, NewPrimarySmtpAddress, NewUserPrincipalName, OdbQuota, OdbServicePlan, OdbSize,
OnPremisesSamAccountName, OnPremisesUserPrincipalName, PercentComplete, PreferredLanguage, ProjectId,
ProjectName, RecipientType, RecipientTypeDetails, Region, SamAccountName, TargetMail, TargetMailNickname,
TargetSamAccountName, TargetTenantId, TargetTenantName, TargetUserPrincipalName, TenantId, TenantName, Uid,
UserId, UserPrincipalName, WaveId, and WaveName.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Limit <int>
Limit the number of returned items.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Session <Session>
The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Object
User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.
OUTPUTS
BinaryTree.Power365.SDK.User
---------- EXAMPLE 1 ----------
Get-BTUser -Identity 153
Get-BTUser -Identity bob.smith@contoso.com
Get-BTUser -Identity 'Bob Smith'
Get-BTUser -Identity $user
Returns a User by UserId, identity, or a User object.
---------- EXAMPLE 2 ----------
Get-BTUser
Returns all Users.
---------- EXAMPLE 3 ----------
Get-BTUser -Wave 'My Wave' -Filter "MigrationState -eq 'Ready'" -Limit 10
Returns the first 10 Users in the specified Wave where MigrationState is Ready.
RELATED LINKS