Type de ressource extensionProperty (extensions d’annuaire)

  • Article

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Représente une extension de répertoire qui peut être utilisée pour ajouter une propriété personnalisée aux objets d’annuaire sans nécessiter de magasin de données externe. Par exemple, si une organisation dispose d’une application métier qui nécessite un ID Skype pour chaque utilisateur de l’annuaire, Microsoft Graph peut être utilisé pour inscrire une nouvelle propriété nommée skypeId sur l’objet Utilisateur de l’annuaire, puis écrire une valeur dans la nouvelle propriété pour un utilisateur spécifique. Les extensions d’annuaire peuvent également être disponibles dans les applications multilocataires qui ont été autorisées dans le locataire.

Les extensions d’annuaire peuvent être ajoutées aux objets d’annuaire suivants :

Seules 100 valeurs d’extension, sur tous les types et toutes les applications, peuvent être écrites dans une seule instance de ressource Microsoft Entra.

Utilisez cette ressource et les méthodes associées pour gérer les définitions d’extension de répertoire. Pour gérer les données d’extension d’annuaire sur l’instance de ressource étendue, utilisez la même requête REST que celle que vous utilisez pour gérer l’instance de ressource.

Pour plus d’informations sur l’extensibilité de Microsoft Graph, consultez Ajouter des propriétés personnalisées aux ressources à l’aide d’extensions.

Hérite de directoryObject.

Remarque

Les extensions créées via Azure AD Graph (actuellement dans son cycle de mise hors service) et les données personnalisées synchronisées à partir d’Active Directory local à l’aide de Microsoft Entra Connect Sync sont représentées sous forme d’extensions d’annuaire dans Microsoft Graph.

Méthodes

Méthode Type renvoyé Description
Créer extensionProperty Créez une extension d’annuaire sur un objet d’application.
List collection extensionProperty Répertorier les extensions d’annuaire sur un objet d’application.
Obtenir collection extensionProperty Obtenir une extension d’annuaire d’un objet d’application.
Supprimer Aucune Supprimer l’extension d’annuaire d’un objet d’application. Vous pouvez supprimer uniquement les extensions d’annuaire qui ne sont pas synchronisées à partir d’Active Directory local.

Conseil

  1. Pour définir une valeur pour la propriété d’extension sur une instance d’une ressource spécifiée dans targetObjects, utilisez l’opération Update de la ressource. Par exemple, l’API Mettre à jour l’utilisateur pour définir la valeur d’un utilisateur.
  2. Pour supprimer la propriété d’extension et sa valeur d’une instance d’une ressource spécifiée dans targetObjects, définissez la valeur de la propriété d’extension sur null.

Propriétés

Propriété Type Description
appDisplayName Chaîne Nom d’affichage de l’objet d’application sur lequel cette propriété d’extension est définie. En lecture seule.
dataType String Spécifie le type de données de la valeur que la propriété d’extension peut contenir. Les valeurs suivantes sont prises en charge.
  • Binary - 256 octets maximum
  • Boolean
  • DateTime - Doit être spécifié au format ISO 8601. Conservées au format UTC.
  • Integer - Valeur 32 bits.
  • LargeInteger - Valeur 64 bits.
  • String - 256 caractères maximum
Ne pouvant accepter la valeur null. Pour les extensions de répertoire à plusieurs valeurs, ces limites s’appliquent par valeur dans la collection.
deletedDateTime DateTimeOffset Date et heure de suppression de cet objet. Toujours null lorsque l’objet n’a pas été supprimé. Hérité de directoryObject.
isSyncedFromOnPremises Valeur booléenne Indique si cette propriété d’extension a été synchronisée à partir d’Active Directory local à l’aide de Microsoft Entra Connect. En lecture seule.
name Chaîne Nom de la propriété d’extension. Ne pouvant accepter la valeur null. Prend en charge $filter (eq).
isMultiValued Valeur booléenne Définit l’extension de répertoire en tant que propriété à valeurs multiples. Quand truela valeur est , la propriété d’extension d’annuaire peut stocker une collection d’objets du dataType ; par exemple, une collection de types de chaînes telles que "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]. La valeur par défaut est false. Prend en charge $filter (eq).
targetObjects String collection Les valeurs suivantes sont prises en charge. Ne peut pas accepter une valeur null.
  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

Relations

Aucun

Représentation JSON

La représentation JSON suivante montre le type de ressource.

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

Contenu connexe