educationSynchronizationProfile 资源类型educationSynchronizationProfile resource type

命名空间:microsoft.graphNamespace: microsoft.graph

重要

/betaMicrosoft Graph 中的版本下的 api 可能会发生更改。APIs under the /beta version in Microsoft Graph are subject to change. 不支持在生产应用程序中使用这些 API。Use of these APIs in production applications is not supported. 若要确定 API 在 v1.0 中是否可用,请使用 版本 选择器。To determine whether an API is available in v1.0, use the Version selector.

表示一组用于将源目录中的教育实体和名单信息同步到 Azure Active Directory (Azure AD) 的配置。Represents a set of configurations used to synchronize education entities and roster information from a source directory to Azure Active Directory (Azure AD). 此资源提供在 学校数据同步中使用的编程表示形式。This resource provides a programmatic representation used in School Data Sync.

方法Methods

方法Method 返回类型Return Type 说明Description
列出配置文件List profiles educationSynchronizationProfile 集合educationSynchronizationProfile collection 获取租户中所有同步配置文件的列表。Get a list of all the synchronization profiles in the tenant.
获取个人资料Get profile educationSynchronizationProfileeducationSynchronizationProfile 在给定配置文件标识符的情况检索特定配置文件。Retrieve a specific profile given the profile identifier.
创建配置文件Create profile None 创建新的同步配置文件。Create a new synchronization profile.
删除个人资料Delete profile educationSynchronizationProfileeducationSynchronizationProfile 在给定配置文件标识符的情况删除特定配置文件。Delete a specific profile given the profile identifier.
暂停配置文件Pause profile None 暂停正在进行的同步。Pause an ongoing synchronization.
恢复配置文件Resume profile None 恢复暂停的同步。Resume a paused synchronization.
重置配置文件Reset profile None 重置配置文件的状态并重新启动同步。Reset the state of the profile and restart synchronization.
启动 CSV 配置文件Start CSV profile educationFileSynchronizationVerificationMessage集合educationFileSynchronizationVerificationMessagecollection 验证上载的源文件并启动同步。Verify the uploaded source files and start synchronization. 仅在数据提供程序为 educationCsvDataProvider时适用。Applies only when the data provider is educationCsvDataProvider.
获取 CSV 上载 URLGet CSV upload URL 字符串string 返回短生存期的 URL 以上载 CSV 数据文件。Return the short-lived URL to upload CSV data files. 仅在数据提供程序为 educationCsvDataProvider时适用。Applies only when the data provider is educationCsvDataProvider.
获取状态Get status educationsynchronizationProfileStatuseducationsynchronizationProfileStatus 返回特定同步配置文件的状态。Return the status of a specific synchronization profile.
获取错误Get errors educationSynchronizationError 集合educationSynchronizationError collection 获取同步过程中生成的所有错误。Get all the errors generated during synchronization.

属性Properties

属性Property 类型Type 说明Description
idid StringString 资源的唯一标识符。The unique identifier for the resource. (只读) (read-only)
displayNamedisplayName StringString 用于同步标识的配置文件的名称。Name of the configuration profile for syncing identities.
dataProviderdataProvider educationSynchronizationDataProvidereducationSynchronizationDataProvider 用于配置文件的数据提供程序。The data provider used for the profile.
expirationDateexpirationDate 日期Date 应将配置文件视为已过期并停止同步的日期。The date the profile should be considered expired and cease syncing. When nullWhen null. 配置文件永远不会过期。the profile will never expire. (可选)(optional)
handleSpecialCharacterConstrainthandleSpecialCharacterConstraint BoolBool 确定在从源同步时,学校数据同步是否应自动替换不受支持的特殊字符。Determines if School Data Sync should automatically replace unsupported special characters while syncing from source.
identitySynchronizationConfigurationidentitySynchronizationConfiguration educationIdentitySynchronizationConfigurationeducationIdentitySynchronizationConfiguration 确定配置文件应如何 新建匹配现有 AAD 用户。Determines how the Profile should create new or match existing AAD Users.
licensesToAssignlicensesToAssign educationSynchronizationLicenseAssignment 集合educationSynchronizationLicenseAssignment collection 许可证安装程序配置。License setup configuration.
statestate educationSynchronizationProfileStateeducationSynchronizationProfileState 配置文件的状态。The state of the profile. 可取值为:provisioningprovisionedprovisioningFaileddeletingdeletionFailedPossible values are: provisioning, provisioned, provisioningFailed, deleting, deletionFailed.

关系Relationships

关系Relationship 类型Type 说明Description
错误errors educationSynchronizationError 集合educationSynchronizationError collection 与此同步配置文件关联的所有错误。All errors associated with this synchronization profile.
profileStatusprofileStatus educationSynchronizationProfileStatuseducationSynchronizationProfileStatus 同步状态。The synchronization status.

数据提供程序Data Providers

每个 educationSynchronizationProfile 必须指定要用作同步源的以下数据提供程序之一。Each educationSynchronizationProfile must specify one of the follow data providers to use as the synchronization source.

Data ProviderData Provider 说明Description
educationCsvDataProvidereducationCsvDataProvider 上载到配置文件的SAS URL的 CSV 文件CSV files uploaded to the Profile's SAS URL
educationOneRosterApiDataProvidereducationOneRosterApiDataProvider OneRoster v1.1 APIOneRoster v1.1 API
educationPowerSchoolDataProvidereducationPowerSchoolDataProvider PowerSchool APIPowerSchool API

JSON 表示形式JSON representation

下面是 educationSynchronizationProfile 资源的 JSON 表示形式。The following is a JSON representation of the educationSynchronizationProfile resource.

{
  "id": "String",
  "displayName": "String",
  "state": {
    "@odata.type": "microsoft.graph.educationSynchronizationProfileState"
  },
  "profileStatus": {
    "@odata.type": "microsoft.graph.educationSynchronizationProfileStatus"
  },
  "errors": [
    {
      "@odata.type": "microsoft.graph.educationSynchronizationProfileStatus"
    }
  ],
  "dataProvider": {
    "@odata.type": "microsoft.graph.educationCsvDataProvider"
  },
  "identitySynchronizationConfiguration": {
    "@odata.type": "microsoft.graph.educationIdentitySynchronizationConfiguration"
  },
  "licensesToAssign": [
    {
      "@odata.type": "microsoft.graph.educationSynchronizationLicenseAssignment"
    }
  ],
  "handleSpecialCharacterConstraint": "Boolean",
  "expirationDate": "Date"
}