Saran dan Komentar Edit

extensionProperty resource type

  • Artikel
  • 2 menit untuk membaca

Namespace: microsoft.graph

Represents a directory extension that can be used to add a custom property to directory objects without requiring an external data store. For example, if an organization has a line of business (LOB) application that requires a Skype ID for each user in the directory, Microsoft Graph can be used to register a new property named skypeId on the directory’s User object, and then write a value to the new property for a specific user.

Directory extensions can be added to following directory objects:

Only 100 extension values, across all types and all applications, can be written to any single Azure AD resource.

Use this resource and associated methods to manage the directory extension definitions. To manage the directory extension data on the extended resource instance, use the same REST request that you use to manage the resource instance.

For more information about Microsoft Graph extensibility, see Add custom properties to resources using extensions.

Inherits from directoryObject.

Note

Extensions created through Azure AD Graph (deprecated) and custom data synchronized from on-premises Active Directory using Azure AD Connect Sync are represented as directory extensions in Microsoft Graph.

Methods

Method Return Type Description
Create extensionProperties extensionProperty Create an extension property on an application object.
List extensionProperties extensionProperty collection List extension properties on an application object.
Get extensionProperty extensionProperty collection List extension properties on an application object.
Delete extensionProperty None Delete an extension property from an application object. You can delete only properties that aren't synced from on-premises active directory.

Tip

  1. To set a value for the extension property to an instance of a resource that is specified in targetObjects, use the Update operation of the resource. For example, the Update user API to set the value for a user.
  2. To remove the extension property and its value from an instance of a resource that is specified in targetObjects, set the value of the extension property to null.

Properties

Property Type Description
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. Not nullable.
  • Binary - 256 bytes maximum
  • Boolean
  • DateTime - Must be specified in ISO 8601 format. Will be stored in UTC.
  • Integer - 32-bit value.
  • LargeInteger - 64-bit value.
  • String - 256 characters maximum
deletedDateTime DateTimeOffset Date and time when this object was deleted. Always null when the object hasn't been deleted. Inherited from directoryObject.
isSyncedFromOnPremises Boolean Indicates if this extension property was synced from on-premises active directory using Azure AD Connect. Read-only.
name String Name of the extension property. Not nullable.
targetObjects String collection Following values are supported. Not nullable.
  • User
  • Group
  • Organization
  • Device
  • Application

Relationships

None

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.extensionProperty",
  "id": "String (identifier)",
  "deletedDateTime": "String (timestamp)",
  "appDisplayName": "String",
  "name": "String",
  "dataType": "String",
  "isSyncedFromOnPremises": "Boolean",
  "targetObjects": [
    "String"
  ]
}

See also