synchronization

Creates, updates, deletes, gets or lists a synchronization resource.

Overview

Name	synchronization
Type	Resource
Id	entra_id.service_principals.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.
jobs	array	Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
secrets	array	Represents a collection of credentials to access provisioned cloud applications.
templates	array	Preconfigured synchronization settings for a particular application.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_principal_id		Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API.
replace	replace	service_principal_id
delete	delete	service_principal_id	If-Match
acquire_access_token	exec	service_principal_id		Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application.
secrets	exec	service_principal_id		Provide credentials for establishing connectivity with the target system.

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
service_principal_id	string	The unique identifier of servicePrincipal
If-Match	string	ETag

SELECT examples

get

Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API.

SELECT
id,
jobs,
secrets,
templates
FROM entra_id.service_principals.synchronization
WHERE service_principal_id = '{{ service_principal_id }}' -- required
;

REPLACE examples

replace

No description available.

REPLACE entra_id.service_principals.synchronization
SET 
id = '{{ id }}',
secrets = '{{ secrets }}',
jobs = '{{ jobs }}',
templates = '{{ templates }}'
WHERE 
service_principal_id = '{{ service_principal_id }}' --required
RETURNING
id,
jobs,
secrets,
templates;

DELETE examples

delete

No description available.

DELETE FROM entra_id.service_principals.synchronization
WHERE service_principal_id = '{{ service_principal_id }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

acquire_access_token

Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application.

EXEC entra_id.service_principals.synchronization.acquire_access_token 
@service_principal_id='{{ service_principal_id }}' --required 
@@json=
'{
"credentials": "{{ credentials }}"
}'
;

secrets

Provide credentials for establishing connectivity with the target system.

EXEC entra_id.service_principals.synchronization.secrets 
@service_principal_id='{{ service_principal_id }}' --required 
@@json=
'{
"value": "{{ value }}"
}'
;