extensionProperty-Ressourcentyp (Verzeichniserweiterungen)

  • Artikel

Namespace: microsoft.graph

Stellt eine Verzeichniserweiterung dar, die zum Hinzufügen einer benutzerdefinierten Eigenschaft zu Verzeichnisobjekten verwendet werden kann, ohne dass ein externer Datenspeicher erforderlich ist. Wenn ein organization beispielsweise über eine Branchenanwendung verfügt, die eine Skype-ID für jeden Benutzer im Verzeichnis erfordert, kann Microsoft Graph verwendet werden, um eine neue Eigenschaft namens skypeId für das User-Objekt des Verzeichnisses zu registrieren und dann einen Wert für einen bestimmten Benutzer in die neue Eigenschaft zu schreiben. Verzeichniserweiterungen können auch in mehrinstanzenfähigen Apps verfügbar sein, denen im Mandanten zugestimmt wurde.

Verzeichniserweiterungen können folgenden Verzeichnisobjekten hinzugefügt werden:

Nur 100 Erweiterungswerte für alle Typen und Anwendungen können in eine einzelne Microsoft Entra-Ressource geschrieben werden.

Verwenden Sie diese Ressource und die zugehörigen Methoden, um die Verzeichniserweiterungsdefinitionen zu verwalten. Um die Verzeichniserweiterungsdaten für die erweiterte Ressource instance zu verwalten, verwenden Sie dieselbe REST-Anforderung, die Sie zum Verwalten der Ressource instance verwenden.

Weitere Informationen zur Microsoft Graph-Erweiterbarkeit finden Sie unter Hinzufügen benutzerdefinierter Eigenschaften zu Ressourcen mithilfe von Erweiterungen.

Erbt von directoryObject.

Hinweis

Erweiterungen, die über Azure AD Graph erstellt wurden (derzeit im Deaktivierungszyklus) und benutzerdefinierte Daten, die über lokales Active Directory mithilfe von Microsoft Entra Connect Sync synchronisiert werden, werden in Microsoft Graph als Verzeichniserweiterungen dargestellt.

Methoden

Methode Rückgabetyp Beschreibung
extensionProperties erstellen extensionProperty Erstellen Sie eine Verzeichniserweiterung für ein Anwendungsobjekt.
extensionProperties auflisten extensionProperty-Sammlung Listet Verzeichniserweiterungen für ein Anwendungsobjekt auf.
extensionProperty abrufen extensionProperty-Sammlung Ruft eine Verzeichniserweiterung für ein Anwendungsobjekt ab.
extensionProperty löschen Keine Löschen sie die Verzeichniserweiterung aus einem Anwendungsobjekt. Sie können nur Verzeichniserweiterungen löschen, die nicht aus dem lokalen Active Directory synchronisiert werden.
Abrufen verfügbarer Erweiterungen extensionProperty-Sammlung Gibt alle Verzeichniserweiterungsdefinitionen zurück, die in einem Verzeichnis registriert wurden, auch über mehrinstanzenfähige Apps.

Tipp

  1. Um einen Wert für die Erweiterungseigenschaft auf eine instance einer Ressource festzulegen, die in targetObjects angegeben ist, verwenden Sie den Update-Vorgang der Ressource. Beispiel: Die Benutzeraktualisierungs-API , um den Wert für einen Benutzer festzulegen.
  2. Um die Erweiterungseigenschaft und ihren Wert aus einem instance einer Ressource zu entfernen, die in targetObjects angegeben ist, legen Sie den Wert der Erweiterungseigenschaft auf festnull.

Eigenschaften

Eigenschaft Typ Beschreibung
appDisplayName String Anzeigename des Anwendungsobjekts, für das diese Erweiterungseigenschaft definiert ist. Schreibgeschützt.
dataType String Gibt den Datentyp des Werts an, den die Erweiterungseigenschaft enthalten kann. Folgende Werte werden unterstützt.
  • Binary – maximal 256 Bytes
  • Boolean
  • DateTime – Muss im ISO 8601-Format angegeben werden. Wird in UTC gespeichert.
  • Integer – 32-Bit-Wert.
  • LargeInteger – 64-Bit-Wert.
  • String - maximal 256 Zeichen
Lässt keine NULL-Werte zu. Für mehrwertige Verzeichniserweiterungen gelten diese Grenzwerte pro Wert in der Sammlung.
deletedDateTime DateTimeOffset Datum und Uhrzeit, zu der dieses Objekt gelöscht wurde. Immer null, wenn das Objekt nicht gelöscht wurde. Geerbt von directoryObject.
isSyncedFromOnPremises Boolesch Gibt an, ob diese Erweiterungseigenschaft aus dem lokalen Active Directory mithilfe von Microsoft Entra Connect synchronisiert wurde. Schreibgeschützt.
name String Name der Erweiterungseigenschaft. Lässt keine NULL-Werte zu. Unterstützt $filter (eq).
isMultiValued Boolesch Definiert die Verzeichniserweiterung als mehrwertige Eigenschaft. Bei truekann die Verzeichniserweiterungseigenschaft eine Auflistung von Objekten des dataType speichern, z. B. eine Auflistung von Zeichenfolgentypen wie "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]. Der Standardwert ist false. Unterstützt $filter (eq).
targetObjects Zeichenfolgensammlung Folgende Werte werden unterstützt. Lässt keine Nullwerte zu.
  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

Beziehungen

Keine

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

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

Verwandte Inhalte