synchronization_templates_schema_directories

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

Overview

Name	synchronization_templates_schema_directories
Type	Resource
Id	entra_id.service_principals.synchronization_templates_schema_directories

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.
name	string	Name of the directory. Must be unique within the synchronization schema. Not nullable.
discoverabilities	string	(None, AttributeNames, AttributeDataTypes, AttributeReadOnly, ReferenceAttributes, UnknownFutureValue) (title: directoryDefinitionDiscoverabilities)
discoveryDateTime	string (date-time)	Represents the discovery date and time using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
objects	array	Collection of objects supported by the directory.
readOnly	boolean	Whether this object is read-only.
version	string	Read only value that indicates version discovered. null if discovery hasn't yet occurred.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
name	string	Name of the directory. Must be unique within the synchronization schema. Not nullable.
discoverabilities	string	(None, AttributeNames, AttributeDataTypes, AttributeReadOnly, ReferenceAttributes, UnknownFutureValue) (title: directoryDefinitionDiscoverabilities)
discoveryDateTime	string (date-time)	Represents the discovery date and time using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
objects	array	Collection of objects supported by the directory.
readOnly	boolean	Whether this object is read-only.
version	string	Read only value that indicates version discovered. null if discovery hasn't yet occurred.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_principal_id, synchronization_template_id, directory_definition_id		Contains the collection of directories and all of their objects.
list	select	service_principal_id, synchronization_template_id		Contains the collection of directories and all of their objects.
insert	insert	service_principal_id, synchronization_template_id
update	update	service_principal_id, synchronization_template_id, directory_definition_id
delete	delete	service_principal_id, synchronization_template_id, directory_definition_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
directory_definition_id	string	The unique identifier of directoryDefinition
service_principal_id	string	The unique identifier of servicePrincipal
synchronization_template_id	string	The unique identifier of synchronizationTemplate
If-Match	string	ETag

SELECT examples

get

Contains the collection of directories and all of their objects.

SELECT
id,
name,
discoverabilities,
discoveryDateTime,
objects,
readOnly,
version
FROM entra_id.service_principals.synchronization_templates_schema_directories
WHERE service_principal_id = '{{ service_principal_id }}' -- required
AND synchronization_template_id = '{{ synchronization_template_id }}' -- required
AND directory_definition_id = '{{ directory_definition_id }}' -- required
;

list

Contains the collection of directories and all of their objects.

SELECT
id,
name,
discoverabilities,
discoveryDateTime,
objects,
readOnly,
version
FROM entra_id.service_principals.synchronization_templates_schema_directories
WHERE service_principal_id = '{{ service_principal_id }}' -- required
AND synchronization_template_id = '{{ synchronization_template_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.service_principals.synchronization_templates_schema_directories (
id,
discoverabilities,
discoveryDateTime,
name,
objects,
readOnly,
version,
service_principal_id,
synchronization_template_id
)
SELECT 
'{{ id }}',
'{{ discoverabilities }}',
'{{ discoveryDateTime }}',
'{{ name }}',
'{{ objects }}',
{{ readOnly }},
'{{ version }}',
'{{ service_principal_id }}',
'{{ synchronization_template_id }}'
RETURNING
id,
name,
discoverabilities,
discoveryDateTime,
objects,
readOnly,
version
;

Manifest

# Description fields are for documentation purposes
- name: synchronization_templates_schema_directories
props:
  - name: service_principal_id
    value: "{{ service_principal_id }}"
    description: Required parameter for the synchronization_templates_schema_directories resource.
  - name: synchronization_template_id
    value: "{{ synchronization_template_id }}"
    description: Required parameter for the synchronization_templates_schema_directories resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: discoverabilities
    value: "{{ discoverabilities }}"
    valid_values: ['None', 'AttributeNames', 'AttributeDataTypes', 'AttributeReadOnly', 'ReferenceAttributes', 'UnknownFutureValue']
  - name: discoveryDateTime
    value: "{{ discoveryDateTime }}"
    description: |
      Represents the discovery date and time using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the directory. Must be unique within the synchronization schema. Not nullable.
  - name: objects
    description: |
      Collection of objects supported by the directory.
    value:
      - attributes: "{{ attributes }}"
        metadata: "{{ metadata }}"
        name: "{{ name }}"
        supportedApis: "{{ supportedApis }}"
  - name: readOnly
    value: {{ readOnly }}
    description: |
      Whether this object is read-only.
  - name: version
    value: "{{ version }}"
    description: |
      Read only value that indicates version discovered. null if discovery hasn't yet occurred.

UPDATE examples

update

No description available.

UPDATE entra_id.service_principals.synchronization_templates_schema_directories
SET 
id = '{{ id }}',
discoverabilities = '{{ discoverabilities }}',
discoveryDateTime = '{{ discoveryDateTime }}',
name = '{{ name }}',
objects = '{{ objects }}',
readOnly = {{ readOnly }},
version = '{{ version }}'
WHERE 
service_principal_id = '{{ service_principal_id }}' --required
AND synchronization_template_id = '{{ synchronization_template_id }}' --required
AND directory_definition_id = '{{ directory_definition_id }}' --required
RETURNING
id,
name,
discoverabilities,
discoveryDateTime,
objects,
readOnly,
version;

DELETE examples

delete

No description available.

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