tipo de recurso extensionProperty (extensiones de directorio)

  • Artículo

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Representa una extensión de directorio que se puede usar para agregar una propiedad personalizada a objetos de directorio sin necesidad de un almacén de datos externo. Por ejemplo, si una organización tiene una aplicación de línea de negocio (LOB) que requiere un identificador de Skype para cada usuario del directorio, Microsoft Graph se puede usar para registrar una nueva propiedad denominada skypeId en el objeto User del directorio y, a continuación, escribir un valor en la nueva propiedad para un usuario específico. Las extensiones de directorio también pueden estar disponibles en aplicaciones multiinquilino con consentimiento en el inquilino.

Las extensiones de directorio se pueden agregar a los siguientes objetos de directorio:

Solo se pueden escribir 100 valores de extensión, en todos los tipos y todas las aplicaciones, en cualquier instancia de recurso de Microsoft Entra única.

Use este recurso y los métodos asociados para administrar las definiciones de extensión de directorio. Para administrar los datos de extensión de directorio en la instancia de recurso extendida, use la misma solicitud REST que se usa para administrar la instancia de recurso.

Para obtener más información sobre la extensibilidad de Microsoft Graph, vea Agregar propiedades personalizadas a recursos mediante extensiones.

Se hereda de directoryObject.

Nota:

Las extensiones creadas a través de Azure AD Graph (actualmente en su ciclo de retirada) y los datos personalizados sincronizados desde Active Directory local mediante Microsoft Entra Connect Sync se representan como extensiones de directorio en Microsoft Graph.

Métodos

Método Tipo de valor devuelto Descripción
Crear extensionProperty Cree una extensión de directorio en un objeto de aplicación.
Lista Colección extensionProperty Enumera las extensiones de directorio en un objeto de aplicación.
Get Colección extensionProperty Obtenga una extensión de directorio de un objeto de aplicación.
Delete Ninguno Elimine la extensión de directorio de un objeto de aplicación. Solo puede eliminar extensiones de directorio que no se sincronicen desde Active Directory local.

Sugerencia

  1. Para establecer un valor para la propiedad de extensión en una instancia de un recurso especificado en targetObjects, use la operación Update del recurso. Por ejemplo, update user API (Actualizar API de usuario) para establecer el valor de un usuario.
  2. Para quitar la propiedad de extensión y su valor de una instancia de un recurso especificado en targetObjects, establezca el valor de la propiedad nullde extensión en .

Propiedades

Propiedad Tipo Descripción
appDisplayName Cadena Nombre para mostrar del objeto de aplicación en el que se define esta propiedad de extensión. Solo lectura.
dataType Cadena Especifica el tipo de datos del valor que puede contener la propiedad de extensión. Se admiten los siguientes valores.
  • Binary - 256 bytes como máximo
  • Boolean
  • DateTime - Debe especificarse en formato ISO 8601. Se almacenarán en UTC.
  • Integer - Valor de 32 bits.
  • LargeInteger - Valor de 64 bits.
  • String - Máximo de 256 caracteres
No admite valores NULL. En el caso de las extensiones de directorio multivalor, estos límites se aplican por valor en la colección.
deletedDateTime DateTimeOffset Fecha y hora en que se eliminó este objeto. Siempre null cuando el objeto no se haya eliminado. Heredado de directoryObject.
isSyncedFromOnPremises Booleano Indica si esta propiedad de extensión se sincronizó desde Active Directory local mediante Microsoft Entra Connect. Solo lectura.
name Cadena Nombre de la propiedad de extensión. No admite valores NULL. Admite $filter (eq).
isMultiValued Booleano Define la extensión de directorio como una propiedad con varios valores. Cuando truees , la propiedad de extensión de directorio puede almacenar una colección de objetos de dataType; por ejemplo, una colección de tipos de cadena como "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]. El valor predeterminado es false. Admite $filter (eq).
targetObjects Colección de cadenas Se admiten los siguientes valores. No admite valores NULL.
  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

Relaciones

Ninguno

Representación JSON

La siguiente representación JSON muestra el tipo de recurso.

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

Contenido relacionado