[Index]

Model: device/exchangeonline/MoveRequest

Model Details: device/exchangeonline/MoveRequest

Title Description Details
RecipientType
  • Field Name: RecipientType
  • Type: String
RemoteTargetDatabase The RemoteTargetDatabase parameter specifies the name of the target database in the remote forest. Use this parameter when moving mailboxes from the local forest to a remote forest. For moves from a remote forest to the local forest, use the TargetDatabase parameter. If you use this parameter, you must specify the Remote or RemoteLegacy parameter.
  • Field Name: RemoteTargetDatabase
  • Type: String
RemoteArchiveTargetDatabase The RemoteArchiveTargetDatabase parameter specifies the name of the target database in the remote forest to which you're moving the personal archive. Use this parameter when moving users with archives from the local forest to a remote forest. For moves from a remote forest to the local forest, use the ArchiveTargetDatabase parameter. If you use this parameter, you must specify the Remote or RemoteLegacy parameter.
  • Field Name: RemoteArchiveTargetDatabase
  • Type: String
Outbound The Outbound switch specifies that this mailbox move is a cross-forest move and is being initiated from the source forest. You don't have to specify a value with this parameter. You can't use this parameter in conjunction with the Remote switch.
  • Field Name: Outbound
  • Type: Boolean
InternalFlags This parameter is available only in on-premises Exchange 2016. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes.
  • Field Name: InternalFlags
  • Type: String
RecipientTypeDetails
  • Field Name: RecipientTypeDetails
  • Type: String
OrganizationId
  • Field Name: OrganizationId
  • Type: String
SourceEndpoint PARAMVALUE: MigrationEndpointIdParameter
  • Field Name: SourceEndpoint
  • Type: String
ProxyToMailbox PARAMVALUE: MailboxIdParameter
  • Field Name: ProxyToMailbox
  • Type: String
TargetDatabase This parameter is available only in on-premises Exchange 2016. The TargetDatabase parameter specifies the identity of the database that you're moving the mailbox to. If you don't use this parameter, the automatic distribution logic will select a random database from the Active Directory site where you are running the command. You can use the following values: GUID of the database Database name
  • Field Name: TargetDatabase
  • Type: String
Status
  • Field Name: Status
  • Type: String
Priority This parameter is available only in on-premises Exchange 2016. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: Lowest Lower Low Normal This is the default value. High Higher Highest Emergency
  • Field Name: Priority
  • Type: String
