[Index]

API Reference for view/Exchange_online_MoveRequest_view

. Exchange Mailbox and Unified Messaging Bulk Migration Tool ========================================================== This tool is used to move Mailboxes in Exchange from Microsoft Exchange Server to Microsoft Exchange Online or vice versa. Select the menu option **Bulk Migration Tools > Exchange > Migrate Mailboxes**. Select one of the following Migrate Actions: * Online to On-Prem * On-Prem to Online When the selected Migration Action changes, the users available to be moved is populated as follows: * When the "Online to On-Prem" migrate action is selected, the list of users shows current Exchange Online users (with Exhange Hybid Remote Mailboxes) in the selected hierarchy. * When the "On-Prem to Online" migrate action is selected, the list of users shows current Exchange Mailbox users in the selected hierarchy. The Quick Add Group is used to specify the details of the services activated for the user. The details of the Mailbox and the Unified Messaging Account specified in the templates of the Quick Add Groups is used to update the target Mailbox and UM Mailbox. Logic for determining the Licenses and Service Plans assigned to the user: * **On-prem to online**: The user's existing licenses and enabled service plans are merged with the service plans specified under Exchange in the Quick Add Group selected. * **Online to on-prem**: Service plans related to Exchange Online are removed from the user's existing licenses if present. Quick Add Groups are not taken into account. The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. 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 applicable when performing remote moves with the Remote or RemoteLegacy parameter. When Migrating the User from Microsoft Exchange Online to Microsoft Exchange then the Remote Target Database can be specified. If it is not specified the default value will be derived from the Microsoft Site Defaults. During Quick Add Subscriber operations, the value for the following settings are derived from the VOSS Microsoft Default settings for each site: * Remote Host Name * Target Delivery Domain * Remote Target Database The users that need to be moved can be specified by selecting a list of users (identified by UserPrincipalName) to move. **NOTE**: In order for the the migration to be completed the Multi-stage provisioning workflow needs to be executed to process users in each of the steps in the workflow. The amount of time and frequency with with the multi-stage provisioning workflow needs to be executed is dependant on the size of the migration, the types of licenses used for each user group, the amount of Microsoft Skype Front End Pools, Exchange On-Prem servers and connections to Microsoft Online. Refer to the best practices recommended by VOSS Global Services. Mailbox Migration Workflow -------------------------- There are two types of Migration Workflows supported: * On-prem to Online * Online to On-prem The workflows supports the following steps: * **On-prem to online**: * Move the Mailbox from on-prem to online. * Determine the licenses/service plans to be assigned to the user from the Quick Add Group and existing licenses/service plans of the user. * Update the user's licenses in Microsoft Online portal. * Completion of replication the users' details from Azure AD (i.e. “Get-MsolUser”) to Exchange Online Global Address List (GAL) (i.e. “Get-Recipient”). Replication (forward sync completion) is verified by ensuring that CloudExchangeRecipientDisplayType is not NULL. * Update the user's properties/policies based on the selected quick add group (To be completed). * Delete the Mailbox Move Request. * **Online to on-prem**: * Move the Mailbox from online to on-prem. * Determine the licenses/service plans to be assigned to the user by subtracting service plans related to Exchange Online from the user's existing licenses if present. * Update the user's licenses in Microsoft Online portal. * Delete the Mailbox Move Request. On-Prem to Online Migrations ---------------------------- Migrations involving On-Prem to Online Provisioning is completed in 3 stages: * Stage 1: Provision On-Prem services: * Add Exchange Mailbox * Enable Mailbox for Unified Messaging (UM) * Stage 2: Provision Online services: * Wait for AD FS Dir Sync to sync AD users to MS Online * Sync in MS Online User and move them to the correct site in VOSS Automate * Wait for "forward sync" process to complete. * Move Mailbox Online * Stage 3: Complete the Mailbox Move Request: * Wait for Mailbox Move Request to complete * License User for Exchange Service Plans * According to MS Online Service Plans in QAG * Delete Mailbox Move Request * Update user online mailbox and UM settings according to QAG The Quick Add Subscriber Operation or a Bulk On-Prem to Online Migration Action trigger stage 1. Stage 2 and 3 is completed by executing the scheduled task "MultiStageMSOnlineProvisioning_Schedule". Online to On-Prem Migrations ---------------------------- Migrations involving Online to On-Prem Provisioning is completed in 2 stages: * Stage 1: * Move Mailbox On-Prem * Stage 2: Complete the Mailbox Move Request: * Wait for Mailbox Move Request to complete * De-license User for Exchange Service Plans * Delete Mailbox Move Request * Update user on-prem mailbox and UM settings according to QAG A Bulk Online to On-Prem Migration Action trigger stage 1. Stage 2 is completed by executing the scheduled task "MultiStageMSOnlineProvisioning_Schedule". .. |VOSS-4-UC| replace:: VOSS-4-UC

