synchronization_templates

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

Overview

Name	synchronization_templates
Type	Resource
Id	entra_id.applications.synchronization_templates

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.
applicationId	string (uuid)	Identifier of the application this template belongs to. (pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
default	boolean	true if this template is recommended to be the default for the application.
description	string	Description of the template.
discoverable	boolean	true if this template should appear in the collection of templates available for the application instance (service principal).
factoryTag	string	One of the well-known factory tags supported by the synchronization engine. The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
metadata	array	Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.
schema		Default synchronization schema for the jobs based on this template.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
applicationId	string (uuid)	Identifier of the application this template belongs to. (pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
default	boolean	true if this template is recommended to be the default for the application.
description	string	Description of the template.
discoverable	boolean	true if this template should appear in the collection of templates available for the application instance (service principal).
factoryTag	string	One of the well-known factory tags supported by the synchronization engine. The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
metadata	array	Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.
schema		Default synchronization schema for the jobs based on this template.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	application_id, synchronization_template_id		Preconfigured synchronization settings for a particular application.
list	select	application_id		Preconfigured synchronization settings for a particular application.
insert	insert	application_id
update	update	application_id, synchronization_template_id		Update (override) the synchronization template associated with a given application.
delete	delete	application_id, synchronization_template_id	If-Match
schema_directories_discover	exec	application_id, synchronization_template_id, directory_definition_id		Discover the latest schema definition for provisioning to an application.
schema_parse_expression	exec	application_id, synchronization_template_id		Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.

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
application_id	string	The unique identifier of application
directory_definition_id	string	The unique identifier of directoryDefinition
synchronization_template_id	string	The unique identifier of synchronizationTemplate
If-Match	string	ETag

SELECT examples

get

Preconfigured synchronization settings for a particular application.

SELECT
id,
applicationId,
default,
description,
discoverable,
factoryTag,
metadata,
schema
FROM entra_id.applications.synchronization_templates
WHERE application_id = '{{ application_id }}' -- required
AND synchronization_template_id = '{{ synchronization_template_id }}' -- required
;

list

Preconfigured synchronization settings for a particular application.

SELECT
id,
applicationId,
default,
description,
discoverable,
factoryTag,
metadata,
schema
FROM entra_id.applications.synchronization_templates
WHERE application_id = '{{ application_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.applications.synchronization_templates (
id,
applicationId,
default,
description,
discoverable,
factoryTag,
metadata,
schema,
application_id
)
SELECT 
'{{ id }}',
'{{ applicationId }}',
{{ default }},
'{{ description }}',
{{ discoverable }},
'{{ factoryTag }}',
'{{ metadata }}',
'{{ schema }}',
'{{ application_id }}'
RETURNING
id,
applicationId,
default,
description,
discoverable,
factoryTag,
metadata,
schema
;

Manifest

# Description fields are for documentation purposes
- name: synchronization_templates
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the synchronization_templates resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: applicationId
    value: "{{ applicationId }}"
    description: |
      Identifier of the application this template belongs to.
  - name: default
    value: {{ default }}
    description: |
      true if this template is recommended to be the default for the application.
  - name: description
    value: "{{ description }}"
    description: |
      Description of the template.
  - name: discoverable
    value: {{ discoverable }}
    description: |
      true if this template should appear in the collection of templates available for the application instance (service principal).
  - name: factoryTag
    value: "{{ factoryTag }}"
    description: |
      One of the well-known factory tags supported by the synchronization engine. The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
  - name: metadata
    description: |
      Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: schema
    value: "{{ schema }}"
    description: |
      Default synchronization schema for the jobs based on this template.

UPDATE examples

update

Update (override) the synchronization template associated with a given application.

UPDATE entra_id.applications.synchronization_templates
SET 
id = '{{ id }}',
applicationId = '{{ applicationId }}',
default = {{ default }},
description = '{{ description }}',
discoverable = {{ discoverable }},
factoryTag = '{{ factoryTag }}',
metadata = '{{ metadata }}',
schema = '{{ schema }}'
WHERE 
application_id = '{{ application_id }}' --required
AND synchronization_template_id = '{{ synchronization_template_id }}' --required
RETURNING
id,
applicationId,
default,
description,
discoverable,
factoryTag,
metadata,
schema;

DELETE examples

delete

No description available.

DELETE FROM entra_id.applications.synchronization_templates
WHERE application_id = '{{ application_id }}' --required
AND synchronization_template_id = '{{ synchronization_template_id }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

schema_directories_discover

Discover the latest schema definition for provisioning to an application.

EXEC entra_id.applications.synchronization_templates.schema_directories_discover 
@application_id='{{ application_id }}' --required, 
@synchronization_template_id='{{ synchronization_template_id }}' --required, 
@directory_definition_id='{{ directory_definition_id }}' --required
;

schema_parse_expression

Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.

EXEC entra_id.applications.synchronization_templates.schema_parse_expression 
@application_id='{{ application_id }}' --required, 
@synchronization_template_id='{{ synchronization_template_id }}' --required 
@@json=
'{
"expression": "{{ expression }}", 
"testInputObject": "{{ testInputObject }}", 
"targetAttributeDefinition": "{{ targetAttributeDefinition }}"
}'
;