tipo de recurso educationSynchronizationProfile

Artigo
10/21/2023

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.

Representa um conjunto de configurações usadas para sincronizar entidades educacionais e informações de lista de informações de um diretório de origem para Microsoft Entra ID. Esse recurso fornece uma representação programática usada na Sincronização de Dados Escolares.

Métodos

Método	Tipo de retorno	Descrição
Listar perfis	coleção educationSynchronizationProfile	Obtenha uma lista de todos os perfis de sincronização no locatário.
Obter perfil	educationSynchronizationProfile	Recupere um perfil específico dado o identificador de perfil.
Criar perfil	Nenhum	Crie um novo perfil de sincronização.
Excluir perfil	educationSynchronizationProfile	Exclua um perfil específico dado o identificador de perfil.
Pausar perfil	Nenhum	Pausar uma sincronização contínua.
Retomar perfil	Nenhum	Retome uma sincronização pausada.
Redefinir perfil	Nenhum	Redefina o estado do perfil e reinicie a sincronização.
Iniciar o perfil CSV	coleção educationFileSynchronizationVerificationMessage	Verifique os arquivos de origem carregados e inicie a sincronização. Aplica-se somente quando o provedor de dados é educationCsvDataProvider.
Obter URL de carregamento do CSV	string	Retorne a URL de curta duração para carregar arquivos de dados CSV. Aplica-se somente quando o provedor de dados é educationCsvDataProvider.
Obter status	educationsynchronizationProfileStatus	Retorne o status de um perfil de sincronização específico.
Obter erros	coleção educationSynchronizationError	Obtenha todos os erros gerados durante a sincronização.

Propriedades

Propriedade	Tipo	Descrição
id	Cadeia de caracteres	O identificador exclusivo para o recurso. (somente leitura)
displayName	Cadeia de caracteres	Nome do perfil de configuração para sincronização de identidades.
Dataprovider	educationSynchronizationDataProvider	O provedor de dados usado para o perfil.
Expirationdate	Date	A data em que o perfil deve ser considerado expirou e cessar a sincronização. Forneça a data em `YYYY-MM-DD` formato, seguindo ISO 8601. O valor máximo é de 18 meses a partir da criação do perfil. (opcional)
handleSpecialCharacterConstraint	Bool	Determina se a Sincronização de Dados Escolares deve substituir automaticamente caracteres especiais sem suporte durante a sincronização da origem.
identitySynchronizationConfiguration	educationIdentitySynchronizationConfiguration	Determina como o Perfil deve criar ou corresponder aos usuários Microsoft Entra existentes.
licensesToAssign	coleção educationSynchronizationLicenseAssignment	Configuração de configuração de 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	coleção educationSynchronizationError	Todos os erros associados a esse perfil de sincronização.
profileStatus	educationSynchronizationProfileStatus	O status de sincronização.

Provedores de dados

Cada educationSynchronizationProfile deve especificar um dos provedores de dados a seguir a serem usados como a fonte de sincronização.

Data Provider	Descrição
educationCsvDataProvider	Arquivos CSV carregados na URL SAS do perfil
educationOneRosterApiDataProvider	OneRoster v1.1 API
educationPowerSchoolDataProvider	API da PowerSchool

Representação JSON

A seguir está uma representação JSON do 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"
}