on_premises_synchronization

Creates, updates, deletes, gets or lists an on_premises_synchronization resource.

Overview

Name	on_premises_synchronization
Type	Resource
Id	entra_id.directory.on_premises_synchronization

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
configuration		Consists of configurations that can be fine-tuned and impact the on-premises directory synchronization process for a tenant. Nullable.
features	object	(title: onPremisesDirectorySynchronizationFeature)

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
configuration		Consists of configurations that can be fine-tuned and impact the on-premises directory synchronization process for a tenant. Nullable.
features	object	(title: onPremisesDirectorySynchronizationFeature)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	on_premises_directory_synchronization_id		Read the properties and relationships of an onPremisesDirectorySynchronization object.
list	select			Read the properties and relationships of an onPremisesDirectorySynchronization object.
insert	insert
update	update	on_premises_directory_synchronization_id		Update the properties of an onPremisesDirectorySynchronization object.
delete	delete	on_premises_directory_synchronization_id	If-Match

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
on_premises_directory_synchronization_id	string	The unique identifier of onPremisesDirectorySynchronization
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of an onPremisesDirectorySynchronization object.

SELECT
id,
configuration,
features
FROM entra_id.directory.on_premises_synchronization
WHERE on_premises_directory_synchronization_id = '{{ on_premises_directory_synchronization_id }}' -- required
;

list

Read the properties and relationships of an onPremisesDirectorySynchronization object.

SELECT
id,
configuration,
features
FROM entra_id.directory.on_premises_synchronization
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.directory.on_premises_synchronization (
id,
configuration,
features
)
SELECT 
'{{ id }}',
'{{ configuration }}',
'{{ features }}'
RETURNING
id,
configuration,
features
;

Manifest

# Description fields are for documentation purposes
- name: on_premises_synchronization
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: configuration
    value: "{{ configuration }}"
    description: |
      Consists of configurations that can be fine-tuned and impact the on-premises directory synchronization process for a tenant. Nullable.
  - name: features
    value:
      allowOnPremUpdateOfOnPremisesObjectIdentifierEnabled: {{ allowOnPremUpdateOfOnPremisesObjectIdentifierEnabled }}
      blockCloudObjectTakeoverThroughHardMatchEnabled: {{ blockCloudObjectTakeoverThroughHardMatchEnabled }}
      blockSoftMatchEnabled: {{ blockSoftMatchEnabled }}
      bypassDirSyncOverridesEnabled: {{ bypassDirSyncOverridesEnabled }}
      cloudPasswordPolicyForPasswordSyncedUsersEnabled: {{ cloudPasswordPolicyForPasswordSyncedUsersEnabled }}
      concurrentCredentialUpdateEnabled: {{ concurrentCredentialUpdateEnabled }}
      concurrentOrgIdProvisioningEnabled: {{ concurrentOrgIdProvisioningEnabled }}
      deviceWritebackEnabled: {{ deviceWritebackEnabled }}
      directoryExtensionsEnabled: {{ directoryExtensionsEnabled }}
      fopeConflictResolutionEnabled: {{ fopeConflictResolutionEnabled }}
      groupWriteBackEnabled: {{ groupWriteBackEnabled }}
      passwordSyncEnabled: {{ passwordSyncEnabled }}
      passwordWritebackEnabled: {{ passwordWritebackEnabled }}
      quarantineUponProxyAddressesConflictEnabled: {{ quarantineUponProxyAddressesConflictEnabled }}
      quarantineUponUpnConflictEnabled: {{ quarantineUponUpnConflictEnabled }}
      softMatchOnUpnEnabled: {{ softMatchOnUpnEnabled }}
      synchronizeUpnForManagedUsersEnabled: {{ synchronizeUpnForManagedUsersEnabled }}
      unifiedGroupWritebackEnabled: {{ unifiedGroupWritebackEnabled }}
      userForcePasswordChangeOnLogonEnabled: {{ userForcePasswordChangeOnLogonEnabled }}
      userWritebackEnabled: {{ userWritebackEnabled }}

UPDATE examples

update

Update the properties of an onPremisesDirectorySynchronization object.

UPDATE entra_id.directory.on_premises_synchronization
SET 
id = '{{ id }}',
configuration = '{{ configuration }}',
features = '{{ features }}'
WHERE 
on_premises_directory_synchronization_id = '{{ on_premises_directory_synchronization_id }}' --required
RETURNING
id,
configuration,
features;

DELETE examples

delete

No description available.

DELETE FROM entra_id.directory.on_premises_synchronization
WHERE on_premises_directory_synchronization_id = '{{ on_premises_directory_synchronization_id }}' --required
AND If-Match = '{{ If-Match }}'
;