tipo de recurso educationSynchronizationProfile

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 de versão.

Representa um conjunto de configurações usadas para sincronizar entidades de educação e informações de lista de um diretório de origem para Azure Active Directory (Azure AD). Esse recurso fornece uma representação programática usada em School Data Sync.

Métodos

Método	Tipo de retorno	Descrição
Listar perfis	[coleção educationSynchronizationProfile]	Obter 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	Pause uma sincronização contínua.
Retomar perfil	Nenhum	Retomar uma sincronização pausada.
Redefinir perfil	Nenhum	Redefina o estado do perfil e reinicie a sincronização.
Iniciar perfil CSV	[educationFileSynchronizationVerificationMessagecollection]	Verifique os arquivos de origem carregados e inicie a sincronização. Aplica-se somente quando o provedor de dados [é educationCsvDataProvider].
Obter URL de carregamento 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]	Obter todos os erros gerados durante a sincronização.

Propriedades

Propriedade	Tipo	Descrição
id	String	O identificador exclusivo do recurso. (somente leitura)
displayName	String	Nome do perfil de configuração para sincronização de identidades.
dataProvider	educationSynchronizationDataProvider	O provedor de dados usado para o perfil.
expirationDate	Data	A data em que o perfil deve ser considerado expirado e interromper a sincronização. Forneça a data em formato YYYY-MM-DD , seguindo a 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 caracteres especiais sem suporte durante a sincronização da origem.
identitySynchronizationConfiguration	educationIdentitySynchronizationConfiguration	Determina como o Perfil deve criar novos ou corresponder aos usuários AAD 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 ser usado como 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"
}