命名空间:microsoft.graph
表示一个目录扩展,可用于将自定义属性添加到目录对象,而无需外部数据存储。 例如,如果组织有业务线 (LOB) 应用程序需要目录中每个用户的 Skype ID,则可以使用 Microsoft Graph 在目录的 User 对象上注册名为 skypeId 的新属性,然后为特定用户将值写入新属性。
可将目录扩展添加到以下目录对象:
在 所有 类型和 所有 应用程序中,只能将 100 个扩展值写入任何单个 Azure AD 资源。
使用此资源和关联的方法来管理目录扩展定义。 若要管理扩展资源实例上的目录扩展数据,请使用用于管理资源实例的同一 REST 请求。
有关 Microsoft Graph 扩展性的详细信息,请 参阅使用扩展向资源添加自定义属性。
继承自 directoryObject。
Note: 通过 Azure AD Graph 创建的扩展 (已弃用) 和使用 Azure AD Connect Sync 从本地 Active Directory同步的自定义数据表示为 Microsoft Graph 中的目录扩展。
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| 创建 extensionProperties | extensionProperty | 在应用程序对象上创建扩展属性。 |
| 列出 extensionProperties | extensionProperty 集合 | 列出应用程序对象上的扩展属性。 |
| 获取 extensionProperty | extensionProperty 集合 | 列出应用程序对象上的扩展属性。 |
| 删除 extensionProperty | 无 | 从应用程序对象删除扩展属性。 只能删除未从本地 Active Directory 同步的属性。 |
Tip:
- 若要将扩展属性的值设置为 targetObjects 中指定的资源的实例,请使用资源的更新操作。 例如,要为用户设置值的 更新用户 API。
- 若要从 targetObjects 中指定的资源实例中删除扩展属性及其值,请将扩展属性的值设置为
null。
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| appDisplayName | String | 在其中定义此扩展属性的应用程序对象的显示名称。 只读。 |
| DataType | String | 指定扩展属性可以保存的值的数据类型。 支持以下值。 不可为 null。 <ul><li>Binary - 最大 256 字节数</li><li>Boolean</li><li>DateTime - 必须以 ISO 8601 格式指定。 存储为 UTC 格式。</li><li>Integer - 32 位值。</li><li>LargeInteger - 64 位值。</li><li>String - 最大 256 个字符</li></ul> |
| deletedDateTime | DateTimeOffset | 删除此对象的日期和时间。 在对象尚未删除时始终为 null。 继承自 directoryObject。 |
| isSyncedFromOnPremises | Boolean | 指示此扩展属性是否已使用 Azure AD Connect 从本地 Active Directory 同步。 只读。 |
| name | String | 扩展属性的名称。 不可为 null。 |
| targetObjects | 字符串集合 | 支持以下值。 不可为空。 <ul><li>User</li><li>Group</li><li>Organization</li><li>Device</li><li>Application</li></ul> |
关系
无
JSON 表示形式
下面是资源的 JSON 表示形式。
{
"@odata.type": "#microsoft.graph.extensionProperty",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"appDisplayName": "String",
"name": "String",
"dataType": "String",
"isSyncedFromOnPremises": "Boolean",
"targetObjects": [
"String"
]
}
另请参阅
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 keylimesoda)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
