Merge pull request MicrosoftDocs#1340 from wenhua-helen/master

Update SPMT PowerShell help documents

Author: kenwith

spmt/spmt-ps/spmt/Add-SPMTTask.md

@@ -1,22 +1,21 @@
 ---
-external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml
+External help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml
 Module Name: Microsoft.SharePoint.MigrationTool.PowerShell
-applicable: SharePoint Migration Tool
-title: Add-SPMTTask
-online version: 
-schema: 2.0.0
+Applicable: SharePoint Migration Tool
+Title: Add-SPMTTask
+Online version: 
+Schema: 2.0.0
 ---
 
 # Add-SPMTTask
 
 ## SYNOPSIS
-Add a new migration task to the registered migration session. Currently there are three different types of tasks allowed: File share task, SharePoint task and a JSON defined task.  
+Add a new migration task to the registered migration session. Currently there are three different types of tasks allowed: File Share task, SharePoint task and JSON defined task.  
 ## SYNTAX
 
 ### FileShare
 ```
-Add-SPMTTask -FileShareSource <String> -TargetSiteUrl <String> -TargetList <String>
- [-TargetListRelativePath <String>]
+Add-SPMTTask -FileShareSource <String> -TargetSiteUrl <String> -TargetList <String> [-TargetListRelativePath <String>]
 ```
 ### SharePointMigrateAll
 ``` 
@@ -25,37 +24,38 @@ Add-SPMTTask -SharePointSourceCredential <PSCredential> -SharePointSourceSiteUrl
 
 ### SharePointMigrateSelected
 ```
- Add-SPMTTask -SharePointSourceSiteUrl <string> -SharePointSourceCredential <pscredential> -SourceList <string> [-SourceListRelativePath <string>] -TargetSiteUrl <string> -TargetList <string> [-TargetListRelativePath <string>]
+ Add-SPMTTask -SharePointSourceSiteUrl <string> -SharePointSourceCredential <PSCredential> -SourceList <string> [-SourceListRelativePath <string>] -TargetSiteUrl <string> -TargetList <string> [-TargetListRelativePath <string>]
 ```
 
 ### Json
 ```
-Add-SPMTTask [-JsonDefinition <string>] 
-Add-SPMTTask -SharePointSourceCredential <PSCredential> [-JsonDefinition <string>]   
-Json defined migration task sample 1:
-Customer scenario:migrate data from File Share or local disk to SPO. 
+Add-SPMTTask [-JsonDefinition <string>] # This cmdlet is for File Share migration
+
+Add-SPMTTask -SharePointSourceCredential <PSCredential> [-JsonDefinition <string>] # This cmdlet is for SharePoint migration
+
+Json sample for File Share migration:
+{
+   "SourcePath":"\\LocalOrFileShareDataSource",
+   "TargetPath":"https://YourTargetSite",
+   "TargetList":"Documents",
+   "TargetListRelativePath":"subfolder"
+}
+
+Json sample for SharePoint migration(lists only): 
 {
-"SourcePath":"\\LocalOrFileShareDataSource",
-         "TargetPath":"https://YourTargetSite",
-         "TargetList":"Documents",
-         "TargetListRelativePath":"subfolder"
-      }
-Json defined migration task sample 2:
-Customer scenario:migrate on-prem site to SPO site.  
-{  
    "SourcePath":"http://YourOnPremSite",
    "TargetPath":"https://YourTargetSite",
-   "Items":{  
-      "Lists":[  
-         {  
+   "Items":{
+      "Lists":[
+         {
             "SourceList":"sourceListName",
             "TargetList":"targetListName"
-         }
+         } 
       ]
    }
 }
-Json defined migration task sample 3:
-Customer scenario:migrate on-prem sites with subsites to SPO. 
+
+Json sample for SharePoint migration(lists and subsites):
 {  
    "SourcePath":"http://YourOnPremSite",
    "TargetPath":"https://YourTargetSite",
@@ -84,23 +84,23 @@ Customer scenario:migrate on-prem sites with subsites to SPO.
       ]
    }
 }
