tipo de recurso synchronizationSchema

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.

Define quais objetos são sincronizados e como eles são sincronizados. O esquema de sincronização contém a maioria das informações de configuração para um trabalho de sincronização específico. Normalmente, você personaliza alguns dos mapeamentos de atributo ou adiciona um filtro de escopo para sincronizar apenas objetos que atendem a uma determinada condição.

As seções a seguir descrevem os componentes de alto nível do esquema de sincronização.

Definições de diretório

As definições de diretório fornecem as informações do mecanismo de sincronização sobre diretórios e seus objetos. Por exemplo, a definição do diretório informa ao mecanismo de sincronização que um diretório Microsoft Entra tem objetos chamados usuário e grupo, quais atributos têm suporte para esses objetos e os tipos desses atributos. Para que um objeto e um atributo específicos sejam usados em regras de sincronização/mapeamentos de objeto, eles precisam ser definidos como parte da definição do diretório.

Regras de sincronização

As regras de sincronização são o núcleo da configuração de sincronização. Eles definem para o mecanismo de sincronização como a sincronização deve ser executada, incluindo quais objetos devem ser sincronizados, como os objetos do diretório de origem devem ser combinados com objetos no diretório de destino e como os atributos devem ser transformados quando são sincronizados da origem para o diretório de destino.

Mapeamentos de objetos

Os mapeamentos de objetos são a main parte da regra de sincronização. Cada mapeamento de objeto define como um determinado objeto deve ser sincronizado da origem para o diretório de destino. Em particular, o mapeamento define como um objeto no diretório de origem deve ser combinado com um objeto no diretório de destino, quais filtros de escopo (se houver) devem ser usados para decidir se provisionam um objeto e como os atributos de objeto devem ser transformados quando são sincronizados da origem para o diretório de destino.

Métodos

Método	Tipo de retorno	Descrição
Obter esquema	synchronizationSchema	Leia propriedades e relações do objeto synchronizationSchema .
Atualizar esquema	Nenhum	Atualize o esquema de sincronização.
Excluir esquema	Nenhum	Exclua o esquema personalizado, redefinindo o esquema para a configuração padrão.
Listar operadores de filtro	coleção filterOperatorSchema	Liste todos os operadores com suporte nos filtros de escopo.
Listar funções de mapeamento de atributo	coleção attributeMappingFunctionSchema	Liste todas as funções com suporte nas expressões de mapeamento de atributo.
Expressão de mapeamento de atributo de análise	parseExpressionResponse	Analise uma expressão de cadeia de caracteres em um objeto attributeMappingSource .

Propriedades

Propriedade	Tipo	Descrição
id	Cadeia de caracteres	Identificador exclusivo para o esquema.
synchronizationRules	coleção synchronizationRule	Uma coleção de regras de sincronização configurada para a sincronizaçãoJob ou synchronizationTemplate.
versão	Cadeia de caracteres	A versão do esquema, atualizada automaticamente a cada alteração de esquema.

Relações

Relação	Tipo	Descrição
Diretórios	coleção directoryDefinition	Contém a coleção de diretórios e todos os seus objetos.

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
  "@odata.type": "#microsoft.graph.synchronizationSchema",
  "id": "String (identifier)",
  "synchronizationRules": [
    {
      "@odata.type": "microsoft.graph.synchronizationRule"
    }
  ],
  "version": "String"
}