Cmdlets
Note: Expand a cmdlet and use your browser's "Find on page" function to search for keywords.
Connects to a Power365 instance. The Power365 Session remains the default until Connect-BTSession is invoked again, or -Session is specified on a cmdlet.
Syntax
Connect-BTSession -ApiKey <SecureString> [<CommonParameters>]
Description
Connect-BTSession connects to a Power365 instance. This requires an ApiKey issued by an administrator of your Power365 account.
Parameters
-ApiKey <SecureString>
The API Key issued by an administrator of your Power365 account.
Required? true 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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Outputs
BinaryTree.Power365.Cmdlet.Session
---------- Example 1 ----------
$secureKey = Read-Host 'What is your ApiKey?' -AsSecureString
Connect-BTSession -ApiKey $secureKey
Returns the Power365 Session.
Disconnects from a Power365 instance.
Syntax
Disconnect-BTSession
Description
Disconnect-BTSession disconnects from a Power365 instance.
Parameters
<CommonParameters>
This cmdlet supports the common parameters:
- Verbose
- Debug
- ErrorAction
- ErrorVariable
- WarningAction
- WarningVariable
- OutBuffer
- PipelineVariable
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Outputs
---------- Example 1 ----------
Disonnect-BTSession
Returns the statuses of Power365 Cutover operations.
Syntax
Get-BTCutover [-Identity] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Description
Get-BTCutover -Identity returns the Cutover identified by its CutoverJobId, or a Cutover object.
Get-BTCutover [-Project] [-Wave] [-User] [-Filter] [-Limit] returns Cutovers matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.
Parameters
-Identity <object>
Cutover identity: CutoverJobId, or Cutover 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? true Position? named Default value Accept pipeline input? false Accept wildcard characters? false
-User <object>
Filter by User, specified by UserId, UPN, Email, or User 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 "PercentComplete -eq 100".
The supported properties are:
- CutoverJobId
- UserId
- IsComplete
- Started
- Completed
- PercentComplete
- TotalTimeSeconds
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Cutover identity: CutoverJobId, or Cutover object.
Outputs
BinaryTree.Power365.SDK.CutoverJob
---------- Example 1 ----------
Get-BTCutover -Identity 986
Get-BTCutover -Identity $cutover
Returns a Cutover by CutoverJobId, or a Cutover object.
---------- Example 2 ----------
Get-BTCutover
Returns all Cutovers.
---------- Example 3 ----------
Get-BTCutover -User joe@contoso.com -Filter "IsComplete -eq true" -Limit 10
Returns the most recent 10 Cutovers for the specified User where IsComplete is true.
Returns Power365 Environments.
Syntax
Get-BTEnvironment [-Identity] <object> [-Session <Session>] [<CommonParameters>]
Description
Get- BTEnvironment -Identity returns the Environments identified by its TenantID, TenantName, TenantGUID or an Environment Object
Get- BTEnvironment [-Filter] [-Limit] returns Environments matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get- BTEnvironment cmdlet.
Parameters
-Identity <object>
Environment identity: TenantId, TenantName, TenantGuid, or Environment object.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "TenantName -like 'My*'".
The supported properties are:
- TenantId
- TenantName
- TenantGuid
- DiscoveryFrequencyHours
- T2TPowerShellUsername
- PFPowerShellUsername
- SkipUserDiscovery
- IsHybrid
- IsConnected
- DiscoveryDeltaTimestamp
- DiscoveryStarted
- DiscoveryFinished
- DiscoveryState
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
Inputs
System.Object
Identity: TenantID, TenantName or Environment object.
Outputs
BinaryTree.Power365.SDK.Environment
---------- Example 1 ----------
Get-BTEnvironment -Filter "TenantName -eq 'BTCloud1'"
Returns an Environment by Tenant Name.
Returns Power365 Prepare, Sync, Cutover, or Environment Discovery Logs.
Syntax
Get-BTLog [-Identity] <object> [-Levels <string[]>] [-Limit <int>] [-Project <object>] [-Session <Session>] [<CommonParameters>]
Get-BTLog [-Identity] <object> -Prepare <SwitchParameter> [-Levels <string[]>] [-Limit <int>] [-Project <object>] [-Session <Session>] [<CommonParameters>]
Get-BTLog [-Identity] <object> -Sync <SwitchParameter> [-Levels <string[]>] [-Limit <int>] [-Project <object>] [-Session <Session>] [<CommonParameters>]
Get-BTLog [-Identity] <object> -Cutover <SwitchParameter> [-Levels <string[]>] [-Limit <int>] [-Project <object>] [-Session <Session>] [<CommonParameters>]
Get-BTLog [-Identity] <object> -Discovery <SwitchParameter> [-Levels <string[]>] [-Limit <int>] [-Project <object>] [-Session <Session>] [<CommonParameters>]
Description
Get-BTLog -Identity <id> -Prepare returns Prepare Logs.
Get-BTLog -Identity <id> -Sync returns Sync Logs.
Get-BTLog -Identity <id> -Cutover returns Cutover Logs.
Get-BTLog -Identity <id> -Discovery returns Environment Discovery Logs.
Get-BTLog -Identity <object> returns Logs for the specified Prepare, Sync, Cutover, or Environment object.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTLog cmdlet.
Parameters
-Identity <object>
Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment 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
-Prepare <SwitchParameter>
Identity is a PrepareJobId.
Required? true Position? named Default value False Accept pipeline input? false Accept wildcard characters? false
-Sync <SwitchParameter>
Identity is a SyncJobId.
Required? true Position? named Default value False Accept pipeline input? false Accept wildcard characters? false
-Cutover <SwitchParameter>
Identity is a CutoverJobId.
Required? true Position? named Default value False Accept pipeline input? false Accept wildcard characters? false
-Discovery <SwitchParameter>
Identity is a TenantId.
Required? true Position? named Default value False Accept pipeline input? false Accept wildcard characters? false
-Levels <string[]>
Filter by level(s): Error, Warn, Info, Debug, and/or Trace.
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Identity: PrepareJobId/SyncJobId/CutoverJobId or Prepare/Sync/Cutover object.
Outputs
System.Management.Automation.PSObject
---------- Example 1 ----------
Get-BTLog -Identity 355 -Prepare
Get-BTLog -Identity 356 -Sync
Get-BTLog -Identity 357 -Cutover
Get-BTLog -Identity 368 -Discovery
Returns Logs for a Prepare, Sync, Cutover, or Environment by id.
---------- Example 2 ----------
Get-BTLog -Identity $prepare
Get-BTLog -Identity $sync
Get-BTLog -Identity $cutover
Get-BTLog -Identity $environment
Returns Logs for a Prepare, Sync, Cutover, or Environment by object.
Returns the statuses of Power365 Prepare operations.
Syntax
Get-BTPrepare [-Identity] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Description
Get-BTPrepare -Identity returns the Prepare identified by its PrepareJobId, or a Prepare object.
Get-BTPrepare [-Project] [-Wave] [-User] [-Filter] [-Limit] returns Prepares matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.
Parameters
-Identity <object>
Prepare identity: PrepareJobId, or Prepare 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
-User <object>
Filter by User, specified by UserId, UPN, Email, or User 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 "PercentComplete -eq 100".
The supported properties are:
- PrepareJobId
- UserId
- IsComplete
- Started
- Completed
- PercentComplete
- TotalTimeSeconds
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Prepare identity: PrepareJobId, or Prepare object.
Outputs
BinaryTree.Power365.SDK.PrepareJob
---------- Example 1 ----------
Get-BTPrepare -Identity 986
Get-BTPrepare -Identity $prepare
Returns a Prepare by PrepareJobId, or a Prepare object.
---------- Example 2 ----------
Get-BTPrepare
Returns all Prepares.
---------- Example 3 ----------
Get-BTPrepare -User joe@contoso.com -Filter "IsComplete -eq true" -Limit 10
Returns the most recent 10 Prepares for the specified User where IsComplete is true.
Returns Power365 Profiles.
Syntax
Get-BTProfile [-Identity] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Description
Get-BTProfile -Identity returns the Profile identified by its ProfileId, ProfileName, or a Profile object.
Get-BTProfile [-Project] [-Filter] [-Limit] returns Profiles matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProfile cmdlet.
Parameters
-Identity <object>
Profile identity: ProfileId, ProfileName, or Profile 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
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'".
The supported properties are:
- CutoverNotificationBody
- CutoverNotificationSubjec
- CutoverDesktopAgentEnabled
- CutoverDesktopAgentSilent
- CutoverOutlookAgentEnabled
- CutoverOutlookAgentSilent
- CutoverSkipNoticeODB
- CutoverSkipPermissionsFinalSync
- CutoverSkipPermissionsInitialSync
- CutoverSkipPermissionsNormalSync
- CutoverSkipPermissionsSync
- CutoverWaitsOnDesktopAgent
- CutoverWaitsOnOutlookAgent
- DeltaSyncSkipPermissionsSync
- ErrorFolderThreshold
- ErrorFolderThresholdODB
- ErrorItemThreshold
- ErrorItemThresholdODB
- FilterCalendarMaxAgeDays
- FilterCalendarNotAfter
- FilterCalendarNotBefore
- FilterCalendarType
- FilterMailMaxAgeDays
- FilterMailNotAfter
- FilterMailNotBefore
- FilterMailType
- FilterNotesMaxAgeDays
- FilterNotesNotAfter
- FilterNotesNotBefore
- FilterNotesType
- FilterSizeMaxMB
- FilterSizeType
- FilterTasksMaxAgeDays
- FilterTasksNotAfter
- FilterTasksNotBefore
- FilterTasksType
- IsDefault
- LastUpdateUtc
- LicensingMode
- LicensingSKU
- MigrateArchiveMailbox
- MigrateAutomaticReplies
- MigrateContacts
- MigrateLitHolds
- MigrateOneDriveForBusiness
- MigrateRules
- MigrateSignatures
- OneNoteFinalSyncOnly
- PrepareUnifiedGroupsAsTeams
- PrepareUnifiedGroupsAndTeams
- PrepareUsers
- ProfileId
- ProfileName
- ProjectId
- ProjectName
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Profile identity: ProfileId, ProfileName, or Profile object.
Outputs
BinaryTree.Power365.SDK.Profile
---------- Example 1 ----------
Get-BTProfile -Identity 986
Get-BTProfile -Identity 'My Profile'
Get-BTProfile -Identity $profile
Returns a Profile by ProfileId, ProfileName, or a Profile object.
---------- Example 2 ----------
Get-BTProfile
Returns all Profiles.
---------- Example 3 ----------
Get-BTProfile -Filter "ProfileName -like 'M*' -Limit 10
Returns the first 10 Profiles whose ProfileName begins with 'M'.
Returns Power365 Projects.
Syntax
Get-BTProject [-Identity] <object> [-Session <Session>] [<CommonParameters>]
Description
Get-BTProject -Identity returns the Project identified by its ProjectId, ProjectName, or a Project object.
Get-BTProject [-Filter] [-Limit] returns Projects matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.
Parameters
-Identity <object>
Project identity: ProjectId, ProjectName, or Project object.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties are ProjectId, ProjectName, and ProjectType.
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Project identity: ProjectId, ProjectName, or Project object.
Outputs
BinaryTree.Power365.SDK.Project
---------- Example 1 ----------
Get-BTProject -Identity 986
Get-BTProject -Identity 'My Project'
Get-BTProject -Identity $project
Returns a Project by ProjectId, ProjectName, or a Project object.
---------- Example 2 ----------
Get-BTProject
Returns all Projects.
---------- Example 3 ----------
Get-BTProject -Filter "ProjectName -like 'M*' -Limit 10
Returns the first 10 Projects whose ProjectName begins with 'M'.
Returns Power365 ServiceAccounts.
Syntax
Get-BTServiceAccount [-Identity] <object> [-Session <Session>] [<CommonParameters>]
Description
Get-BTServiceAccount -Identity returns the Power365 ServiceAccount identified by its Id, PrincipalName, or a
ServiceAccount object.
Get-BTServiceAccount [-Type] [-Filter] [-Limit] returns Power365 ServiceAccounts matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTServiceAccount cmdlet.
Parameters
-Identity <object>
Power365 ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "PrincipalName -like '*123*'". The supported
properties are Id, PrincipalName, and EnvironmentName.
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Power365 ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.
Outputs
BinaryTree.Power365.SDK.ServiceAccount
---------- EXAMPLE 1 ----------
Get-BTServiceAccount -Identity 153
Get-BTServiceAccount -Identity BTPowerShellUser.123@contoso.com
Get-BTServiceAccount -Identity $serviceAccount
Returns a Power365 ServiceAccount by id, identity, or a ServiceAccount object.
---------- EXAMPLE 2 ----------
Get-BTServiceAccount
Returns all Power365 ServiceAccounts.
---------- EXAMPLE 3 ----------
Get-BTServiceAccount -Filter "PrincipalName -like '*123*'" -Limit 10
Returns the first 10 Power365 ServiceAccounts whose PrincipalName matches the pattern.
Gets the default Power365 Session.
Syntax
Get-BTSession [<CommonParameters>]
Description
Get-BTSession gets the default Power365 Session.
Parameters
<CommonParameters>
This cmdlet supports the common parameters:
- Verbose
- Debug
- ErrorAction
- ErrorVariable
- WarningAction
- WarningVariable
- OutBuffer
- PipelineVariable
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Outputs
BinaryTree.Power365.Cmdlet.Session
---------- Example 1 ----------
Get-BTSession
Returns the default Power365 Session.
Returns the statuses of Power365 Sync operations.
Syntax
Get-BTSync [-Identity] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Description
Get-BTSync -Identity returns the Sync identified by its SyncJobId, or a Sync object.
Get-BTSync [-Project] [-Wave] [-User] [-Filter] [-Limit] returns Syncs matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.
Parameters
-Identity <object>
Sync identity: SyncJobId, or Sync 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
-User <object>
Filter by User, specified by UserId, UPN, Email, or User 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 "PercentComplete -eq 100".
The supported properties are:
- SyncJobId
- UserId
- SyncDataType
- SyncState
- IsComplete
- Started
- Completed
- PercentComplete
- TotalTimeSeconds
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Sync identity: SyncJobId, or Sync object.
Outputs
BinaryTree.Power365.SDK.SyncJob
---------- Example 1 ----------
Get-BTSync -Identity 986
Get-BTSync -Identity $sync
Returns a Sync by SyncJobId, or a Sync object.
---------- Example 2 ----------
Get-BTSync
Returns all Syncs.
---------- Example 3 ----------
Get-BTSync -User joe@contoso.com -Filter "IsComplete -eq true" -Limit 10
Returns the most recent 10 Syncs for the specified User where IsComplete is true.
Returns Power365 Users.
Syntax
Get-BTUser [-Identity] <object> [-Project <object>] [-Session <Session>] [<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
- MailNickname
- MigrationState
- ProfileId
- ProfileName
- LitigationHoldDate
- LitigationHoldDuration
- LitigationHoldEnabled
- LitigationHoldOwner
- MailboxServicePlan
- MailboxSize
- MatchReason
- NewPrimarySmtpAddress
- NewUserPrincipalName
- OdbQuota
- OdbServicePlan
- OdbSize
- OnPremisesSamAccountName
- OnPremisesUserPrincipalName
- OutlookState
- PercentComplete
- PreferredLanguage
- ProjectId
- ProjectName
- RecipientType
- RecipientTypeDetails
- Region
- SamAccountName
- TargetMail
- TargetMailNickname
- TargetSamAccountName
- TargetTenantId
- TargetTenantName
- TargetUserPrincipalName
- TenantId
- TenantName
- Uid
- UserId
- UserPrincipalName
- WaveId
- WaveName
Boolean attributes:
- IsMailbox
- IsMailUser
- IsContact
- IsRoom
- IsEquipment
- IsShared
- IsUnifiedGroup
- IsTeam
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
- OutVariable
For more information, see about_CommonParameters (http://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.
Returns Power365 Waves.
Syntax
Get-BTWave [-Identity] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Description
Get-BTWave -Identity returns the Wave identified by its WaveId, WaveName, or a Wave object.
Get-BTWave [-Project] [-Filter] [-Limit] returns Waves matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWave cmdlet.
Parameters
-Identity <object>
Wave identity: WaveId, WaveName, or a Wave 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
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "WaveName -like 'My*'".
The supported properties are:
- WaveId
- WaveName
- ProjectId
- ProjectName
- TenantMigrationId
- WaveName
- AdGroupName
- AdGroupUid
- TotalUsers
- NotReadyUsers
- ReadyUsers
- InProgressUsers
- CompleteUsers
- RollbackUsers
- ErrorUsers
- OtherUsers
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Wave identity: WaveId, WaveName, or a Wave object.
Outputs
BinaryTree.Power365.SDK.Wave
---------- Example 1 ----------
Get-BTWave -Identity 986
Get-BTWave -Identity 'My Wave'
Get-BTWave -Identity $wave
Returns a Wave by WaveId, WaveName, or a Wave object.
---------- Example 2 ----------
Get-BTWave
Returns all Waves.
---------- Example 3 ----------
Get-BTWave -Filter "WaveName -like 'M*'" -Limit 10
Returns the first 10 Waves whose WaveName starts with 'M'.
Returns Power365 Workflows.
Syntax
Get-BTWorkflow [-Identity] <object> [-Session <Session>] [<CommonParameters>]
Description
Get-BTWorkflow -Identity returns a Workflow by WorkflowId, identity, or a Workflow object.
Get-BTWorkflow [-Filter] [-Limit] returns Workflows that match selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWorkflow cmdlet.
Parameters
-Identity <object>
Workflow identity: WorkflowId, Name, or a Workflow object.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are WorkflowId and Name.
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Workflow identity: WorkflowId, Name, or a Workflow object.
Outputs
BinaryTree.Power365.SDK.Workflow
---------- Example 1 ----------
Get-BTWorkflow -Identity 107
Get-BTWorkflow -Identity 'My Workflow'
Get-BTWorkflow -Identity $workflow
Returns a Workflow by WorkflowId, identity, or a Workflow object.
---------- Example 2 ----------
Get-BTWorkflow
Returns all Workflows.
---------- Example 3 ----------
Get-BTWorkflow -Filter "Name -like 'M*'" -Limit 3
Returns the first 3 Workflows whose Name starts with 'M'.
Returns the Logs for a specified Power365 WorkflowRun.
Syntax
Get-BTWorkflowLog [-Identity] <object> [-Levels <string[]>] [-Limit <int>] [-Session <Session>] [<CommonParameters>] |
Description
The Get-BTWorkflowLog -Identity (WorkflowRun object or id) cmdlet matches only one identity.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWorkflowLog cmdlet.
Parameters
-Identity <object>
Identity: WorkflowRunId or WorkflowRun object.
Required? false Position? 0 Default value Accept pipeline input? false Accept wildcard characters? false
-Levels <string[]>
Filter by level(s): Error, Warn, Info, Debug, and/or Trace.
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Outputs
System.Management.Automation.PSObject
---------- Example 1 ----------
Get-BTWorkFlowLog -Identity 4926 -Limit 10
Returns the most recent 10 Logs for WorkflowRun 4926.
Returns Power365 WorkflowRuns.
Syntax
Get-BTWorkflowRun [-Identity] <object> [-Session <Session>] [<CommonParameters>]
Description
Get-WorkflowRun -Identity returns a WorkflowRun by WorkflowRunId or a WorkflowRun object.
Get-WorkflowRun [-Filter] [-Limit] [-Workflow] returns WorkflowRuns that match selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-WorkflowRun cmdlet.
Parameters
-Identity <object>
WorkflowRun identity: WorkflowRunId or WorkflowRun object.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false
-Workflow <object>
Filter by Workflow (WorkflowId, Name, or Workflow 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 "WorkflowName -like 'My*'". The supported properties are WorkflowRunId, WorkflowId, and WorkflowName.
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
WorkflowRun identity: WorkflowRunId or WorkflowRun object.
Outputs
BinaryTree.Power365.SDK.WorkflowRun
---------- Example 1 ----------
Get-WorkflowRun -Identity 766
Get-WorkflowRun -Identity $workflowRun
Gets a WorkflowRun by WorkflowRunId or WorkflowRun object.
---------- Example 2 ----------
Get-WorkflowRun
Returns all WorkflowRuns.
---------- Example 3 ----------
Get-WorkflowRun -Filter "WorkflowName -like 'M*'" -Limit 5
Returns the 5 most recent WorkflowRuns for Workflows whose names start with 'M'.
Returns DirSync ServiceAccounts.
Syntax
Get-DSServiceAccount [-Identity] <object> [-Session <Session>] [<CommonParameters>]
Description
Get-DSServiceAccount -Identity returns the DirSync ServiceAccount identified by its Id, PrincipalName, or a
ServiceAccount object.
Get-DSServiceAccount [-Type] [-Filter] [-Limit] returns DirSync ServiceAccounts matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-DSServiceAccount cmdlet.
Parameters
-Identity <object>
DirSync ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "PrincipalName -like '*123*'". The supported
properties are Id, PrincipalName, and EnvironmentName.
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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
DirSync ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.
Outputs
BinaryTree.Power365.SDK.ServiceAccount
---------- EXAMPLE 1 ----------
Get-DSServiceAccount -Identity 153
Get-DSServiceAccount -Identity BTPowerShellUser.123@contoso.com
Get-DSServiceAccount -Identity $serviceAccount
Returns a DirSync ServiceAccount by id, identity, or a ServiceAccount object.
---------- EXAMPLE 2 ----------
Get-DSServiceAccount
Returns all DirSync ServiceAccounts.
---------- EXAMPLE 3 ----------
Get-DSServiceAccount -Filter "PrincipalName -like '*123*'" -Limit 10
Returns the first 10 DirSync ServiceAccounts whose PrincipalName matches the pattern.
Creates a new Power365 Wave.
Syntax
New-BTWave -WaveName <string> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Description
The ApiKey role must be 'Writer' to run the New-BTWave cmdlet.
Parameters
-WaveName <string>
Required? true Position? named Default value Accept pipeline input? false Accept wildcard characters? false
-Project <object>
Required? false Position? named Default value System.Object 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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Outputs
BinaryTree.Power365.SDK.Wave
---------- Example 1 ----------
New-BTWave -DisplayName 'My Wave'
Creates a new Wave with the specified name.
Set Power365 Environments settings.
Syntax
Set-BTEnvironment [-Identity] <object> [-Session <Session>] [<CommonParameters>]
Description
Set-BTEnvironment -Identity -DiscoveryState sets discovery state for the environment specified.
Set-BTEnvironment -Identity -SkipUserDiscovery skips user discovery for the environment specified.
Set-BTEnvironment -Identity -DiscoveryFrequencyHours sets discovery frequency in hours for the environment specified.
The ApiKey role must be 'Writer' to run the Set-BTEnvironment cmdlet.
Parameters
-Identity <object>
Environment identity: TenantId, TenantName, or Environment object.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false
-DiscoveryState <string>
New Discovery state.New Discovery state: Enabled or Disabled
Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false
-SkipUserDiscovery <bool>
Skip Discovery of users.
Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false
-DiscoveryFrequencyHours <int>
How often to perform discovery.
Required? false Position? named Default value 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
Inputs
System.Object
Identity: TenantID, TenantName or Environment object.
Outputs
BinaryTree.Power365.SDK.Environment
---------- Example 1 ----------
Get-BTEnvironment -Filter "TenantName -eq 'BTCloud1'" Get-BTEnvironment -Filter "TenantName -eq 'BTCloud1'" | Set-BTEnvironment -DiscoveryFrequencyHours 12
Set-BTEnvironment -Identity 'BTCloud1' -DiscoveryFrequencyHours 12
Set Discovery Frequency in Hours for the specified environments.
---------- Example 2 ----------
Set-BTEnvironment -Identity 'BTCloud1' -DiscoveryState Disabled
Set-BTEnvironment -Identity 'BTCloud1' -DiscoveryState Enabled
Set Discovery setting to “Disabled” or “Enabled” for the specified environments.
Updates a Power365 Project, or sets the default Project.
Syntax
Set-BTProject [-Identity] <object> [-Default <SwitchParameter>] [-Session <Session>] [<CommonParameters>]
Description
Set-BTProject -Default makes the Project the default for the Session.
Parameters
-Identity <object>
Project identity: ProjectId, ProjectName, or Project object.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false
-Default <SwitchParameter>
Sets the default Project for the Session.
Required? false Position? named Default value False 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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Project identity: ProjectId, ProjectName, or Project object.
Outputs
BinaryTree.Power365.SDK.Project
---------- Example 1 ----------
Set-BTProject -Identity 986 -Default
Set-BTProject -Identity 'My Project' -Default
Set-BTProject -Identity $project -Default
Sets the default Project by ProjectId, ProjectName, or a Project object.
Updates a Power365 ServiceAccount.
Syntax
Set-BTServiceAccount [-Identity] <object> [-Password <SecureString>] [-Session <Session>] [<CommonParameters>]
Description
Set-BTServiceAccount -Password sets a Power365 ServiceAccount's password.
The ApiKey role must be 'Writer' to run the Set-BTServiceAccount cmdlet.
Parameters
-Identity <object>
Power365 ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false
-Password <SecureString>
New password.
Required? false Position? named Default value 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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Power365 ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.
Outputs
BinaryTree.Power365.SDK.ServiceAccount
---------- EXAMPLE 1 ----------
Set-BTServiceAccount -Identity BTPowerShellUser.123@contoso.com -Password $secureString
Set-BTServiceAccount -Identity 153 -Password $secureString
Sets the specified Power365 ServiceAccount's password.
Updates Power365 Users.
Syntax
Set-BTUser [-Identity] <object> [-MatchIdentity <string>] [-MatchProperty <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 -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
-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
- OutVariable
For more information, see about_CommonParameters (http://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 -MatchIdentity bob.smith@fabrikam.com
Sets the specified User's matching target object.
---------- Example 4 ----------
Set-BTUser -Identity bob.smith@contoso.com -MatchIdentity $null
Clears the specified User's matching target object.
---------- Example 5 ----------
Import-CSV <path> | Set-BTUser -MatchProperty TargetUserPrincipalName
Sets the specified Users' matching target objects using a column from a .csv file.
---------- Example 6 ----------
Import-CSV <path> | Set-BTUser -MatchProperty None
Clears the specified Users' matching target objects using a .csv file.
Updates a DirSync ServiceAccount.
Syntax
Set-DSServiceAccount [-Identity] <object> [-Password <SecureString>] [-Session <Session>] [<CommonParameters>]
Description
Set-DSServiceAccount -Password sets a DirSync ServiceAccount's password.
The ApiKey role must be 'Writer' to run the Set-DSServiceAccount cmdlet.
Parameters
-Identity <object>
DirSync ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false
-Password <SecureString>
New password.
Required? false Position? named Default value 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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
DirSync ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.
Outputs
BinaryTree.Power365.SDK.ServiceAccount
---------- EXAMPLE 1 ----------
Set-DSServiceAccount -Identity BTPowerShellUser.123@contoso.com -Password $secureString
Set-DSServiceAccount -Identity 153 -Password $secureString
Sets the specified DirSync ServiceAccount's password.
Start Cutover operations for Power365 Users.
Syntax
Start-BTCutover -User <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Start-BTCutover -Wave <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Start-BTCutover [-InputObject] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Description
Start-BTCutover -User starts a Cutover operation for a User.
Start-BTCutover -Wave starts a Cutover operation for a Wave.
Start-BTCutover -InputObject starts a Cutover operation for a User or Wave.
The ApiKey role must be 'Writer' to run the Start-BTCutover cmdlet.
Parameters
-User <object>
User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.
Required? true Position? named Default value Accept pipeline input? false Accept wildcard characters? false
-Wave <object>
Wave identity: WaveId, WaveName, or Wave object.
Required? true Position? named Default value Accept pipeline input? false Accept wildcard characters? false
-InputObject <object>
The User or Wave 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
-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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
The User or Wave object.
Outputs
---------- Example 1 ----------
Start-BTCutover -User 356
Start-BTCutover -User joe@contoso.com
Start-BTCutover -User $user
Starts a Cutover for a User by id, identity, or User object.
---------- Example 2 ----------
Start-BTCutover -Wave 356
Start-BTCutover -Wave 'My Wave'
Start-BTCutover -Wave $wave
Starts a Cutover for a Wave by id, identity, or Wave object.
---------- Example 3 ----------
$usersOrWaves | Start-BTCutover
Starts a Cutover for each input object, which can be a User or a Wave object.
Starts Power365 Environment discovery.
Syntax
Start-BTDiscovery [-Identity] <object> [-Session <Session>] [<CommonParameters>]
Description
Start-BTDiscovery -Identity starts discovery for the environment specified.
Start-BTDiscovery -Identity -DiscoveryDeltaTimestamp starts discovery based on a delta timestamp for the environment specified.
The ApiKey role must be 'Writer' to run the Start-BTDiscovery cmdlet.
Parameters
-Identity <object>
Environment identity: TenantId, or Environment object.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false
-DiscoveryDeltaTimestamp <DateTime>
Limits the scope of the discovery to objects changed after the DiscoveryDeltaTimestamp.
Required? false Position? named Default value 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
Inputs
System.Object
Identity: TenantID or Environment object.
Outputs
---------- Example 1 ----------
Get-BTEnvironment -Filter "TenantName -eq 'BTCloud1'" | Start-BTDiscovery
Start-BTDiscovery -Identity 1869
Start Discovery process for the specified environments.
---------- Example 2 ----------
Start-BTDiscovery -Identity 1869 -DiscoveryDeltaTimestamp "6/17/2020 4:45:46 PM"
Start Discovery process for the specified environment with DiscoveryDeltaTimestamp set.
Start Prepare operations for Power365 Users.
Syntax
Start-BTPrepare -User <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Start-BTPrepare -Wave <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Start-BTPrepare [-InputObject] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Description
Start-BTPrepare -User starts a Prepare operation for a User.
Start-BTPrepare -Wave starts a Prepare operation for a Wave.
Start-BTPrepare -InputObject starts a Prepare operation for a User or Wave.
The ApiKey role must be 'Writer' to run the Start-BTPrepare cmdlet.
Parameters
-User <object>
User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.
Required? true Position? named Default value Accept pipeline input? false Accept wildcard characters? false
-Wave <object>
Wave identity: WaveId, WaveName, or Wave object.
Required? true Position? named Default value Accept pipeline input? false Accept wildcard characters? false
-InputObject <object>
The User or Wave 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
-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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
The User or Wave object.
Outputs
---------- Example 1 ----------
Start-BTPrepare -User 356
Start-BTPrepare -User joe@contoso.com
Start-BTPrepare -User $user
Starts a Prepare for a User by id, identity, or User object.
---------- Example 2 ----------
Start-BTPrepare -Wave 356
Start-BTPrepare -Wave 'My Wave'
Start-BTPrepare -Wave $wave
Starts a Prepare for a Wave by id, identity, or Wave object.
---------- Example 3 ----------
$usersOrWaves | Start-BTPrepare
Starts a Prepare for each input object, which can be a User or a Wave object.
Start Sync operations for Power365 Users.
Syntax
Start-BTSync -User <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Start-BTSync -Wave <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Start-BTSync [-InputObject] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Description
Start-BTSync -User starts a Sync operation for a User.
Start-BTSync -Wave starts a Sync operation for a Wave.
Start-BTSync -InputObject starts a Sync operation for a User or Wave.
The ApiKey role must be 'Writer' to run the Start-BTSync cmdlet.
Parameters
-User <object>
User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.
Required? true Position? named Default value Accept pipeline input? false Accept wildcard characters? false
-Wave <object>
Wave identity: WaveId, WaveName, or Wave object.
Required? true Position? named Default value Accept pipeline input? false Accept wildcard characters? false
-InputObject <object>
The User or Wave 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
-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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
The User or Wave object.
Outputs
---------- Example 1 ----------
Start-BTSync -User 356
Start-BTSync -User joe@contoso.com
Start-BTSync -User $user
Starts a Sync for a User by id, identity, or User object.
---------- Example 2 ----------
Start-BTSync -Wave 356
Start-BTSync -Wave 'My Wave'
Start-BTSync -Wave $wave
Starts a Sync for a Wave by id, identity, or Wave object.
---------- Example 3 ----------
$usersOrWaves | Start-BTSync
Starts a Sync for each input object, which can be a User or a Wave object.
Start a Power365 Workflow.
Syntax
Start-BTWorkflow [-Identity] <object> [-Session <Session>] [<CommonParameters>]
Description
The Start-BTWorkflow -Identity Workflow (by object or id) cmdlet starts the specified Workflow.
The ApiKey role must be 'Writer' to run the Start-BTWorkflow cmdlet.
Parameters
-Identity <object>
Specifies the identity (as a Workflow object or id) of a Workflow to start.
Required? true Position? 0 Default value Accept pipeline input? true (ByValue) 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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
Specifies the identity (as a Workflow object or id) of a Workflow to start.
Outputs
BinaryTree.Power365.SDK.Workflow
---------- Example 1 ----------
Start-BTWorkflow -Identity 4296
Start a Workflow.
Submit a Cutover message for Power365 Users.
Syntax
Submit-BTCutoverMessage -User <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Submit-BTCutoverMessage [-InputObject] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]
Description
Submit-BTCutoverMessage -User submits a Cutover message for a User.
Submit-BTCutoverMessage -InputObject submits a Cutover message for a User.
The ApiKey role must be 'Writer' to run the Submit-BTCutoverMessage cmdlet.
Parameters
-User <object>
User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.
Required? true Position? named Default value Accept pipeline input? false Accept wildcard characters? false
-InputObject <object>
The 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
-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
- OutVariable
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Inputs
System.Object
The User object.
Outputs
---------- Example 1 ----------
Submit-BTCutoverMessage -User 356
Submit-BTCutoverMessage -User joe@contoso.com
Submit-BTCutoverMessage -User $user
Submits a Cutover message for a User by id, identity, or User object.
---------- Example 2 ----------
$users | Submit-BTCutoverMessage
Submits a Cutover message for each input object, which can be a User object.
Additional Information
Tenant-to-Tenant
Requirements
Basic Migration
Mailboxes
Mailbox Licenses
- For mailbox data migrations, only Exchange Online Licenses that allow MAPI/HTTP are supported.
IMPORTANT: During a mailbox migration, the source and target user accounts will be licensed in Office365 to provide a mailbox to migrate data into. This means your organization will be consuming two Exchange licenses; one in the source tenant, and one in the target tenant for the duration of the mailbox migration. Once the mailbox migration is complete, the source license can be recovered. Please plan appropriately.
Target Mailboxes
- Target Mailboxes must be provisioned in the target Microsoft 365 multi-tenant prior to data migration.
Test Mailbox Accounts
- As a best practice, we suggest at least 5 populated source Mailboxes for migration testing & validation purposes. Include some sample email messages, some contacts, and some calendar entries.
Source & Target Mailbox Delegation
- The required service account must be granted the Full Access permission to their respective tenant mailboxes to allow a delegate to open the mailbox and behave as the mailbox owner. This will be automatically executed by the Power365 systems during the first synchronization.
- The ApplicationImpersonation role is required for the Global Admin to allow hidden email messages used by the system to be sent.
Source & Target User Mappings
- You will need create and upload a spreadsheet of all source users (in scope for migration) matched to all target users using the UPN (UserPrincipalName).
This spreadsheet has four columns, the source UPN, the target UPN, and, optionally, but recommended, the migration wave and profile name columns. A migration wave is a way to group many mailboxes into smaller collections so you take administrative actions against them instead of all users. Profiles are used to select the type and date ranges of data to be migrated. During the configuration, we will provide a template that you can download.
On-Premises Migration
Power365 offers migration to/from on-premise Exchange environments with the following additional requirements:
Exchange Server 2013 must be patched to at least Cumulative Update CU17 or later.
Exchange Server 2016 must be patched to at least Cumulative Update CU7 or later.
An on-premise Exchange account with the Organizational Management role.
A Remote Powershell endpoint configured with Basic Authentication. Firewall Port 443 must be open.
More information can be found here:
https://technet.microsoft.com/en-us/library/dd335083(v=exchg.150).aspx
https://technet.microsoft.com/en-us/library/dd335083%28v=exchg.160%29.aspx
An EWS Endpoint - We rely on Autodiscover to provide the correct External URL to connect to.
More information can be found here:
https://technet.microsoft.com/en-us/library/mt595787(v=exchg.150).aspx
MAPI/HTTP must be configured.
More information can be found here:
https://technet.microsoft.com/en-us/library/mt634322%28v=exchg.160%29.aspx