extensionProperty 资源类型 (目录扩展)

  • 项目

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

表示可用于将自定义属性添加到目录对象而无需外部数据存储的目录 扩展 。 例如，如果组织的业务线 (LOB) 应用程序中需要目录中每个用户的 Skype ID，则 Microsoft Graph 可用于在目录的 User 对象上注册名为 skypeId 的新属性，然后将值写入特定用户的新属性。 在租户中已同意的多租户应用中也可以使用目录扩展。

可将目录扩展添加到以下目录对象：

所有类型和所有应用程序只能将 100 个扩展值写入任何单个Microsoft Entra资源实例。

使用此资源和关联的方法来管理目录扩展定义。 若要管理扩展资源实例上的目录扩展数据，请使用用于管理资源实例的相同 REST 请求。

有关 Microsoft Graph 扩展性的详细信息，请参阅 使用扩展向资源添加自定义属性。

继承自 directoryObject。

注意

通过 Azure AD Graph 创建的扩展 (当前处于停用周期) ，使用 Microsoft Entra Connect Sync 从 本地 Active Directory 同步的自定义数据在 Microsoft Graph 中表示为目录扩展。

方法

方法 返回类型 说明
创建 extensionProperties extensionProperty 在应用程序对象上创建目录扩展。
列出 extensionProperties extensionProperty 集合 列出应用程序对象的目录扩展。
获取 extensionProperty extensionProperty 集合 获取应用程序对象的目录扩展。
删除 extensionProperty 无 从应用程序对象中删除目录扩展。 只能删除未从本地 Active Directory 同步的目录扩展。

提示

  1. 若要将扩展属性的值设置为 targetObjects 中指定的资源实例，请使用资源的 Update 操作。 例如， 更新用户 API 以设置用户的值。
  2. 若要从 targetObjects 中指定的资源实例中删除扩展属性及其值，请将扩展属性的值设置为 null。

属性

属性 类型 说明
appDisplayName String 定义此扩展属性时所基于的应用程序对象的显示名称。 此为只读属性。
DataType String 指定扩展属性可以容纳的值的数据类型。 支持以下值。
  • Binary - 最大 256 字节
  • Boolean
  • DateTime - 必须以 ISO 8601 格式指定。 存储为 UTC 格式。
  • Integer - 32 位值。
  • LargeInteger - 64 位值。
  • String - 最多 256 个字符
不可为 null。 对于多值目录扩展，这些限制适用于集合中的每个值。
deletedDateTime DateTimeOffset 删除此对象的日期和时间。 在对象尚未删除时始终为 null。 继承自 directoryObject。
isSyncedFromOnPremises 布尔值 指示是否使用 Microsoft Entra Connect 从本地 Active directory 同步此扩展属性。 只读。
name String 扩展属性的名称。 不可为 null。 支持 $filter（eq）。
isMultiValued 布尔值 将目录扩展定义为多值属性。 当为 时 true，目录扩展属性可以存储 dataType 的对象集合;例如，字符串类型的集合，例如 "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]。 默认值为 false。 支持 $filter（eq）。
targetObjects 字符串集合 支持以下值。 不可为空。
  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

关系

无

JSON 表示形式

下面是资源的 JSON 表示形式。

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

相关内容