synchronizationSchema resource type

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 que objetos são sincronizados e como são sincronizados. O esquema de sincronização contém a maioria das informações de configuração para uma tarefa de sincronização específica. Normalmente, personaliza alguns dos mapeamentos de atributos ou adiciona um filtro de âmbito para sincronizar apenas objetos que satisfaçam uma determinada condição.

As secções seguintes 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 motor de sincronização sobre os diretórios e os respetivos objetos. Por exemplo, a definição do diretório indica ao motor de sincronização que um diretório do Microsoft Entra tem objetos com o nome utilizador e grupo, que atributos são suportados para esses objetos e os tipos desses atributos. Para que um determinado objeto e atributo seja utilizado em regras de sincronização/mapeamentos de objetos, estes têm de 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 da sincronização. Definem para o motor de sincronização a forma como a sincronização deve ser executada, incluindo que objetos devem ser sincronizados, como os objetos do diretório de origem devem ser correspondidos 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 parte principal da regra de sincronização. Cada mapeamento de objetos define como um determinado objeto deve ser sincronizado da origem para o diretório de destino. Em particular, o mapeamento define a forma como um objeto no diretório de origem deve ser correspondido com um objeto no diretório de destino, quais os filtros de âmbito (se existirem) que devem ser utilizados para decidir se deve aprovisionar 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
Get	synchronizationSchema	Ler propriedades e relações do objeto synchronizationSchema .
Atualizar	Nenhum(a)	Atualize o esquema de sincronização.
Reset	Nenhum	Elimine o esquema personalizado, repondo o esquema para a configuração predefinida.
Obter operadores do filtro de esquema	filterOperatorSchema collection	Liste todos os operadores suportados nos filtros de âmbito.
Obter funções de esquema	attributeMappingFunctionSchema collection	Liste todas as funções suportadas nas expressões de mapeamento de atributos.
Analisar expressão de mapeamento de atributos	parseExpressionResponse	Analise uma expressão de cadeia num objeto attributeMappingSource .

Propriedades

Propriedade	Tipo	Descrição
id	Cadeia de caracteres	Identificador exclusivo do esquema.
synchronizationRules	synchronizationRule collection (coleção synchronizationRule )	Uma coleção de regras de sincronização configuradas para synchronizationJob ou synchronizationTemplate.
versão	Cadeia de caracteres	A versão do esquema, atualizada automaticamente com 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 respetivos objetos.

Representação JSON

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

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