API копирования и перемещения для Microsoft 365 (CreateCopyJobs)

Важно!

SharePoint и OneDrive Copy и Move API заменяет программный интерфейс CreateCopyJob. Программный интерфейс CreateCopyJob устарел.

Следующий программный интерфейс опирается на опыт использования клиентской объектной модели SharePoint (CSOM). Мы рекомендуем использовать пакеты NuGet, когда вы ссылаетесь на CSOM в вашем решении.

Вы можете найти последнюю версию пакета SharePoint Online CSOM из библиотеки NuGet с помощью идентификатора Microsoft.SharePointOnline.CSOM.

Важно!

Ознакомьтесь с дополнительными сведениями об ограничениях этого программного интерфейса, прежде чем начать.

Метод

CreateCopyJobs

Этот метод создает новое задание копирования или перемещения, которое позволяет копировать или перемещать файл или папку с одного сайта в SharePoint, OneDrive или Teams на другой сайт.

Синтаксис

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, копирование и перемещение не будут выполнены. Если оставить пустое значение, проверка не будет выполняться.

public bool MoveButKeepSource { get; set; }

После настройки эта операция перемещения аналогична копированию. Файл будет перемещен в папку назначения, но исходное содержимое не будет удалено. Если задано, то будет сделана копия с журналом версий и сохранены исходные метаданные. В итоге не произойдет удаления исходных элементов.

Примечание.

Это не похоже на обычную копию, в которой копируется только самая последняя основная версия и не поддерживаются все метаданные.

public bool ExcludeChildren { get; set; }

Для этой операции копируется только папка корневого уровня URL-адреса. Подпапки или файлы в папке не будут перемещены или скопированы.

Выходные данные

Выходные параметры	Описание
JobID/GUID	Возвращает уникальный ИД задания, связанный с этим асинхронным чтением.
SourceListItemUniqueIds	Возврат источника
JobQueueUri	URL-адрес для доступа к очереди Azure, используемой для возвращения уведомлений о процессе копирования и перемещения
EncryptionKey	Ключ шифрования AES256CBC, используемый для расшифровки сообщений из очереди заданий/манифеста

public Uri JobQueueUri { get; set; }

Функции создания отчетов идентичны методу CreateMigrationJob. Ведение журнала отслеживает состояние createCopyJobs. По умолчанию разрешения и параметры очереди больших двоичных объектов установлены на «полный доступ». Он показывает статус задания следующим образом: начало задания, завершение задания и информация об ошибке задания.

Ограничения

В настоящее время действуют следующие ограничения:

Что	Ограничение
Размер файла	Ограничения SharePoint
Количество элементов	Ограничения SharePoint
Общий размер задания	Ограничения SharePoint