PowerShell を使用して SharePoint に移行する

この記事では、SharePoint 移行ツール (SPMT) 移行エンジンに基づく PowerShell コマンドレットについて説明します。 SharePoint Server オンプレミスのドキュメント ライブラリとリスト アイテム、およびファイル共有から Microsoft 365 にファイルを移動するために使用できます。 SharePoint の移行に関連する現在のすべての PowerShell コマンドレットについては、 Microsoft SharePoint 移行ツール コマンドレット リファレンスを参照してください。

PowerShell コマンドレットは、SharePoint 移行ツールと同じ機能を提供します。

システム要件

最適なパフォーマンスのために推奨される要件

最小要件 (パフォーマンスの低下が予想されます)

長いパスの問題の回避策

SPMT PowerShell を使用すると、パスが 260 文字を超えるソース ファイルでスキャンエラーが発生する場合があります。 この問題を解決するには、システム レジストリを変更して、PowerShell で長いパス ファイルを読み取れるようにします。

レジスタ エディターを開き、["Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework"] に移動し、新しいキー "AppContext"を追加します。 次に、キーの下に 2 つの文字列値を追加します。

• 値の名前: Switch.System.IO.BlockLongPaths 値のデータ: false

• 値の名前: Switch.System.IO.UseLegacyPathHandling 値のデータ: false

始める前に

1. 既存の Active Directory または Microsoft 365 にアカウントを追加するためのその他のオプションのいずれかを使用して、Microsoft 365 を準備します。 詳細については、「Microsoft 365 とオンプレミス環境の統合」および「Microsoft 365 Apps for business にユーザーを追加する」を参照してください。

2. フォルダー ( $env:UserProfile\Documents\WindowsPowerShell\Modules\Microsoft.SharePoint.MigrationTool.PowerShell) を開きます。 その中に DLL があることを確認します。 OneDrive を使用している場合は、WindowsPowershell フォルダーを $env:UserProfile\OneDrive - <Organization Name>\Documents にコピーする必要があります。

3. この場所から、次の PowerShell コマンドを実行します。

   Import-Module Microsoft.SharePoint.MigrationTool.PowerShell
   

移行セッションを作成および初期化する

• Register-SPMTMigration

このコマンドレットは、移行セッションを作成して初期化します。 初期化は、セッション レベルで移行設定を構成します。 特定の設定パラメータが定義されていない場合は、デフォルト設定が使用されます。 セッションが登録されたら、タスクをセッションに追加して移行を開始できます。

移行タスクを追加する

• Add-SPMTTask

このコマンドレットを使用して、登録済みの移行セッションに新しい移行タスクを追加します。 現在、許可されているタスクには、ファイル共有タスク、SharePoint タスク、JSON 定義タスクの 3 種類があります。

注: タスクの重複は許可されていません。

タスクを削除する

• Remove-SPMTTask

このコマンドレットを使用して、登録済みの移行から既存の移行タスクを削除します。

移行を開始する

• Start-SPMTMigration

このコマンドレットは、登録済みの SPMT 移行を開始します。

現在のセッションのオブジェクトを返す

• Get-SPMTMigration

現在のセッションのオブジェクトを返します。 このコマンドレットには、現在のタスクの状態と現在のセッション レベルの設定が含まれます。 現在のタスクのステータスは次のとおりです。

• スキャンされたファイルの数
• 移行されたファイルの数
• 移行エラー メッセージ

現在の移行を停止する

• Stop-SPMTMigration

このコマンドレットは、現在の移行を取り消します。

コンソールに移行状況の詳細を表示する

• Show-SPMTMigration

NoShow モードで移行を開始した場合、Show-SPMTMigration コマンドレットを実行すると、コンソールにタスク ID、データ ソースの場所、ターゲットの場所、移行状態が表示されます。 Ctrl+C キーを選択すると、ディスプレイが NoShow モードに戻ります。

移行セッションを削除する

• Unregister-SPMTMigration

移行セッションを削除するには、このコマンドレットを使用します。

サンプル シナリオ

例 1: IT 管理者は SharePoint オンプレミス タスクを追加し、バックグラウンドで移行を開始します。

#Define SharePoint Server data source#
$SourceSiteUrl = "http://YourOnPremSite/"
$OnPremUserName = "Yourcomputer\administrator"
$OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force
$SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $OnPremUserName, $OnPremPassword
$SourceListName = "SourceListName"

#Define SharePoint target#
$SPOUrl = "https://contoso.sharepoint.com"
$UserName = "admin@contoso.onmicrosoft.com"
$PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force
$SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $UserName, $PassWord
$TargetListName = "TargetListName"

