extension_properties

Creates, updates, deletes, gets or lists an extension_properties resource.

Overview

Name	extension_properties
Type	Resource
Id	entra_id.applications.extension_properties

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 extension property. Not nullable. Supports $filter (eq).
appDisplayName	string	Display name of the application object on which this extension property is defined. Read-only.
dataType	string	Specifies the data type of the value the extension property can hold. Following values are supported. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximumNot nullable. For multivalued directory extensions, these limits apply per value in the collection.
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (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])$)
isMultiValued	boolean	Defines the directory extension as a multi-valued property. When true, the directory extension property can store a collection of objects of the dataType; for example, a collection of string types such as 'extensionb7b1c57b532f40b8b5ed4b7a7ba67401jobGroupTracker': ['String 1', 'String 2']. The default value is false. Supports $filter (eq).
isSyncedFromOnPremises	boolean	Indicates if this extension property was synced from on-premises active directory using Microsoft Entra Connect. Read-only.
targetObjects	array	Following values are supported. Not nullable. UserGroupAdministrativeUnitApplicationDeviceOrganization

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
name	string	Name of the extension property. Not nullable. Supports $filter (eq).
appDisplayName	string	Display name of the application object on which this extension property is defined. Read-only.
dataType	string	Specifies the data type of the value the extension property can hold. Following values are supported. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximumNot nullable. For multivalued directory extensions, these limits apply per value in the collection.
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (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])$)
isMultiValued	boolean	Defines the directory extension as a multi-valued property. When true, the directory extension property can store a collection of objects of the dataType; for example, a collection of string types such as 'extensionb7b1c57b532f40b8b5ed4b7a7ba67401jobGroupTracker': ['String 1', 'String 2']. The default value is false. Supports $filter (eq).
isSyncedFromOnPremises	boolean	Indicates if this extension property was synced from on-premises active directory using Microsoft Entra Connect. Read-only.
targetObjects	array	Following values are supported. Not nullable. UserGroupAdministrativeUnitApplicationDeviceOrganization

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	application_id, extension_property_id		Read a directory extension definition represented by an extensionProperty object.
list	select	application_id		Retrieve the list of directory extension definitions, represented by extensionProperty objects on an application.
insert	insert	application_id		Create a new directory extension definition, represented by an extensionProperty object.
update	update	application_id, extension_property_id
delete	delete	application_id, extension_property_id	If-Match	Delete a directory extension definition represented by an extensionProperty object. You can delete only directory extensions that aren't synced from on-premises active directory (AD).

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

SELECT examples

get

Read a directory extension definition represented by an extensionProperty object.

SELECT
id,
name,
appDisplayName,
dataType,
deletedDateTime,
isMultiValued,
isSyncedFromOnPremises,
targetObjects
FROM entra_id.applications.extension_properties
WHERE application_id = '{{ application_id }}' -- required
AND extension_property_id = '{{ extension_property_id }}' -- required
;

list

Retrieve the list of directory extension definitions, represented by extensionProperty objects on an application.

SELECT
id,
name,
appDisplayName,
dataType,
deletedDateTime,
isMultiValued,
isSyncedFromOnPremises,
targetObjects
FROM entra_id.applications.extension_properties
WHERE application_id = '{{ application_id }}' -- required
;

INSERT examples

insert

Create a new directory extension definition, represented by an extensionProperty object.

INSERT INTO entra_id.applications.extension_properties (
id,
deletedDateTime,
appDisplayName,
dataType,
isMultiValued,
isSyncedFromOnPremises,
name,
targetObjects,
application_id
)
SELECT 
'{{ id }}',
'{{ deletedDateTime }}',
'{{ appDisplayName }}',
'{{ dataType }}',
{{ isMultiValued }},
{{ isSyncedFromOnPremises }},
'{{ name }}',
'{{ targetObjects }}',
'{{ application_id }}'
RETURNING
id,
name,
appDisplayName,
dataType,
deletedDateTime,
isMultiValued,
isSyncedFromOnPremises,
targetObjects
;

Manifest

# Description fields are for documentation purposes
- name: extension_properties
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the extension_properties resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: deletedDateTime
    value: "{{ deletedDateTime }}"
    description: |
      Date and time when this object was deleted. Always null when the object hasn't been deleted.
  - name: appDisplayName
    value: "{{ appDisplayName }}"
    description: |
      Display name of the application object on which this extension property is defined. Read-only.
  - name: dataType
    value: "{{ dataType }}"
    description: |
      Specifies the data type of the value the extension property can hold. Following values are supported. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximumNot nullable. For multivalued directory extensions, these limits apply per value in the collection.
  - name: isMultiValued
    value: {{ isMultiValued }}
    description: |
      Defines the directory extension as a multi-valued property. When true, the directory extension property can store a collection of objects of the dataType; for example, a collection of string types such as 'extensionb7b1c57b532f40b8b5ed4b7a7ba67401jobGroupTracker': ['String 1', 'String 2']. The default value is false. Supports $filter (eq).
  - name: isSyncedFromOnPremises
    value: {{ isSyncedFromOnPremises }}
    description: |
      Indicates if this extension property was synced from on-premises active directory using Microsoft Entra Connect. Read-only.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the extension property. Not nullable. Supports $filter (eq).
  - name: targetObjects
    value:
      - "{{ targetObjects }}"
    description: |
      Following values are supported. Not nullable. UserGroupAdministrativeUnitApplicationDeviceOrganization

UPDATE examples

update

No description available.

UPDATE entra_id.applications.extension_properties
SET 
id = '{{ id }}',
deletedDateTime = '{{ deletedDateTime }}',
appDisplayName = '{{ appDisplayName }}',
dataType = '{{ dataType }}',
isMultiValued = {{ isMultiValued }},
isSyncedFromOnPremises = {{ isSyncedFromOnPremises }},
name = '{{ name }}',
targetObjects = '{{ targetObjects }}'
WHERE 
application_id = '{{ application_id }}' --required
AND extension_property_id = '{{ extension_property_id }}' --required
RETURNING
id,
name,
appDisplayName,
dataType,
deletedDateTime,
isMultiValued,
isSyncedFromOnPremises,
targetObjects;

DELETE examples

delete

Delete a directory extension definition represented by an extensionProperty object. You can delete only directory extensions that aren't synced from on-premises active directory (AD).

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