Model ref.: view/Exchange_online_MoveRequest_view

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

• [hierarchy] is the hierarchy.
  1. as UUID. For example: 6t0ggef2c0deab00hb595101
  2. in dot notation. E.g. ProviderName.CustomerName.LocationName

• [pkid] is the ID of the resource instance. Refer to the List reference below.
• [filename] refers to a file

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "BadItemLimit": {
               "type": "string", 
               "title": "Bad Item Limit"
          }, 
          "RemoteTargetDatabase": {
               "type": "string", 
               "description": "Onprem Database", 
               "title": "Remote Target Database"
          }, 
          "Users": {
               "items": {
                    "type": "string"
               }, 
               "type": "array"
          }, 
          "TargetDeliveryDomain": {
               "type": "string", 
               "description": "Online Tenant where you are moving a user too or from", 
               "title": "Target Delivery Domain"
          }, 
          "RemoteHostName": {
               "type": "string", 
               "description": "The URL of the Exchange MRS i.e. autodiscover.domain.com", 
               "title": "Remote Host Name"
          }, 
          "QAG": {
               "required": true, 
               "type": "string", 
               "description": "This will determine the licenses the user will get.", 
               "title": "Quick Add Group"
          }, 
          "migrate_action": {
               "choices": [
                    {
                         "value": "online_to_onprem", 
                         "title": "Online to On-Prem"
                    }, 
                    {
                         "value": "onprem_to_online", 
                         "title": "On-Prem to Online"
                    }
               ], 
               "required": true, 
               "type": "string", 
               "title": "Migrate Action"
          }, 
          "Identity": {
               "type": "string"
          }
     }, 
     "schema_version": "0.1"
}
    

tool/Transaction/[trans pkid]

{
     "operations": [
          "add", 
          "help", 
          "configuration_template", 
          "field_display_policy", 
          "export_bulkload_template", 
          "transform"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": null, 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/view/Exchange_online_MoveRequest_view/?skip=0&limit=3&order_by=None&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "0.1", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/view/Exchange_online_MoveRequest_view/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/view/Exchange_online_MoveRequest_view/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "tag": {
                         "title": "Tag", 
                         "support_async": true, 
                         "method": "PATCH", 
                         "href": "/api/view/Exchange_online_MoveRequest_view/+tag/?hierarchy=[hierarchy]", 
                         "class": "tag", 
                         "view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "tag_version": {
                         "title": "Tag Version", 
                         "support_async": true, 
                         "method": "PATCH", 
                         "href": "/api/view/Exchange_online_MoveRequest_view/+tag_version/?hierarchy=[hierarchy]", 
                         "class": "tag_version", 
                         "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/view/Exchange_online_MoveRequest_view/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/view/Exchange_online_MoveRequest_view/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/view/Exchange_online_MoveRequest_view/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/view/Exchange_online_MoveRequest_view/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "transform": {
                         "support_async": false, 
                         "class": "transform", 
                         "href": "/api/view/Exchange_online_MoveRequest_view/transform/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Transform Template"
                    }
               }
          ], 
          "model_type": "view/Exchange_online_MoveRequest_view", 
          "model_specific_actions": [
               "add"
          ], 
          "summary_attrs": [
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "21.2", 
          "tagged_versions": []
     }, 
     "resources": []
}

Instance API Reference

• [pkid] is the ID of the resource instance.
• If a payload is required, inspect the schema for payload details.