educationOneRosterApiDataProvider resource type (preterido)

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Cuidado

A API do Perfil de Sincronização de Educação foi preterida e deixará de devolver dados a 31 de dezembro de 2024. Para obter informações sobre como migrar para a nova API de Dados do Setor, veja Transição do School Data Sync (Clássico).

Utilizado para configurar o perfil de sincronização de dados escolares quando a API oneRoster é utilizada como a origem de entrada.

Derivado de educationSynchronizationDataProvider.

Propriedades

Propriedade	Tipo	Descrição
connectionUrl	Cadeia de caracteres	O URL de ligação à instância do OneRoster.
providerName	Cadeia de caracteres	O nome do Fornecedor de Serviços OneRoster, conforme definido pela especificação oneRoster.
schoolsIds	String collection	A lista de Escola/OrganizaçãosourcedId a sincronizar.
termIds	String collection	A lista de sessões académicas a sincronizar.
connectionSettings	educationSynchronizationConnectionSettings	As definições de OAuth 1.0 ou OAuth 2.0 para a instância do OneRoster.
personalizações	educationSynchronizationCustomizations	Personalização opcional a aplicar ao perfil de sincronização.

Importante

O OneRoster utiliza sessões académicas em vez de um único ano letivo para segmentar os seus dados. Esta segmentação é abstraída na IU do School Data Sync, mas não nesta API. Terá de chamar o ponto final do OneRoster /terms para obter a coleção de IDs de sessões académicas para preencher a termIds coleção.

Relações

Nenhum

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "@odata.type": "microsoft.graph.educationoneRosterApiDataProvider",
  "connectionUrl": "String",
  "providerName": "String",
  "schoolsIds": ["String"],
  "termIds": ["String"],
  "connectionSettings": {
    "clientId": "String",
    "clientSecret": "String"
  }
}