educationSynchronizationProfile resource type

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

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 synchronization profiles educationSynchronizationProfile collection Get a list of all the synchronization profiles in the tenant.
Get synchronization profile educationSynchronizationProfile Retrieve a specific profile given the profile identifier.
Create synchronization profile None Create a new synchronization profile.
Delete synchronization profile educationSynchronizationProfile Delete a specific profile given the profile identifier.
Pause an ongoing sync None Pause an ongoing synchronization.
Resume a paused sync None Resume a paused synchronization.
Reset a sync None Reset the state of the profile and restart synchronization.
Start sync for uploaded files educationFileSynchronizationVerificationMessage collection Verify the uploaded source files and start synchronization. Applies only when the data provider is educationCsvDataProvider.
Get an upload URL string Return the short-lived URL to upload CSV data files. Applies only when the data provider is educationCsvDataProvider.
Get status of a sync status Return the status of a specific synchronization profile.
Get synchronization errors educationSynchronizationError collection Get all the errors generated during synchronization.

Properties

Property Type Description
displayName string Name of the configuration profile for syncing identities.
dataProvider educationSynchronizationDataProvider The data provider used for the profile.
identitysynchronizationconfiguration educationIdentitySynchronizationConfiguration Identity creation or matching configuration .
licensesToAssign educationSynchronizationLicenseAssignment collection License setup configuration.
state string The state of the profile. Possible values are: provisioning, provisioned, provisioningFailed, deleting, deletionFailed.

Relationships

Property Type Description
errors educationSynchronizationError collection All errors associated with this synchronization profile.
profileStatus educationSynchronizationProfileStatus The synchronization status.

JSON representation

The following is a JSON representation of the educationSynchronizationProfile resource.

{
    "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"
}