#Define file share data source#
$FileshareSource = "YourFileShareDataSource"

#Import SPMT Migration Module#
Import-Module Microsoft.SharePoint.MigrationTool.PowerShell

#Register the SPMT session with SharePoint credentials#
Register-SPMTMigration -SPOCredential $SPOCredential -Force

#Add two tasks into the session. One is SharePoint migration task, and another is File Share migration task.#
Add-SPMTTask -SharePointSourceCredential $SPCredential -SharePointSourceSiteUrl $SourceSiteUrl  -TargetSiteUrl $SPOUrl -MigrateAll
Add-SPMTTask -FileShareSource $FileshareSource -TargetSiteUrl $SPOUrl -TargetList $TargetListName

#Start Migration in the console. #
Start-SPMTMigration

例 2: IT 管理者は、移行をバックグラウンドの "NoShow モード" からフォアグラウンドに移行し、次のコマンドレットを実行して移行の進行状況がコンソールに表示されるようにしたいと考えています。

Show-SPMTMigration

例 3:IT 管理は、.csv ファイルを読み込んで一括移行を実行したいと思っています。 この例のサンプル ファイルは SPMT.csv です。

#Load CSV#
$csvItems = Import-Csv "C:\spmt.csv" -Header c1,c2,c3,c4,c5,c6
ForEach ($item in $csvItems)
{
    Write-Host $item.c1
    Add-SPMTTask -FileShareSource $item.c1 -TargetSiteUrl $item.c4 -TargetList $item.c5 -TargetListRelativePath $item.c6
}

Spmt のファイルには、2つの移行タスクが定義されています。

D:\MigrationTest\Files\Average_1M\c,,,https://SPOSite.sharepoint.com,Documents,Test
C:\work\Powershell\negative,,,https://SPOSite.sharepoint.com/,Documents,DocLibrary_SubfolderName

1つの JSON ファイルの読み込みでの一括移行のコードスニペット:

#Load JSON:
$jsonItems = Get-Content -Raw -Path  "C:\spmt.json" | ConvertFrom-Json
ForEach ($taskItem in $jsonItems.Tasks)
{
    $jsonString = ConvertTo-Json $taskItem -Depth 100
    Add-SPMTTask -JsonDefinition $jsonString -SharePointSourceCredential $SPCredential
}

Spmt. json のファイルでは、3つの移行タスクが定義されています。

{
   "Tasks":[
      {
         "SourcePath":"http://On-prem/sites/test",
         "TargetPath":"https://YourSPO.sharepoint.com",
         "Items":{
            "Lists":[
               {
                  "SourceList":"list-01",
                  "TargetList":"list-01"
               }
            ],
            "SubSites":[

            ]
         }
      },
      {
         "SourcePath":"http://On-prem/sites/test",
         "TargetPath":"https://YourSPO.sharepoint.com",
         "Items":{
            "Lists":[
               {
                  "SourceList":"list-02",
                  "TargetList":"list-02"
               }
            ],
            "SubSites":[

            ]
         }
      },
      {
         "SourcePath":"http://On-prem/sites/test",
         "TargetPath":"https://YourSPO.sharepoint.com",
         "Items":{
            "Lists":[
               {
                  "SourceList":"doclib-01",
                  "TargetList":"doclib-01"
               }
            ],
            "SubSites":[

            ]
         }
      }
   ]
}

例4: 移行の進行状況を表示します。

これらのサンプルは、移行プロジェクトの進行状況を表示する方法を示しています。 Get-SPMTMigration は現在のセッションのオブジェクトを返します。これには、現在のタスクの状態と現在のセッション レベルの設定が含まれます。

現在のタスクの状態は次のとおりです。

• スキャンされたファイルの数。
• フィルターで除外されたファイルの数。
• 移行されたファイルの数。
• 失敗したファイルの数。
• 現在のタスクの移行の進行状況 (0 ~ 100)。
• 現在のタスクのステータス。
• 移行エラー メッセージ (ある場合)。

# Start migration in the background
Start-SPMTMigration -NoShow

# Get the object of current migration
$session = Get-SPMTMigration

# Query migration status every 5 seconds until migration is finished
while ($session.Status -ne "Finished")
{
Write-Host $session.Status

    # Query migration progress of each tasks
    Foreach ($taskStatus in $session.StatusOfTasks)
    {
        $taskStatus.MigratingProgressPercentage
}

    Start-Sleep -Seconds 5
}