тип ресурса extensionProperty (расширения каталогов)

  • Статья

Пространство имен: microsoft.graph

Представляет расширение каталога , которое можно использовать для добавления пользовательского свойства в объекты каталога без необходимости использования внешнего хранилища данных. Например, если в организации есть бизнес-приложение ( LOB), которому требуется идентификатор Skype для каждого пользователя в каталоге, Microsoft Graph можно использовать для регистрации нового свойства с именем skypeId в объекте User каталога, а затем записать значение в новое свойство для конкретного пользователя. Расширения каталогов также могут быть доступны в мультитенантных приложениях, на которые было предоставлено согласие в клиенте.

Расширения каталогов можно добавить в следующие объекты каталога:

В любой ресурс Microsoft Entra можно записать только 100 значений расширений для всех типов и всех приложений.

Используйте этот ресурс и связанные методы для управления определениями расширений каталогов. Чтобы управлять данными расширения каталога в расширенном экземпляре ресурса, используйте тот же запрос REST, который используется для управления экземпляром ресурса.

Дополнительные сведения о расширяемости Microsoft Graph см. в статье Добавление настраиваемых свойств в ресурсы с помощью расширений.

Наследуется от directoryObject.

Примечание.

Расширения, созданные с помощью Azure AD Graph (в настоящее время в цикле прекращения использования) и пользовательские данные, синхронизированные из локальная служба Active Directory с помощью Microsoft Entra Connect Sync, представлены в Microsoft Graph в виде расширений каталогов.

Методы

Метод Возвращаемый тип Описание
Создание объекта extensionProperties extensionProperty Создайте расширение каталога в объекте приложения.
Список объектов extensionProperties Коллекция extensionProperty Вывод списка расширений каталогов в объекте приложения.
Получение объекта extensionProperty Коллекция extensionProperty Получите расширение каталога и объект приложения.
Удаление объекта extensionProperty Нет Удаление расширения каталога из объекта приложения. Вы можете удалить только расширения каталогов, которые не синхронизированы из локальной службы Active Directory.
Получение доступных расширений Коллекция extensionProperty Возвращает все определения расширений каталогов, зарегистрированные в каталоге, в том числе через мультитенантные приложения.

Совет

  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 Boolean Указывает, было ли это свойство расширения синхронизировано из локальной службы Active Directory с помощью Microsoft Entra Connect. Только для чтения.
name String Имя свойства расширения. Значение null не допускается. Поддерживает $filter (eq).
isMultiValued Boolean Определяет расширение каталога как многозначное свойство. При trueзначении свойство расширения каталога может хранить коллекцию объектов dataType, например коллекцию строковых типов, например "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]. Значение по умолчанию — false. Поддерживает $filter (eq).
targetObjects Коллекция строк Поддерживаются следующие значения. Значение null не допускается.
  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

Связи

Нет

Представление JSON

Ниже указано представление ресурса в формате JSON.

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

Связанные материалы