RemoteCredential The RemoteCredential parameter specifies an administrator who has permission to perform the mailbox move, for example, [email protected]. This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (http://go.microsoft.com/fwlink/p/?linkId=142122).
  • Field Name: RemoteCredential
  • Type: String
ForceOffline The ForceOffline parameter forces a mailbox move to be performed in offline mode. Moving a mailbox in offline mode means the user will have no access to email during the mailbox move.
  • Field Name: ForceOffline
  • Type: Boolean
OriginatingServer
  • Field Name: OriginatingServer
  • Type: String
MoveOptions PARAMVALUE: MultiValuedProperty
  • Field Name: MoveOptions.[n]
  • Type: Array
DoNotPreserveMailboxSignature This parameter is available only in on-premises Exchange 2016. The DoNotPreserveMailboxSignature parameter specifies that the command doesn't preserve the mailbox mapping signature. We recommend that you use this parameter only if the move request fails because the Named Property identifiers are depleted. If you specify this parameter, the mailbox user is required to restart Microsoft Outlook when the move request is complete.
  • Field Name: DoNotPreserveMailboxSignature
  • Type: Boolean
ObjectState
  • Field Name: ObjectState
  • Type: String
CompletedRequestAgeLimit The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days.
  • Field Name: CompletedRequestAgeLimit
  • Type: String
ForcePush This parameter is available only in on-premises Exchange 2016. The ForcePush parameter specifies that the type of move should be a Push move. This parameter can be used for local moves only.
  • Field Name: ForcePush
  • Type: Boolean
ExtensionCustomAttribute4
  • Field Name: ExtensionCustomAttribute4.[n]
  • Type: Array
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
Name
  • Field Name: Name
  • Type: String
BatchName The BatchName parameter specifies a descriptive name for moving a batch of mailboxes. You can then use the name in the BatchName parameter as a search string when you use the Get-MoveRequest cmdlet.
  • Field Name: BatchName
  • Type: String
Direction
  • Field Name: Direction
  • Type: String
PrimaryOnly The PrimaryOnly switch specifies that the command should only move the primary mailbox; the personal archive isn't moved. You don't have to specify a value with this switch. You use this switch only if the user has a personal archive that you don't want to move. If the user doesn't have personal archive, don't use this switch. You can't use this parameter in conjunction with the ArchiveOnly parameter.
  • Field Name: PrimaryOnly
  • Type: Boolean
MigrationMailbox PARAMVALUE: MailboxIdParameter
  • Field Name: MigrationMailbox
  • Type: String
CheckInitialProvisioningSetting The CheckInitialProvisioningSetting switch specifies that the move request checks the IsExcludedFromProvisioning setting on the target database when you don't specify a target database for the move. You don't need to specify a value with this switch. The IsExcludedFromProvisioning setting allows the database to be excluded from provisioning new mailboxes.
  • Field Name: CheckInitialProvisioningSetting
  • Type: Boolean
RemoteGlobalCatalog The RemoteGlobalCatalog parameter specifies the fully qualified domain name (FQDN) of the global catalog server for the remote forest.
  • Field Name: RemoteGlobalCatalog
  • Type: String
StartAfter The StartAfter parameter specifies a delay before the request is started. The request isn't started until the date/time you specify with this parameter. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM". In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter in Exchange Online, use either of the following options: Specify the date/time value in UTC For example, "2016-05-06 14:30:00z". Specify the date/time value as a formula that converts the date/time in your local time zone to UTC For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (http://go.microsoft.com/fwlink/p/?LinkID=113313).
  • Field Name: StartAfter
  • Type: String
  • Format: date-time
IncrementalSyncInterval The IncrementalSyncInterval parameter specifies the wait time between incremental syncs. This parameter is used together with the CompleteAfter parameter to create a move request that will do periodic incremental syncs after the initial sync is complete. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. Valid values are from 00:00:00 to 120.00:00:00 (120 days). The default value is 24 hours.
  • Field Name: IncrementalSyncInterval
  • Type: String
ExtensionCustomAttribute1
  • Field Name: ExtensionCustomAttribute1.[n]
  • Type: Array
ArchiveDomain The ArchiveDomain parameter specifies the FQDN of the external domain to which you're moving the archive. This parameter is used for moving the archive to a cloud-based service.
  • Field Name: ArchiveDomain
  • Type: String
SourceArchiveDatabase
  • Field Name: SourceArchiveDatabase
  • Type: String
ExtensionCustomAttribute5
  • Field Name: ExtensionCustomAttribute5.[n]
  • Type: Array
WorkloadType This parameter is available only in on-premises Exchange 2016. The WorkloadType parameter is reserved for internal Microsoft use.
  • Field Name: WorkloadType
  • Type: String
AdministrativeUnits
  • Field Name: AdministrativeUnits.[n]
  • Type: Array
LargeItemLimit The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: Exchange 2016 Understanding message size limits Exchange Online Exchange Online Limits (http://go.microsoft.com/fwlink/p/?LinkId=524926) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail.
  • Field Name: LargeItemLimit
  • Type: String
RequestExpiryInterval The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. If the request fails, you need to manually remove it by using the corresponding Remove-*Request cmdlet. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. When you use the value Unlimited, the completed request isn't automatically removed.
  • Field Name: RequestExpiryInterval
  • Type: String
PreventCompletion The PreventCompletion switch specifies whether to run the move request, but not allow it to complete. Instead of this switch, we recommend using the CompleteAfter parameter.
  • Field Name: PreventCompletion
  • Type: Boolean
ArchiveTargetDatabase This parameter is available only in on-premises Exchange 2016. The ArchiveTargetDatabase parameter specifies the Exchange target database to which you're moving the personal archive. If this parameter isn't specified, the archive is moved to the same database as the primary mailbox. You can use the following values for this parameter: GUID of the database Database name
  • Field Name: ArchiveTargetDatabase
  • Type: String
IsOffline
  • Field Name: IsOffline
  • Type: Boolean
SuspendComment The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter.
  • Field Name: SuspendComment
  • Type: String
Identity The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: GUID Distinguished name (DN) Domain\Account User principal name (UPN) LegacyExchangeDN SMTP address Alias
  • Field Name: Identity
  • Type: String
RemoteOrganizationName This parameter is reserved for internal Microsoft use.
  • Field Name: RemoteOrganizationName
  • Type: String
BadItemLimit The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail.
  • Field Name: BadItemLimit
  • Type: String
Protect This parameter is reserved for internal Microsoft use.
  • Field Name: Protect
  • Type: Boolean
TargetDeliveryDomain The TargetDeliveryDomain parameter specifies the FQDN of the external email address created in the source forest for the mail-enabled user when the move request is complete. This parameter is allowed only when performing remote moves with the Remote or RemoteLegacy parameter.
  • Field Name: TargetDeliveryDomain
  • Type: String
Remote The Remote switch specifies that the move you're initiating is outside of your organization, and that this move is being initiated from the target forest. You don't have to specify a value with this parameter. You can't use this parameter in conjunction with the Outbound switch.
  • Field Name: Remote
  • Type: String
IgnoreTenantMigrationPolicies PARAMVALUE: SwitchParameter
  • Field Name: IgnoreTenantMigrationPolicies
  • Type: Boolean
SourceDatabase This parameter is available only in on-premises Exchange 2016. The SourceDatabase parameter specifies that all mailboxes being moved from the specified source database are returned. You can use the following values: GUID of the database Database name You can't use this parameter with the Identity parameter.
  • Field Name: SourceDatabase
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
RemoteHostName The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox.
  • Field Name: RemoteHostName
  • Type: String
ExchangeGuid
  • Field Name: ExchangeGuid
  • Type: String
Alias
  • Field Name: Alias
  • Type: String
ArchiveOnly The ArchiveOnly parameter specifies that you're moving only the personal archive associated with the mailbox. You can't use this parameter in conjunction with the PrimaryOnly parameter.
  • Field Name: ArchiveOnly
  • Type: Boolean
Flags The Flags parameter specifies the move type to retrieve information for. The following values may be used: CrossOrg HighPriority IntraOrg Join MoveOnlyArchiveMailbox MoveOnlyPrimaryMailbox None Offline Protected Pull Push RemoteLegacy Split Suspend SuspendWhenReadyToComplete TargetIsAggregatedMailbox
  • Field Name: Flags
  • Type: String
LastExchangeChangedTime
  • Field Name: LastExchangeChangedTime
  • Type: String
SkipMoving The SkipMoving parameter allows certain stages of a mailbox move to be skipped for debugging purposes. Don't use this parameter unless directed to do so by a support professional or specific documentation.
  • Field Name: SkipMoving
  • Type: String
ExchangeVersion
  • Field Name: ExchangeVersion
  • Type: String
PSComputerName
  • Field Name: PSComputerName
  • Type: String
ForcePull This parameter is available only in on-premises Exchange 2016. The ForcePull parameter specifies that the type of move should be a Pull move. This parameter can be used for local moves only.
  • Field Name: ForcePull
  • Type: Boolean
ExternalDirectoryObjectId
  • Field Name: ExternalDirectoryObjectId
  • Type: String
AllowLargeItems This parameter is available only in on-premises Exchange 2016. The AllowLargeItems switch specifies that items larger than the target mailbox limits are copied without failure. You can't use the AllowLargeItems switch and the LargeItemLimit parameter together in the same command.
  • Field Name: AllowLargeItems
  • Type: Boolean
DomainController This parameter is available only in on-premises Exchange 2016. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
  • Field Name: DomainController
  • Type: String
TargetArchiveDatabase
  • Field Name: TargetArchiveDatabase
  • Type: String
CompleteAfter The CompleteAfter parameter specifies a delay before the request is completed. The request is started, but not completed until the date/time you specify with this parameter. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM". In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter in Exchange Online, use either of the following options: Specify the date/time value in UTC For example, "2016-05-06 14:30:00z". Specify the date/time value as a formula that converts the date/time in your local time zone to UTC For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (http://go.microsoft.com/fwlink/p/?LinkID=113313).
  • Field Name: CompleteAfter
  • Type: String
  • Format: date-time
IsValid
  • Field Name: IsValid
  • Type: Boolean
RemoteLegacy This parameter is available only in on-premises Exchange 2016. The RemoteLegacy switch specifies that this mailbox move is from a remote forest that has only Exchange 2010 servers installed. You don't need to specify a value with this switch.
  • Field Name: RemoteLegacy
  • Type: String
DistinguishedName
  • Field Name: DistinguishedName
  • Type: String
Suspend The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch.
  • Field Name: Suspend
  • Type: Boolean
ExtensionCustomAttribute3
  • Field Name: ExtensionCustomAttribute3.[n]
  • Type: Array
DisplayName
  • Field Name: DisplayName
  • Type: String
AcceptLargeDataLoss The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail.
  • Field Name: AcceptLargeDataLoss
  • Type: Boolean
SuspendWhenReadyToComplete The SuspendWhenReadyToComplete switch specifies whether to suspend the move request before it reaches the status of CompletionInProgress. Instead of this switch, we recommend that you use the CompleteAfter parameter.
  • Field Name: SuspendWhenReadyToComplete
  • Type: Boolean
ExtensionCustomAttribute2
  • Field Name: ExtensionCustomAttribute2.[n]
  • Type: Array
RequestStyle
  • Field Name: RequestStyle
  • Type: String
Guid
  • Field Name: Guid
  • Type: String
Id
  • Field Name: Id
  • Type: String