extensionProperty-Ressourcentyp (Verzeichniserweiterungen)
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Stellt eine Verzeichniserweiterung dar, die zum Hinzufügen einer benutzerdefinierten Eigenschaft zu Verzeichnisobjekten verwendet werden kann, ohne dass ein externer Datenspeicher erforderlich ist. Wenn eine Organisation 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-Ressourceninstanz geschrieben werden.
Verwenden Sie diese Ressource und die zugehörigen Methoden, um die Verzeichniserweiterungsdefinitionen zu verwalten. Um die Verzeichniserweiterungsdaten für die erweiterte Ressourceninstanz zu verwalten, verwenden Sie dieselbe REST-Anforderung, die Sie zum Verwalten der Ressourceninstanz 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 in seinem Deaktivierungszyklus) und benutzerdefinierte Daten, die mithilfe der Microsoft Entra Connect-Synchronisierung aus dem lokalen Active Directory synchronisiert werden, werden in Microsoft Graph als Verzeichniserweiterungen dargestellt.
Methoden
| Methode | Rückgabetyp | Beschreibung |
|---|---|---|
| Create | extensionProperty | Erstellen Sie eine Verzeichniserweiterung für ein Anwendungsobjekt. |
| List | extensionProperty-Sammlung | Listet Verzeichniserweiterungen für ein Anwendungsobjekt auf. |
| Get | extensionProperty-Sammlung | Ruft eine Verzeichniserweiterung für ein Anwendungsobjekt ab. |
| Delete | 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. |
Tipp
- Um einen Wert für die Erweiterungseigenschaft auf eine Instanz 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.
- Um die Erweiterungseigenschaft und deren Wert aus einer Instanz einer Ressource zu entfernen, die in targetObjects angegeben ist, legen Sie den Wert der Erweiterungseigenschaft auf fest
null.
Eigenschaften
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| appDisplayName | Zeichenfolge | 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.
|
| 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 | Zeichenfolge | 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.
|
Beziehungen
Keine
JSON-Darstellung
Die folgende JSON-Darstellung zeigt den Ressourcentyp.
{
"@odata.type": "#microsoft.graph.extensionProperty",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"appDisplayName": "String",
"name": "String",
"dataType": "String",
"isSyncedFromOnPremises": "Boolean",
"isMultiValued": "Boolean",
"targetObjects": [
"String"
]
}