Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
You can use the Get Move Request activity in a runbook to retrieve detailed information for an existing mailbox move request for an on-premises environment.
The following tables list the filters, optional properties, and published data for this activity.
Required properties for Get Move Request activity
This Activity has no required properties.
Filters for Get Move Request activity
| Element | Description | Valid values |
|---|---|---|
| Alias | Mailbox or mail user alias. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Batch Name | Descriptive name for moving a batch of mailboxes. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Direction | Indicates the direction for the move request. It can be one of the following: Push Pull |
Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Display Name | Mailbox display name. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Distinguished Name | Distinguished name for the mailbox. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Exchange GUID | Unique identifier of the Microsoft Exchange installation. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Exchange Version | Version of Microsoft Exchange that this object is associated with. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Extension Custom Attribute 1 | Custom attribute. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Extension Custom Attribute 2 | Custom attribute. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Extension Custom Attribute 3 | Custom attribute. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Extension Custom Attribute 4 | Custom attribute. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Extension Custom Attribute 5 | Custom attribute. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| External Directory Object Id | External directory object ID. | Equals Does not equal Contains Does not contain Matches Does not match Starts with Ends with |
| Flags | Request flags. It can be one of the following: CrossOrg IntraOrg MoveOnlyArchiveMailbox MoveOnlyPrimaryMailbox None Offline Protected Pull Push RemoteLegacy Suspend SuspendWhenReadyToComplete HighPriority |
Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| GUID | Mailbox GUID. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Identity | Identity of the mailbox or mail user. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Is Offline | Indicates if this is an offline move request. | Equals Does not equal |
| Is Valid | Indicates whether the object was configured correctly. | Equals Does not equal |
| Last Exchange Changed Time | Last Exchange Changed Time | Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than |
| Name | Mailbox name. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Needs To Suppress PII | Needs to suppress the Personally Identifiable Information (PII). | Equals Does not equal |
| Organization ID | Organization for this mailbox. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Originating Server | Originates the server. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with pattern |
| Protect | Indicates if this mailbox is moved in protected mode. | Equals Does not equal |
| Recipient Type | Recipient type. It can be one of the following: Computer Contact DynamicDistributionGroup Group Invalid MailContact MailNonUniversalGroup MailUniversalDistributionGroup MailUniversalSecurityGroup MailUser MicrosoftExchange PublicDatabase PublicFolder SystemAttendantMailbox SystemMailbox User UserMailbox |
Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Recipient Type Details | Recipient type details. It can be one of the following: AllUniqueRecipientTypes ArbitrationMailbox Computer Contact DisabledUser DiscoveryMailbox DynamicDistributionGroup EquipmentMailbox LegacyMailbox LinkedMailbox LinkedUser MailboxPlan MailContact MailForestContact MailNonUniversalGroup MailUniversalDistributionGroup MailUniversalSecurityGroup MailUser MicrosoftExchange None NonUniversalGroup PublicFolder RemoteEquipmentMailbox RemoteRoomMailbox RemoteSharedMailbox RemoteUserMailbox RoleGroup RoomList RoomMailbox SharedMailbox SystemAttendantMailbox SystemMailbox UniversalDistributionGroup UniversalSecurityGroup User UserMailbox |
Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Remote Host Name | The fully qualified domain name (FQDN) of the cross-forest organization from which the mailbox is moved. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Request Style | Indicates whether the "move" request is within the same organization or between different organizations. It can be one of the following: IntraOrg CorssOrg |
Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Source Archive Database | Mailbox database where the mailbox archive is being moved from. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Source Database | Mailbox database where the mailbox is being moved from. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Status | Request status. It can be one of the following: AutoSuspended Completed CompletedWithWarning CompletionInProgress Failed InProgress None Queued Suspended |
Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Suspend | Indicates if the request is suspended when queued. | Equals Does not equal |
| Suspend When Ready To Complete | Indicates if the request is suspended before it completes. | Equals Does not equal |
| Target Archive Database | Mailbox database, where the mailbox archive is being moved to. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
| Target Database | Mailbox database, where the mailbox is being moved to. | Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with |
Optional properties for Get Move Request activity
| Element | Description | Valid values |
|---|---|---|
| Batch Name | Descriptive name that is necessary for moving a batch of mailboxes. | String |
| Domain Controller | The fully FQDN of the domain controller that writes this configuration change to the Active Directory. | String |
| Identity | Mailbox identity. | String |
| Offline | Indicates if this is an offline move request. The default value is True, when selected. | True, False |
| Move Status | Specifies to return "move" requests with the specified configured status. Can't be used with Identity property. The Value range is one of the following: Auto Suspended Completed Completed With Warning Completion In Progress Failed In Progress None Queued Suspended Default is blank, when selected. |
AutoSuspended Completed CompletedWithWaring CompletionInProgress Failed InProgress None Queued Suspended |
| Multi Tenant | Specifies that the search should be performed across the entire forest, not just across the organization that's currently scoped. The default value is True, when selected | True, False |
| Organization | Specifies the organization in which the search will be performed. This filter is available for multitenant deployments. It isn't available for on-premises deployments. | String |
| Organizational Unit | Specifies an organizational unit (OU) and is used to limit the results. | String |
| Password | Specifies the password used by the mail user to secure the user account and the associated mailbox in the service. | String |
| Protect | Returns the moved mailboxes in protected mode. Can't be used in conjunction with the Identity property. The default value is True, when selected. |
True, False |
| Remote Host Name | Specifies the FQDN of the cross-forest organization from which the mailbox is moved. Can't be used with the Identity property. |
String |
| Result Size | Specifies the maximum number of results to return. If you want to return all requests that match the query, use 'unlimited' for the value of this property. The default value is 1000. | String |
| Source Database | Mailbox database where the mailbox is being moved from. | String |
| Suspend | Indicates if the request is suspended when queued. The default value is True, when selected. | True, False |
| Suspend When Ready to Complete | Indicates if the request is suspended before it completes. The default is True, when selected. | True, False |
| Target Database | Mailbox database where the mailbox is being moved to. | String |
| User Name | Specifies the user name to use to access the on-premises Active Directory. | String |
Published data for Get Move Request activity
| Element | Description | Value type |
|---|---|---|
| Alias | Mailbox or mail user alias. | String |
| Batch Name | Descriptive name for moving a batch of mailboxes. | String |
| Direction | The move request direction. | String |
| Display Name | Mailbox display name. | String |
| Distinguished Name | Distinguished name for the mailbox. | String |
| Exchange Environment | Indicates the type of Exchange environment where this activity will be executed. | String |
| Exchange GUID | Unique identifier of the Microsoft Exchange installation. | String |
| Exchange PowerShell Application | Specifies the name segment of the connection URI for the application. | String |
| Exchange Server Host | Exchange Server connected. | String |
| Exchange Server Port | Exchange Server port connected. | String |
| Exchange User Name | Username that is used to connect to Exchange Server. | String |
| Exchange Version | Version of Microsoft Exchange that this object is associated with. | String |
| Extension Custom Attribute 1 | Custom attribute. | String |
| Extension Custom Attribute 2 | Custom attribute. | String |
| Extension Custom Attribute 3 | Custom attribute. | String |
| Extension Custom Attribute 4 | Custom attribute. | String |
| Extension Custom Attribute 5 | Custom attribute. | String |
| External Directory Object Id | External Directory Object ID. | String |
| Flags | Request flags. It can be one of the following: CrossOrg IntraOrg MoveOnlyArchiveMailbox MoveOnlyPrimaryMailbox None Offline Protected Pull Push RemoteLegacy Suspend SuspendWhenReadyToComplete |
String |
| GUID | Mailbox GUID. | String |
| Identity | Identity of the mailbox or mail user. | String |
| Is Offline | Indicates if this is an offline "move" request. | String |
| Is Valid | Indicates whether the object was configured correctly. | String |
| Last Exchange Changed Time | Last Exchange Changed Time | DateTime |
| Move Request Count | Number of move requests found. | Number |
| Name | Mailbox name. | String |
| Needs To Suppress PII | Needs to suppress the PII. | String |
| Organization ID | Organization for this mailbox. | String |
| Originating Server | Organization server. | String |
| Protect | Indicates if this mailbox is moved in protected mode. | String |
| Recipient Type | Recipient type. | String |
| Recipient Type Details | Recipient type details. | String |
| Remote Host Name | FQDN of the cross-forest organization from which the mailbox is moved. | String |
| Request Style | Indicates whether the move request is within the same organization or between different organizations. | String |
| Skip CA Check | Indicates whether the client doesn't validate that the server certificate is signed by a trusted certification authority (CA), when connecting through HTTPS. It's used when the Use SSL value is True. | String |
| Skip CN Check | Indicates whether the certificate common name (CN) of the server and the configured hostname of the server aren't checked for being the same. It's used when the Use SSL value is True. | String |
| Skip Revocation Check | Indicates whether the revocation status of the server certificate is to be checked or not. | String |
| Source Archive Database | Mailbox database from which the mailbox archive is moved. | String |
| Source Database | Mailbox database from which the mailbox is moved. | String |
| Status | Request status. It can be one of the following: AutoSuspended Completed CompletedWithWarning CompletionInProgress Failed InProgress None Queued Suspended |
String |
| Suspend | Indicates if the request is suspended when queued. | String |
| Suspend When Ready To Complete | Indicates if the request is suspended before it completes. | String |
| Target Archive Database | Mailbox database where the mailbox archive is being moved to. | String |
| Target Database | Mailbox database where the mailbox is being moved to. | String |
| Use SSL | Indicates whether the communication with the Exchange Server is to be encrypted with SSL. | String |