Reiniciar 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.

Reinicie uma tarefa de sincronização parada, forçando-a a processar novamente todos os objetos no diretório. Opcionalmente, limpa o estado de sincronização existente e os erros anteriores.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) Synchronization.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Application.ReadWrite.OwnedBy Synchronization.ReadWrite.All

Para configurar o aprovisionamento de aplicações ou o aprovisionamento orientado por RH, também tem de ser atribuída ao utilizador de chamada, pelo menos, a função de diretório Administrador de Aplicações na Cloud ou Administrador de Aplicações na Cloud.

Para configurar o Microsoft Entra Cloud Sync, o utilizador que está a chamar também tem de ter, pelo menos, a função de diretório Administrador de Identidade Híbrida .

Solicitação HTTP

{servicePrincipalId} refere-se ao ID do objeto do principal de serviço. O ID é referido como o ID de Objeto da aplicação empresarial nos registos de aplicações no centro de administração do Microsoft Entra.

Pode abordar o principal de serviço com o respetivo ID ou appId. O id e o appId são referidos como o ID do Objeto e o ID da Aplicação (Cliente), respetivamente, nos registos de aplicações no centro de administração do Microsoft Entra.

POST /servicePrincipals/{servicePrincipalId}/synchronization/jobs/{jobId}/restart
POST /servicePrincipals(appId='{appId}')/synchronization/jobs/{jobId}/restart

Cabeçalhos de solicitação

Nome Tipo Descrição
Autorização string {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

No corpo do pedido, forneça um objeto JSON com o seguinte parâmetro.

Parâmetro Tipo Descrição
criteria synchronizationJobRestartCriteria Critérios de reinício

Resposta

Se for bem-sucedido, devolve uma 204 No Content resposta. Não devolve nada no corpo da resposta.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/servicePrincipals/{id}/synchronization/jobs/{jobId}/restart
Authorization: Bearer <token>
Content-type: application/json

{
   "criteria": {
       "resetScope": "Watermark, Escrows, QuarantineState"
   }
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content