functions

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

Overview

Name	functions
Type	Resource
Id	entra_id.synchronization.functions

Fields

The following fields are returned by SELECT queries:

get

Retrieved entity

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
parameters	array	Collection of function parameters.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
parameters	array	Collection of function parameters.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	attribute_mapping_function_schema_id
list	select
insert	insert
update	update	attribute_mapping_function_schema_id
delete	delete	attribute_mapping_function_schema_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
attribute_mapping_function_schema_id	string	The unique identifier of attributeMappingFunctionSchema
If-Match	string	ETag

SELECT examples

get

Retrieved entity

SELECT
id,
parameters
FROM entra_id.synchronization.functions
WHERE attribute_mapping_function_schema_id = '{{ attribute_mapping_function_schema_id }}' -- required
;

list

Retrieved collection

SELECT
id,
parameters
FROM entra_id.synchronization.functions
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.synchronization.functions (
id,
parameters
)
SELECT 
'{{ id }}',
'{{ parameters }}'
RETURNING
id,
parameters
;

Manifest

# Description fields are for documentation purposes
- name: functions
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: parameters
    description: |
      Collection of function parameters.
    value:
      - allowMultipleOccurrences: {{ allowMultipleOccurrences }}
        name: "{{ name }}"
        required: {{ required }}
        type: "{{ type }}"

UPDATE examples

update

No description available.

UPDATE entra_id.synchronization.functions
SET 
id = '{{ id }}',
parameters = '{{ parameters }}'
WHERE 
attribute_mapping_function_schema_id = '{{ attribute_mapping_function_schema_id }}' --required
RETURNING
id,
parameters;

DELETE examples

delete

No description available.

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