安装学校数据同步工具包

重要:  本文是由机器翻译的,请参阅免责声明。请在 此处 中查找本文的英文版本以便参考。

可使用学校数据同步工具包来验证 CSV 文件和检查错误、从 PowerShell 手动执行 CSV 同步以及根据需要自动化 CSV 同步过程。

本主题内容:

安装 Microsoft 学校数据同步工具包

  1. Microsoft 学校数据同步工具包下载该工具。

  2. 双击该工具以运行向导。

  3. 在“欢迎”页上,选择“下一步”。

    在 Microsoft 学校数据同步工具包设置的欢迎页上选择“下一步”
  4. 接收许可协议 > 单击“下一步”,选择安装路径,然后选择“下一步”。

    选择 Microsoft 学校数据同步工具包的安装路径
  5. 选择“安装”>“完成”。

学校数据同步工具包的功能

安装工具包并在学校数据同步门户中创建初始配置文件之后,可以使用以下脚本定期或在需要时上传其他 CSV 文件。使用安装程序可以在计算机上从管理员 PowerShell 会话运行多个 cmdlet,可帮助成功部署学校数据同步。请参阅以下各部分,获取有关每个 cmdlet 的说明和用例。

使用学校数据同步工具包验证 CSV 文件数据(预同步)

若要在上传需要同步的文件之前使用工具包来验证 CSV 文件,请以管理员身份打开 PowerShell,并按以下语法和示例说明使用 Start-CsvFilesValidation cmdlet。

Start-CsvFilesValidation 语法

使用 Start-CsvFilesValidation cmdlet 验证给定同步配置文件的 CSV 文件。

Start-CsvFilesValidation -CsvFolderPath <String> -ProfileName <String> -UserName <String>

参数

说明

CsvFolderPath

包含 CSV 文件的文件夹的路径。

ProfileName

在学校数据同步中为要验证的 CSV 创建的配置文件的名称。

UserName

对 Office 365 租户具有全局管理员权限的管理帐户的用户名。

以下示例使用全局管理员帐户 admin@contoso.com,为名为“School 1”的配置文件,对位于本地计算机的 c:\temp 目录中的 CSV 文件执行客户端验证。

Start-CsvFilesValidation –CsvFolderPath “c:\temp” –ProfileName “School 1” –UserName admin@contoso.com

使用学校数据同步工具包同步 CSV 文件

若要使用学校数据同步来上传并同步 CSV 文件,请以管理员身份打开 PowerShell,并按以下语法和示例说明使用 Send-CsvFiles cmdlet。

Send-CsvFiles syntax

使用 Send-CsvFiles cmdlet 上传并同步给定同步配置文件的 CSV 文件。

Send-CsvFiles -CsvFolderPath <String> -ProfileName <String> -UserName <String>

参数

说明

CsvFolderPath

包含 CSV 文件的文件夹的路径。

ProfileName

在学校数据同步中为要验证的 CSV 创建的配置文件的名称。

UserName

对 Office 365 租户具有全局管理员权限的管理帐户的用户名。

以下示例使用全局管理员帐户“admin@contoso.com”,为名为“School 1”的配置文件,上传并同步一组位于本地计算机的 c:\temp 目录中的 CSV 文件。

Send-CsvFiles –CsvFolderPath “c:\temp” –ProfileName “School 1” –UserName “admin@contoso.com”

使用学校数据同步工具包配置自动化的 CSV 同步

用户可以计划本地存储的 CSV 文件和 Office 365 中的 SDS 同步配置文件之间的无人参与的自动同步。为此,请以管理员身份打开 PowerShell,并按以下语法和示例说明使用 Add-CsvFileSyncTask cmdlet。计划的任务完成后,通过在任务计划程序中查看新创建的计划任务,用户可以监视这些自动同步的进度和历史记录。此计划任务将在每天午夜运行,除非使用以下参数修改开始时间。

运行此命令时,系统会提示用户进行身份验证。第一个身份验证提示会要求提供全局管理员凭据,并且其中已包含用户在以下命令(用户名参数下)中指定的用户名。输入密码并单击 Enter 后,用户将收到第二个提示,即基本身份验证提示。应在此处输入本地管理员用户名和密码,这些将用作每天开始运行计划任务时所需的凭据。如果含入 StoreCredentials 参数,本地管理员帐户凭据会存储在凭据管理器中,且只要密码不变就一直有效。如果不指定 StoreCredentials 参数,会获得一个生命周期最多为 90 天的身份验证令牌。这样的话,在身份验证令牌过期后且无法再在运行计划任务时进行身份验证时,需要再次运行该命令。

Add-CsvFileSyncTask 语法

使用 Add-CsvFileSyncTask cmdlet 上传并同步给定同步配置文件的 CSV 文件。

Add-CsvFileSyncTask -CSVFolderPath <path to csv file location> -ProfileName <name of sync profile in SDS> -LogPath <path to store logs> -UserName <global admin account> -Validate -RedirectOutput

参数

说明

CSVFolderPath

文件夹路径,其中的文件夹包含要定期同步的 CSV 文件。

