synchronization_jobs_schema

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

Overview

Name	synchronization_jobs_schema
Type	Resource
Id	entra_id.service_principals.synchronization_jobs_schema

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.
directories	array	Contains the collection of directories and all of their objects.
synchronizationRules	array	A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
version	string	The version of the schema, updated automatically with every schema change.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_principal_id, synchronization_job_id		Retrieve the schema for a given synchronization job or template.
update	update	service_principal_id, synchronization_job_id		Update the synchronization schema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.
delete	delete	service_principal_id, synchronization_job_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
service_principal_id	string	The unique identifier of servicePrincipal
synchronization_job_id	string	The unique identifier of synchronizationJob
If-Match	string	ETag

SELECT examples

get

Retrieve the schema for a given synchronization job or template.

SELECT
id,
directories,
synchronizationRules,
version
FROM entra_id.service_principals.synchronization_jobs_schema
WHERE service_principal_id = '{{ service_principal_id }}' -- required
AND synchronization_job_id = '{{ synchronization_job_id }}' -- required
;

UPDATE examples

update

Update the synchronization schema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.

UPDATE entra_id.service_principals.synchronization_jobs_schema
SET 
id = '{{ id }}',
synchronizationRules = '{{ synchronizationRules }}',
version = '{{ version }}',
directories = '{{ directories }}'
WHERE 
service_principal_id = '{{ service_principal_id }}' --required
AND synchronization_job_id = '{{ synchronization_job_id }}' --required
RETURNING
id,
directories,
synchronizationRules,
version;

DELETE examples

delete

No description available.

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