-Json defined migration task sample 4:
-Customer scenario:migrate on-prem subsite to SPO subsite. 
-{  
-         "SourcePath":"http://youronpremsite/subsite2",
-         "TargetPath":"https://yourtargetsite/targetSubSite2"
-      }
+
+Json sample for SharePoint migration(whole site):
+{
+   "SourcePath":"http://youronpremsite/subsite2",
+   "TargetPath":"https://yourtargetsite/targetSubSite2"
+}
 ```
 
 ## DESCRIPTION
 Add a new migration task to the registered migration session. 
-Currently there are three different types of tasks allowed: File share task, SharePoint task and a JSON defined task. 
+Currently there are three different types of tasks allowed: File Share task, SharePoint task and JSON defined task. 
 
 ## EXAMPLES
 
 ### Example 1
 ```
-#Define On-prem SharePoint 2013 data source#
+#Define SharePoint 2013 data source#
 
 $Global:SourceSiteUrl = "http://YourOnPremSite/"
 $Global:OnPremUserName = "Yourcomputer\administrator"
@@ -116,23 +116,25 @@ $Global:PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText
 $Global:SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:UserName, $Global:PassWord
 $Global:TargetListName = "TargetListName"
 
-#Define  Fileshare data source#
+#Define File Share data source#
 $Global:FileshareSource = "YourFileShareDataSource"
+
 #Import SPMT Migration Module#
 Import-Module Microsoft.SharePoint.MigrationTool.PowerShell
+
 #Register the SPMT session with SPO credentials#
 Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force 
-#Add two tasks into the session. One on-prem and one file share task.#
+
+#Add two tasks into the session. One is SharePoint migration task, and another is File Share migration task.#
 Add-SPMTTask -SharePointSourceCredential $Global:SPCredential -SharePointSourceSiteUrl $Global:SourceSiteUrl  -TargetSiteUrl $Global:SPOUrl -MigrateAll 
-Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList "Documents"
+Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList $Global:TargetListName
 ```
-
-Add one file share migration task and one on-prem 2013 migration task to registered migration session. 
+Add one File Share migration task and one SharePoint 2013 migration task to the registered migration session. 
 
 ## PARAMETERS
 
 ### -FileShareSource
-This parameter is mandatory for file share migration. Please specify the source folder path. For example: C:\SourceFiles.
+This parameter is mandatory for File Share migration. Please specify the source folder path. For example: C:\SourceFiles.
 
 ```yaml
 Type: String
@@ -176,8 +178,8 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -SharePointSourceCredential
-This is a switch parameter. If set to True, all lists will be migrated. If set to False, the customer will migrate selected lists. 
+### -SharePointSourceCredential 
+Use this parameter to define SharePoint 2013 sign-in credentials.     
 
 ```yaml
 Type: PSCredential
@@ -219,7 +221,7 @@ Accept wildcard characters: False
 ```
 
 ### -SourceList
-This parameter is mandatory and defines source document library name or list name.
+This parameter is mandatory and is to define source document library name or list name.
 
 ```yaml
 Type: String
@@ -234,7 +236,7 @@ Accept wildcard characters: False
 ```
 
 ### -SourceListRelativePath
-This parameter is optional and is to define one or more migration data source relative paths. 
+This parameter is optional and is to define data source relative path. 
 
 ```yaml
 Type: String
@@ -249,7 +251,7 @@ Accept wildcard characters: False
 ```
 
 ### -TargetList
-This parameter is mandatory and defines target library name or list name.
+This parameter is mandatory and is to define target library name or list name.
 
 ```yaml
 Type: String
@@ -264,8 +266,7 @@ Accept wildcard characters: False
 ```
 
 ### -TargetListRelativePath
-This parameter is optional. You can define one or more target relative paths in a list and make the value to this parameter. 
-
+This parameter is optional and is to define target relative path. 
 ```yaml
 Type: String
 Parameter Sets: FileShare, SharePointMigrateSelected
@@ -279,7 +280,7 @@ Accept wildcard characters: False
 ```
 
 ### -TargetSiteUrl
