< Back
Set-BTUser
Post
NAME Set-BTUser
SYNOPSIS
Updates Power365 Users.
SYNTAX
Set-BTUser [-Identity] <object> [-MatchIdentity <string>] [-MatchProperty <string>] [-MigrationState <string>]
[-Profile <object>] [-Project <object>] [-Session <Session>] [-Wave <object>] [<CommonParameters>]
DESCRIPTION
Set-BTUser -Identity -Wave sets or clears a User's Wave.
Set-BTUser -Identity -Profile sets a User's Profile.
Set-BTUser -Identity -MatchIdentity sets or clears a User's matching target object.
Set-BTUser -Identity -MigrationState updates a User's migration state.
Set-BTUser -MatchProperty sets or clears multiple Users' matching target objects.
The ApiKey role must be 'Writer' to run the Set-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 identity searches to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to
the Session's default Project, if any. Ignored if -Identity is a UserId or User object.
Required? false
Position? named
Default value System.Object
Accept pipeline input? false
Accept wildcard characters? false
-Wave <object>
New Wave, or $null to remove the user from its current Wave.
Required? false
Position? named
Default value System.Object
Accept pipeline input? false
Accept wildcard characters? false
-Profile <object>
New Profile.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MigrationState <string>
New migration state.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MatchIdentity <string>
Identity of matching target user: To set the matching user, specify the UserId, Uid, SamAccountName, Mail,
UserPrincipalName, DisplayName, or a User object. To clear the matching user, specify $null or an empty
string. Cannot be used with pipeline input.
Required? false
Position? named
Default value ~NotSpecified~
Accept pipeline input? false
Accept wildcard characters? false
-MatchProperty <string>
Property of input object that contains the identity of the matching target user. Can be used with pipeline
input. To clear the matching user, specify "None", or specify a property of the input object whose value is an
empty string.
Required? false
Position? named
Default value ~NotSpecified~
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 ----------
Set-BTUser -Identity bob.smith@contoso.com -Wave 83
Set-BTUser -Identity 'Bob Smith' -Wave 'My Wave'
Set-BTUser -Identity 983 -Wave $wave
Set-BTUser -Identity $user -Wave $null
Sets or clears the specified User's Wave.
---------- EXAMPLE 2 ----------
Set-BTUser -Identity bob.smith@contoso.com -Profile 906
Set-BTUser -Identity bob.smith@contoso.com -Profile 'My Profile'
Set-BTUser -Identity bob.smith@contoso.com -Profile $profile
Sets the specified User's Profile.
---------- EXAMPLE 3 ----------
Set-BTUser -Identity bob.smith@contoso.com -MigrationState Complete
Sets the specified User's migration state.
---------- EXAMPLE 4 ----------
Set-BTUser -Identity bob.smith@contoso.com -MatchIdentity bob.smith@fabrikam.com
Sets the specified User's matching target object.
---------- EXAMPLE 5 ----------
Set-BTUser -Identity bob.smith@contoso.com -MatchIdentity $null
Clears the specified User's matching target object.
---------- EXAMPLE 6 ----------
Import-CSV <path> | Set-BTUser -MatchProperty TargetUserPrincipalName
Sets the specified Users' matching target objects using a column from a .csv file.
---------- EXAMPLE 7 ----------
Import-CSV <path> | Set-BTUser -MatchProperty None
Clears the specified Users' matching target objects using a .csv file.
RELATED LINKS
SYNOPSIS
Updates Power365 Users.
SYNTAX
Set-BTUser [-Identity] <object> [-MatchIdentity <string>] [-MatchProperty <string>] [-MigrationState <string>]
[-Profile <object>] [-Project <object>] [-Session <Session>] [-Wave <object>] [<CommonParameters>]
DESCRIPTION
Set-BTUser -Identity -Wave sets or clears a User's Wave.
Set-BTUser -Identity -Profile sets a User's Profile.
Set-BTUser -Identity -MatchIdentity sets or clears a User's matching target object.
Set-BTUser -Identity -MigrationState updates a User's migration state.
Set-BTUser -MatchProperty sets or clears multiple Users' matching target objects.
The ApiKey role must be 'Writer' to run the Set-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 identity searches to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to
the Session's default Project, if any. Ignored if -Identity is a UserId or User object.
Required? false
Position? named
Default value System.Object
Accept pipeline input? false
Accept wildcard characters? false
-Wave <object>
New Wave, or $null to remove the user from its current Wave.
Required? false
Position? named
Default value System.Object
Accept pipeline input? false
Accept wildcard characters? false
-Profile <object>
New Profile.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MigrationState <string>
New migration state.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MatchIdentity <string>
Identity of matching target user: To set the matching user, specify the UserId, Uid, SamAccountName, Mail,
UserPrincipalName, DisplayName, or a User object. To clear the matching user, specify $null or an empty
string. Cannot be used with pipeline input.
Required? false
Position? named
Default value ~NotSpecified~
Accept pipeline input? false
Accept wildcard characters? false
-MatchProperty <string>
Property of input object that contains the identity of the matching target user. Can be used with pipeline
input. To clear the matching user, specify "None", or specify a property of the input object whose value is an
empty string.
Required? false
Position? named
Default value ~NotSpecified~
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 ----------
Set-BTUser -Identity bob.smith@contoso.com -Wave 83
Set-BTUser -Identity 'Bob Smith' -Wave 'My Wave'
Set-BTUser -Identity 983 -Wave $wave
Set-BTUser -Identity $user -Wave $null
Sets or clears the specified User's Wave.
---------- EXAMPLE 2 ----------
Set-BTUser -Identity bob.smith@contoso.com -Profile 906
Set-BTUser -Identity bob.smith@contoso.com -Profile 'My Profile'
Set-BTUser -Identity bob.smith@contoso.com -Profile $profile
Sets the specified User's Profile.
---------- EXAMPLE 3 ----------
Set-BTUser -Identity bob.smith@contoso.com -MigrationState Complete
Sets the specified User's migration state.
---------- EXAMPLE 4 ----------
Set-BTUser -Identity bob.smith@contoso.com -MatchIdentity bob.smith@fabrikam.com
Sets the specified User's matching target object.
---------- EXAMPLE 5 ----------
Set-BTUser -Identity bob.smith@contoso.com -MatchIdentity $null
Clears the specified User's matching target object.
---------- EXAMPLE 6 ----------
Import-CSV <path> | Set-BTUser -MatchProperty TargetUserPrincipalName
Sets the specified Users' matching target objects using a column from a .csv file.
---------- EXAMPLE 7 ----------
Import-CSV <path> | Set-BTUser -MatchProperty None
Clears the specified Users' matching target objects using a .csv file.
RELATED LINKS