synchronizationJob resource type (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 Versão.

Efetua a sincronização ao executar periodicamente em segundo plano, consultar alterações num diretório e enviá-las para outro diretório. A tarefa de sincronização é sempre específica de uma determinada instância de uma aplicação no seu inquilino. Como parte da configuração da tarefa de sincronização, tem de dar autorização para ler e escrever objetos no diretório de destino e personalizar o esquema de sincronização da tarefa.

Métodos

Método	Tipo de retorno	Descrição
List	synchronizationJob collection	Listar tarefas existentes para uma determinada instância de aplicação (principal de serviço).
Get	synchronizationJob	Ler propriedades e relações de um objeto synchronizationJob.
Create	synchronizationJob	Crie uma nova tarefa para uma determinada aplicação.
Start	Nenhum	Iniciar a sincronização. Se a tarefa estiver num estado em pausa, continua a partir do ponto em que a tarefa foi colocada em pausa. Se a tarefa estiver em quarentena, o estado de quarentena será limpo.
Pause	Nenhum	Parar temporariamente a sincronização. Todo o progresso, incluindo o estado da tarefa, é mantido e a tarefa continuará a partir de onde ficou quando for efetuada uma chamada Iniciar .
Restart	Nenhum	Force a tarefa a recomeçar e a reprocessar todos os objetos no diretório.
Delete	Nenhum	Pare a sincronização e elimine permanentemente todo o estado associado à tarefa.
Aprovisionar a pedido	synchronizationJobApplicationParameters collection (Coleção synchronizationJobApplicationParameters )	Representa os objetos que serão aprovisionados e as regras de sincronização executadas. O recurso é utilizado principalmente para o aprovisionamento a pedido.
Validar credenciais	Nenhum	Teste as credenciais fornecidas no diretório de destino.

Propriedades

Propriedade	Tipo	Descrição
id	Cadeia de caracteres	Identificador exclusivo da tarefa de sincronização. Somente leitura.
Cronograma	synchronizationSchedule	Agenda utilizada para executar a tarefa. Somente leitura.
status	synchronizationStatus	Estado da tarefa, que inclui quando a tarefa foi executada pela última vez, o estado do trabalho atual e os erros.
synchronizationJobSettings	keyValuePair	Definições associadas à tarefa. Algumas definições são herdadas do modelo.
templateId	Cadeia de caracteres	Identificador do modelo de sincronização no qual esta tarefa se baseia.

Relações

Relação	Tipo	Descrição
bulkUpload	bulkUpload	A operação de carregamento em massa para a tarefa.
esquema	synchronizationSchema	O esquema de sincronização configurado para a tarefa.

Representação JSON

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

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