-This parameter is mandatory for both file share and on-prem migration and defines the target site URL.
+This parameter is mandatory for both File Share and SharePoint migration and is to define the target site URL.
 
 ```yaml
 Type: String
@@ -305,4 +306,3 @@ Accept wildcard characters: False
 ## NOTES
 
 ## RELATED LINKS
-

spmt/spmt-ps/spmt/Get-SPMTMigration.md

@@ -1,25 +1,27 @@
 ---
-external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml
+External help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml
 Module Name: Microsoft.SharePoint.MigrationTool.PowerShell
-applicable: SharePoint Migration Tool
-title: Get-SPMTMigration
-online version: 
-schema: 2.0.0
+Applicable: SharePoint Migration Tool
+Title: Get-SPMTMigration
+Online version: 
+Schema: 2.0.0
 ---
 
 # Get-SPMTMigration
 
 ## SYNOPSIS
-Return object of current session. It includes current tasks status and current session level settings.  
+Return the object of current session. It includes current tasks status and current session level settings.  
 The status of current tasks includes
 1. Count of scanned files 
 2. Count of migrated files
-3. Migration error message if there is any. 
+3. Migration error message if there is any.
+
+   ...... 
 
 ## SYNTAX
 
 ```
-
+Get-SPMTMigration
 ```
 
 ## DESCRIPTION
@@ -28,8 +30,7 @@ Return object of current session. It includes current tasks status and current s
 
 ### Example 1
 ```
-#Define On-prem SharePoint 2013 data source#
-
+#Define SharePoint 2013 data source#
 $Global:SourceSiteUrl = "http://YourOnPremSite/"
 $Global:OnPremUserName = "Yourcomputer\administrator"
 $Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force 
@@ -44,20 +45,26 @@ $Global:PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText
 $Global:SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:UserName, $Global:PassWord
 $Global:TargetListName = "TargetListName"
 
-#Define  Fileshare data source#
+#Define Fileshare data source#
 $Global:FileshareSource = "YourFileShareDataSource"
+
 #Import SPMT Migration Module#
 Import-Module Microsoft.SharePoint.MigrationTool.PowerShell
+
 #Register the SPMT session with SPO credentials#
 Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force 
-#Add two tasks into the session. One on-prem and one file share task.#
+
+#Add two tasks into the session. One is SharePoint migration task, and another is File Share migration task.#
 Add-SPMTTask -SharePointSourceCredential $Global:SPCredential -SharePointSourceSiteUrl $Global:SourceSiteUrl  -TargetSiteUrl $Global:SPOUrl -MigrateAll 
-Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList "Documents"
-#Start Migration#
-Start-SPMTMigration
- PS C:\Users\YourUserName> Get-SPMTMigration 
+Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList $Global:TargetListName
+
+#Start migration in the background#
+Start-SPMTMigration -NoShow
+
+#Get the object of current migration#
+$session = Get-SPMTMigration 
 ```
-Start a migration first, and then run "Get-SPMTMigration" to get current tasks status and session level settings
+Start a migration first, and then run "Get-SPMTMigration" to get the object of current migration. 
 
 ## PARAMETERS
 
@@ -74,3 +81,4 @@ Start a migration first, and then run "Get-SPMTMigration" to get current tasks s
 
 ## RELATED LINKS
 
+

spmt/spmt-ps/spmt/Register-SPMTMigration.md

@@ -1,43 +1,45 @@
 ---
-external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml
+External help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml
 Module Name: Microsoft.SharePoint.MigrationTool.PowerShell
-applicable: SharePoint Migration Tool
-title: Register-SPMTMigration
-online version: 
-schema: 2.0.0
+Applicable: SharePoint Migration Tool
+Title: Register-SPMTMigration
+Online version: 
+Schema: 2.0.0
 ---
 
 # Register-SPMTMigration
 
 ## SYNOPSIS
-This cmdlet will create a SPMT migration session and initialization. The initialization includes configuring migration settings at session level and connecting to SPO. If no specific setting parameters are defined, default settings will be used. 
-After a session is registered, the Administrator can add a migration task to the SPMT session and start migration.
+This cmdlet will create a migration session and initialize it. The initialization will configure migration settings at session level. If no specific setting parameters are defined, default settings will be used. 
+After a session is registered, the user can add a migration task to the migration session and start migration.
 ## SYNTAX
 
 ```
 Register-SPMTMigration [-Credentials <PSCredential>][-Incremental <bool>]  [-ScanOnly <bool>][-MigrateFilesAndFoldersWithInvalidChars <bool>][-AzureActiveDirectoryLookup <bool>] [-CustomAzureAccessKey <string>] [-CustomAzureStorageAccount <bool>] [-DeleteTempFilesWhenMigrationDone <bool>] [-EnableEncryption <bool>] [-KeepAllVersions <bool>] [-MigrateFileVersionHistory <bool>] [-MigrateOneNoteFolderAsOneNoteNoteBook <bool>] [-MigrateFilesCreatedAfter <DateTime>] [-MigrateFilesModifiedAfter <DateTime>] [-SkipFilesWithExtensions <string>] [-MigrateHiddenFiles <bool>] [-NumberOfVersionToKeep <int>] [-PreserveUserPermissionsForFileShare <bool>] [-PreserveUserPermissionsForForSharePointSource <bool>][-SkipListWithAudienceTargetingEnabled <bool>] [-StartMigrationAutomaticallyWhenNoScanIssue <bool>] [-UseCustomAzureStorage <bool>] [-UserMappingFile <string>] [-WorkingFolder <string>] -Force
 ```
 
 ## DESCRIPTION
-This cmdlet will create a SPMT migration session and initialization. The initialization includes configuring migration settings at session level and connecting to SPO. If no specific setting parameters are defined, default settings will be used. 
-After a session is registered, the Administrator can add a migration task to the SPMT session and start migration.
+This cmdlet will create a migration session and initialize it. The initialization will configure migration settings at session level. If no specific setting parameters are defined, default settings will be used. 
+After a session is registered, the user can add a migration task to the migration session and start migration.
 
 ## EXAMPLES
 
-### Create a SPMT migration session and connecting to SPO. 
+### Create a migration session and connecting to SPO. 
 ```
 #Define SPO target#
 $Global:SPOUrl = “https://contoso.sharepoint.com”
 $Global:UserName = “[email protected]”
 $Global:PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force
 $Global:SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:UserName, $Global:PassWord
 
+#Import SPMT Migration Module#
 Import-Module Microsoft.SharePoint.MigrationTool.PowerShell
+
 #Register the SPMT session with SPO credentials#
 Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force
 ```
 
-Create a SPMT migration session and connecting to SPO
+Create a migration session.
 
 ## PARAMETERS
 
@@ -162,7 +164,7 @@ Accept wildcard characters: False
 ```
 
 ### -MigrateFileVersionHistory
-If set to No, only the most recent versions of the file will be migrated. If set to Yes, you can choose whether to keep all versions, or limit it to a specific number. By default, it is set to On. 
+If set to Off, only the most recent versions of the file will be migrated. If set to On, you can choose whether to keep all versions, or limit it to a specific number. By default, it is set to On. 
 
 ```yaml
 Type: Boolean
@@ -205,7 +207,7 @@ Accept wildcard characters: False
 ```
 
 ### -MigrateFilesModifiedAfter
-If you choose to limit what files are to be migrated   based on modified dates, set your values in this section. This may be to limit the number of files migrated or to adhere to overall company governance policy regarding to file retention. The default value is null.
+If you choose to limit what files are to be migrated based on modified dates, set your values in this section. This may be to limit the number of files migrated or to adhere to overall company governance policy regarding to file retention. The default value is null.
 ```yaml
 Type: DateTime
 Parameter Sets:  
@@ -421,4 +423,3 @@ Accept wildcard characters: False
 ## NOTES
 
 ## RELATED LINKS
-