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.

Executa a sincronização executando periodicamente em segundo plano, sondando as alterações em um diretório e empurrando-as 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 sincronizaçãoJob synchronizationJob Ler propriedades e relações de um objeto SynchronizationJob.
Create synchronizationJob Crie um novo trabalho para um determinado aplicativo.
Start Nenhum Inicie a sincronização. Se o trabalho está em estado de pausa, ele continua a partir do ponto em que o trabalho foi pausado. Se o trabalho estiver em quarentena, o status de quarentena será limpo.
Restart Nenhum Force o trabalho a recomeçar e reprocessar todos os objetos no diretório.
Pause Nenhum Interrompa temporariamente a sincronização. Todo o progresso, incluindo o estado do trabalho, é persistente, e o trabalho continuará de onde parou quando uma chamada Inicial for feita.
Delete Nenhum Pare a sincronização e exclua permanentemente todo o estado associado ao trabalho.
Obter sincronizaçãoSchema synchronizationSchema Recupere o esquema de sincronização eficaz do trabalho.
Atualizar sincronizaçãoSchema Nenhum Atualize o esquema de sincronização do trabalho.
Validar credenciais Nenhum Teste as credenciais fornecidas em relação ao 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 Cadeia de caracteres Identificador de trabalho de sincronização exclusivo. Somente leitura.
Cronograma synchronizationSchedule Agendar usado para executar o trabalho. Somente leitura.
status synchronizationStatus Status do trabalho, que inclui quando o trabalho foi executado pela última vez, estado do trabalho atual e erros.
sincronizaçãoJobSettings keyValuePair Configurações associadas ao trabalho. Algumas configurações são herdadas do modelo.
Templateid Cadeia de caracteres Identificador do modelo de sincronização em que esse trabalho se baseia.

Relações

Relação Tipo Descrição
bulkUpload bulkUpload A operação de carregamento em massa para o trabalho.
Esquema 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"
}