ProfileName

要同步 CSV 文件的 SDS 同步配置文件的名称。

UserName

要与 SDS 一起使用的全局管理员帐户的 UserPrincipalName。

LogPath

用于存储验证日志文件的目录的路径。

RedirectOutput

允许将验证参数的输出写出到指定目录。如果要查看验证参数的结果,则需要此项。

Validate

进行每次同步之前先运行验证任务。如果还包含了 RedirectOutput 参数,则在 Logpath 目录中创建一个文件。

TaskUserName

计划任务的名称。

TaskStartTime

一天中计划任务开始的时间。

StoreCredentials

在凭据管理器中创建一个条目来运行计划任务。除非与此帐户关联的密码过期,否则凭据将持续有效并继续发挥作用。

以下示例在名为 SDSSync 的同步配置文件上为位于 C:\temp 文件夹中的 CSV 文件创建一个自动同步计划任务,在 C:\temp\logs 文件夹中创建验证日志文件,并将 C:\temp\SDS\Logs 目录设置为所生成的所有日志文件的存放位置。此命令还在开始同步前对 CSV 运行验证过程,并将验证输出保存在同一 c:\temp\logs 目录中。

Add-CsvFileSyncTask -CSVFolderPath “C:\temp” -ProfileName “SDSSync” -LogPath “C:\temp\logs” -UserName admin@contoso.com -Validate -RedirectOutput

使用学校数据同步工具包转换 OneRoster CSV 文件

可以使用该工具包来转换 OneRoster CSV 文件并将其与“学校数据同步”进行同步。为此,请以管理员身份打开 PowerShell,并按以下语法和示例说明使用 Convert-OneRostertoMicrosoftSDS cmdlet。转换完成后,可以按照标准 CSV 指南操作,通过 SDS 同步这些 CSV 文件。

Convert-OneRostertoMicrosoftSDS 语法

使用 Convert-OneRostertoMicrosoftSDS cmdlet 上传并同步给定同步配置文件的 CSV 文件。

Convert-OneRostertoMicrosoftSDS -OneRosterFolderPath <String> -SDSFolderPath <String> -LogPath <String>

参数

说明

OneRosterFolderPath

文件夹路径,其中的文件夹中包含从 OneRoster 中导出的 CSV 文件。

SDSFolderPath

用于创建转换的 CSV 文件的文件夹的路径。

LogPath

用于存储这些操作的日志记录的文件夹路径。

以下示例转换一组位于 C:\temp\OneRoster 文件夹中的 CSV 文件,在本地计算机的 C:\temp\SDS 目录中创建一组新的 CSV 文件,并将 C:\temp\SDS\Logs 目录设置为生成的所有日志文件的存放位置。

Convert-OneRostertoMicrosoftSDS -OneRosterFolderPath “C:\temp\OneRoster” -SDSFolderPath “C:\temp\SDS” -LogPath “C:\temp\SDS\logs”

使用学校数据同步工具包验证 CSV 文件数据(后期同步)

若要在上传和同步一组 CSV 文件之后使用工具包来验证 CSV 文件,请以管理员身份打开 PowerShell,并按以下语法和示例说明使用 Compare-DirectoryToCSVFiles cmdlet。

Compare-DirectoryToCSVFiles 语法

使用 Compare-DirectoryToCSVFiles cmdlet 验证给定同步配置文件的 CSV 文件。

Compare-DirectoryToCSVFiles -CsvFolderPath <String> -ProfileName <String> -UserName <String>

参数

说明

CsvFolderPath

包含 CSV 文件的文件夹的路径。

ProfileName

在学校数据同步中为要验证的 CSV 创建的配置文件的名称。

UserName

对 Office 365 租户具有全局管理员权限的管理帐户的用户名。

以下示例使用全局管理员帐户“admin@contoso.com”,为名为“School 1”的配置文件,对位于本地计算机的 c:\temp 目录中的 CSV 文件执行客户端验证。

Compare-DirectoryToCsvFiles –CsvFolderPath “c:\temp” –ProfileName “School 1” –UserName “admin@contoso.com”

注意: 机器翻译免责声明:本文是由无人工介入的计算机系统翻译的。Microsoft 提供机器翻译是为了帮助非英语国家/地区用户方便阅读有关 Microsoft 产品、服务和技术的内容。由于机器翻译的原因,本文可能包含词汇、语法或文法方面的错误。

另请参阅

学校数据同步和 Classroom 概述

用于学校数据同步的 CSV 文件

用于 PowerSchool Sync 的学校数据同步必需属性

如何使用 CSV 文件部署学校数据同步

如何使用 PowerSchool Sync 部署学校数据同步

如何使用 Clever Sync 部署学校数据同步

如何使用 OneRoster CSV 文件部署学校数据同步

学校数据同步错误和疑难解答

扩展你的技能
了解培训
抢先获得新功能
加入 Office 预览体验计划

此信息是否有帮助?

谢谢您的反馈!

谢谢你的反馈! 可能需要转接到 Office 支持专员。

×