tipo de recurso educationSynchronizationProfile

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 un conjunto de configuraciones que se usan para sincronizar las entidades educativas y la información de la lista de un directorio de origen con Microsoft Entra ID. Este recurso proporciona una representación mediante programación que se usa en School Data Sync.

Métodos

Método	Tipo de valor devuelto	Descripción
Enumerar perfiles	educationSynchronizationProfile (colección)	Obtenga una lista de todos los perfiles de sincronización del inquilino.
Obtener perfil	educationSynchronizationProfile	Recupere un perfil específico dado el identificador de perfil.
Crear perfil	Ninguno	Cree un nuevo perfil de sincronización.
Eliminar perfil	educationSynchronizationProfile	Elimine un perfil específico dado el identificador de perfil.
Pausar perfil	Ninguno	Pausar una sincronización en curso.
Reanudar perfil	Ninguno	Reanudar una sincronización en pausa.
Restablecer perfil	Ninguno	Restablezca el estado del perfil y reinicie la sincronización.
Inicio del perfil CSV	colección educationFileSynchronizationVerificationMessage	Compruebe los archivos de origen cargados e inicie la sincronización. Solo se aplica cuando el proveedor de datos es educationCsvDataProvider.
Obtención de la dirección URL de carga de CSV	string	Devuelve la dirección URL de corta duración para cargar archivos de datos CSV. Solo se aplica cuando el proveedor de datos es educationCsvDataProvider.
Obtener estado	educationsynchronizationProfileStatus	Devuelve el estado de un perfil de sincronización específico.
Obtener errores	colección educationSynchronizationError	Obtenga todos los errores generados durante la sincronización.

Propiedades

Propiedad	Tipo	Descripción
id	Cadena	Identificador único del recurso. (solo lectura)
displayName	Cadena	Nombre del perfil de configuración para sincronizar identidades.
Dataprovider	educationSynchronizationDataProvider	Proveedor de datos usado para el perfil.
expirationDate	Fecha	La fecha en que se debe considerar que el perfil ha expirado y deja de sincronizarse. Proporcione la fecha en YYYY-MM-DD formato, siguiendo la norma ISO 8601. El valor máximo es de 18 meses a partir de la creación del perfil. (opcional)
handleSpecialCharacterConstraint	Bool	Determina si School Data Sync debe reemplazar automáticamente los caracteres especiales no admitidos durante la sincronización desde el origen.
identitySynchronizationConfiguration	educationIdentitySynchronizationConfiguration	Determina cómo debe crear el perfil nuevo o coincidir con los usuarios Microsoft Entra existentes.
licensesToAssign	colección educationSynchronizationLicenseAssignment	Configuración de la configuración de licencia.
state	educationSynchronizationProfileState	Estado del perfil. Los valores posibles son: provisioning, provisioned, provisioningFailed, deleting y deletionFailed.

Relaciones

Relación	Tipo	Descripción
errores	colección educationSynchronizationError	Todos los errores asociados a este perfil de sincronización.
profileStatus	educationSynchronizationProfileStatus	Estado de sincronización.

Proveedores de datos

Cada educationSynchronizationProfile debe especificar uno de los siguientes proveedores de datos para usarlo como origen de sincronización.

Data Provider	Descripción
educationCsvDataProvider	Archivos CSV cargados en la dirección URL de SAS del perfil
educationOneRosterApiDataProvider	OneRoster v1.1 API
educationPowerSchoolDataProvider	API PowerSchool

Representación JSON

A continuación se muestra una representación JSON del recurso educationSynchronizationProfile .

{
  "id": "String",
  "displayName": "String",
  "state": {
    "@odata.type": "microsoft.graph.educationSynchronizationProfileState"
  },
  "profileStatus": {
    "@odata.type": "microsoft.graph.educationSynchronizationProfileStatus"
  },
  "errors": [
    {
      "@odata.type": "microsoft.graph.educationSynchronizationProfileStatus"
    }
  ],
  "dataProvider": {
    "@odata.type": "microsoft.graph.educationCsvDataProvider"
  },
  "identitySynchronizationConfiguration": {
    "@odata.type": "microsoft.graph.educationIdentitySynchronizationConfiguration"
  },
  "licensesToAssign": [
    {
      "@odata.type": "microsoft.graph.educationSynchronizationLicenseAssignment"
    }
  ],
  "handleSpecialCharacterConstraint": "Boolean",
  "expirationDate": "Date"
}