educationSynchronizationProfile resource type (preterido)

Artigo
07/23/2024

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).

Representa um conjunto de configurações utilizadas para sincronizar entidades de educação e informações de lista de um diretório de origem para o Microsoft Entra ID. Este recurso fornece uma representação programática utilizada no School Data Sync.

Métodos

Método	Tipo de retorno	Descrição
Listar perfis	educationSynchronizationProfile collection (coleção educationSynchronizationProfile )	Obtenha uma lista de todos os perfis de sincronização no inquilino.
Obter perfil	educationSynchronizationProfile	Obtenha um perfil específico com o identificador de perfil.
Criar perfil	educationSynchronizationProfile	Crie um novo perfil de sincronização.
Atualizar perfil	educationSynchronizationProfile	Atualize as propriedades de um perfil de sincronização de dados escolares existente no inquilino.
Excluir perfil	Nenhum	Elimine um perfil específico dado o identificador de perfil.
Colocar o perfil em pausa	Nenhum	Colocar em pausa uma sincronização contínua.
Retomar perfil	Nenhum	Retomar uma sincronização em pausa.
Repor perfil	Nenhum	Reponha o estado do perfil e reinicie a sincronização.
Iniciar perfil CSV	educationFileSynchronizationVerificationMessage collection (coleção educationFileSynchronizationVerificationMessage)	Verifique os ficheiros de origem carregados e inicie a sincronização. Aplica-se apenas quando o fornecedor de dados é educationCsvDataProvider.
Obter o URL de carregamento CSV	string	Devolva o URL de curta duração para carregar ficheiros de dados CSV. Aplica-se apenas quando o fornecedor de dados é educationCsvDataProvider.
Obter estado	educationsynchronizationProfileStatus	Devolver o estado de um perfil de sincronização específico.
Obter erros	educationSynchronizationError collection (Coleção educationSynchronizationError )	Obtenha todos os erros gerados durante a sincronização.

Propriedades

Propriedade	Tipo	Descrição
id	Cadeia de caracteres	O identificador exclusivo do recurso. (só de leitura)
displayName	Cadeia de caracteres	Nome do perfil de configuração para sincronizar identidades.
dataProvider	educationSynchronizationDataProvider	O fornecedor de dados utilizado para o perfil.
expirationDate	Data	A data em que o perfil deve ser considerado expirou e cessar a sincronização. Indique a data no `YYYY-MM-DD` formato, seguindo ISO 8601. O valor máximo é 18 meses após a criação do perfil. (opcional)
handleSpecialCharacterConstraint	Bool	Determina se o School Data Sync deve substituir automaticamente carateres especiais não suportados ao sincronizar a partir da origem.
identitySynchronizationConfiguration	educationIdentitySynchronizationConfiguration	Determina como o Perfil deve criar utilizadores novos ou corresponder a utilizadores existentes do Microsoft Entra.
licensesToAssign	educationSynchronizationLicenseAssignment collection (Coleção educationSynchronizationLicenseAssignment)	Configuração da configuração da licença.
state	educationSynchronizationProfileState	O estado do perfil. Os valores possíveis são: `provisioning`, `provisioned`, `provisioningFailed`, `deleting`, `deletionFailed`.

Relações

Relação	Tipo	Descrição
erros	educationSynchronizationError collection (Coleção educationSynchronizationError )	Todos os erros associados a este perfil de sincronização.
profileStatus	educationSynchronizationProfileStatus	O estado da sincronização.

Provedores de dados

Cada educationSynchronizationProfile tem de especificar um dos seguintes fornecedores de dados a utilizar como origem de sincronização.

Data Provider	Descrição
educationCsvDataProvider	Ficheiros CSV carregados para o URL de SAS do Perfil
educationOneRosterApiDataProvider	OneRoster v1.1 API
educationPowerSchoolDataProvider	API da PowerSchool

Representação JSON

Segue-se uma representação JSON do recurso educationSynchronizationProfile .

{
  "id": "String",
  "displayName": "String",
  "state": "String",
  "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"
}

Compartilhar via