Edit

Share via

onPremisesDirectorySynchronization resource type

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

A container for on-premises directory synchronization functionalities that are available for the organization. Only the read and update operations are supported on this resource; create and delete aren't supported.

Methods

Method Return type Description
Get onPremisesDirectorySynchronization Read the properties and relationships of an onPremisesDirectorySynchronization object.
Update onPremisesDirectorySynchronization Update the properties of an onPremisesDirectorySynchronization object.

Properties

Property Type Description
configuration onPremisesDirectorySynchronizationConfiguration Consists of configurations that can be fine-tuned and impact the on-premises directory synchronization process for a tenant. Nullable.
features onPremisesDirectorySynchronizationFeature Consists of directory synchronization features that can be enabled or disabled. Not nullable.
id String The unique Microsoft Entra tenant ID.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.onPremisesDirectorySynchronization",
  "id": "String (identifier)",
  "configuration": {
    "@odata.type": "microsoft.graph.onPremisesDirectorySynchronizationConfiguration"
  },
  "features": {
    "@odata.type": "microsoft.graph.onPremisesDirectorySynchronizationFeature"
  }
}