Tipo de recurso synchronizationJob

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.

Executa a sincronização periodicamente em segundo plano, sondando alterações em um diretório e fazendo com que elas para outro diretório. O trabalho de sincronização é sempre específico para uma instância específica de um aplicativo em seu locatário. Como parte da configuração do trabalho de sincronização, você precisa dar autorização para ler e gravar objetos no diretório de destino e personalizar o esquema de sincronização do trabalho.

Métodos

Método	Tipo de retorno	Descrição
List	coleção synchronizationJob	Listar trabalhos existentes para uma determinada instância de aplicativo (entidade de serviço).
Obter synchronizationJob	synchronizationJob	Ler propriedades e relações de um objeto synchronizationJob.
Criar	synchronizationJob	Crie um novo trabalho para um determinado aplicativo.
Start	Nenhuma	Inicie a sincronização. Se o trabalho estiver em um estado pausado, ele continuará do ponto em que o trabalho foi pausado. Se o trabalho estiver em quarentena, o status da quarentena será limpo.
Restart	Nenhuma	Force o trabalho a começar de novo e processe todos os objetos no diretório.
Pause	Nenhuma	Interromper temporariamente a sincronização. Todo o progresso, incluindo o estado do trabalho, persiste, e o trabalho continuará de onde foi deixado quando uma chamada iniciar é feita.
Delete	Nenhuma	Pare a sincronização e exclua permanentemente todo o estado associado ao trabalho.
Obter synchronizationSchema	synchronizationSchema	Recupere o esquema de sincronização eficaz do trabalho.
Atualizar synchronizationSchema	Nenhuma	Atualize o esquema de sincronização do trabalho.
Validar credenciais	Nenhuma	Teste as credenciais fornecidas no diretório de destino.
provisionOnDemand	Coleção synchronizationJobApplicationParameters	Representa os objetos que serão provisionados e as regras de sincronização executadas. O recurso é usado principalmente para provisionamento sob demanda.

Propriedades

Propriedade	Tipo	Descrição
id	String	Identificador exclusivo do trabalho de sincronização. Somente leitura.
Cronograma	synchronizationSchedule	Agenda usada para executar o trabalho. Somente leitura.
status	synchronizationStatus	Status do trabalho, que inclui quando o trabalho foi executado pela última vez, o estado atual do trabalho e erros.
synchronizationJobSettings	keyValuePair	Configurações associadas ao trabalho. Algumas configurações são herdadas do modelo.
templateId	String	Identificador do modelo de sincronização em que esse trabalho se baseia.

Relações

Relação	Tipo	Descrição
schema	synchronizationSchema	O esquema de sincronização configurado para o trabalho.

Representação JSON

Veja a seguir uma representação JSON do recurso.

{
  "id": "String (identifier)",
  "schedule": {"@odata.type": "microsoft.graph.synchronizationSchedule"},
  "status": {"@odata.type": "microsoft.graph.synchronizationStatus"},
  "synchronizationJobSettings": {"@odata.type": "microsoft.graph.keyValuePair"},
  "templateId": "String"
}