次の方法で共有


Microsoft 365 コピーおよび移動 API (CreateCopyJobs)

重要

SharePoint と OneDrive のコピーおよび移動 API は、CreateCopyJobAPI に代わるものです。 CreateCopyJobAPI は非推奨になりました。

次の API は、SharePoint クライアント側オブジェクト モデル (CSOM) の使用に基づいています。 ソリューションで CSOM を参照するときは、NuGet パッケージを使用することをお勧めします。

SharePoint Online CSOM パッケージの最新バージョンは、ID Microsoft.SharePointOnline.CSOM を使用して NuGet ライブラリ から見つけることができます。

重要

始める前に、この API の制限 の詳細を説明します。

メソッド

CreateCopyJobs

このメソッドは、SharePoint、OneDrive、または Teams の 1 つのサイトから別のサイトにファイルまたはフォルダーをコピーまたは移動できる新しいコピーまたは移動ジョブを作成します。

構文

public List<SPCopyMigrationInfo> CreateCopyJobs(Uri[] exportObjectUris, Uri destinationUri, SPCopyMigrationOptions options)

パラメーター

パラメーター 説明
exportObjectUris コピーまたは移動するリスト内のファイルまたはフォルダーの URL
destinationUri コピー先の場所の URL。
SPCopyMigrationOptions
public bool IsMoveMode { get; set; }

重要

既定では、これはコピーに設定されています。 移動操作の場合は、このパラメーターを true に設定します。

public bool IgnoreVersionHistory { get; set; }

指定しない場合、バージョン履歴は無視され、コピー先に移動されません。

public bool AllowSchemaMismatch { get; set; }

これにより、ターゲットのスキーマ定義がソース リストと一致しない場合でも、アイテムを移動できます。

public bool AllowSmallerVersionLimitOnDestination { get; set; }

これにより、ターゲット ファイルが以前のバージョンの場合に移動を実行できます。 既定では、データの損失を防ぐために許可されていません。

public SPMigrationNameConflictBehavior NameConflictBehavior { get; set; }

ターゲット サイトで名前の競合が発生した場合、既定では失敗が報告されます。

public bool IncludeItemPermissions { get; set; }

内部の使用のみに予約されています。

public SPMoveAndShareFileInfo MoveAndShareFileInfo { get; set; }

内部使用専用に予約済みです。

public bool BypassSharedLock { get; set; }

これは、共有ロックを含むファイルを移動ジョブで移動できるかどうかを示します。 ロックされているファイルを移動する場合は、これを設定する必要があります。

public string[] ClientEtags { get; set; }

設定されていて、ソース eTag が指定した eTag と一致しない場合は、コピーと移動は行われません。 NULL のままにした場合、チェックは行われません。

public bool MoveButKeepSource { get; set; }

一度設定すると、この移動操作はコピーと同様になります。 ファイルはコピー先に移動しますが、ソース コンテンツは削除されません。 設定されている場合は、これによりバージョン履歴を含むコピーを作成し、元のメタデータを保持します。 最後にソース アイテムが削除されることはありません。

注:

これは、最新のメジャー バージョンのみをコピーし、すべてのメタデータを保持しない通常のコピーとは異なります。

public bool ExcludeChildren { get; set; }

この操作では、URL のルート レベルのフォルダーのみがコピーされます。 フォルダー内のサブフォルダーまたはファイルは、移動またはコピーされません。

出力

出力パラメーター 説明
JobID/GUID この非同期読み取りに関連付けられた一意のジョブ ID が返されます
SourceListItemUniqueIds ソースを返す
JobQueueUri コピーおよび移動プロセスの通知を返す際に使用される Azure キューにアクセスするための URL
EncryptionKey ジョブ/マニフェスト キューからのメッセージを復号化するために使用される AES256CBC 暗号化キー
public Uri JobQueueUri { get; set; }

レポート機能は、CreateMigrationJob の場合と同じです。 ログは createCopyJobs の状態を追跡します。 既定では、BLOB キューのアクセス許可と設定は "すべてのアクセス" に設定されています。 ジョブの状態は、ジョブの開始、ジョブの終了、およびジョブのエラー情報として表示されます。

制限事項

現在、次の制限があります:

内容 制限
ファイルのサイズ SharePoint の制限
アイテムの数 SharePoint の制限
ジョブの合計サイズ SharePoint の制限