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 de versão.

Define quais objetos serão sincronizados e como eles serã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ê personalizará alguns dos mapeamentosde atributos ou adicionará um filtro de scoping para sincronizar somente objetos que atendam 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 de diretório informa ao mecanismo de sincronização que um diretório do Azure AD tem objetos chamados usuário e grupo, quais atributos são suportados para esses objetos e os tipos para esses atributos. Para que um determinado objeto e atributo seja usado em mapeamentos de regras/objetos de sincronização, eles precisam ser definidos como parte da definição de 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 corresponder aos 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

Mapeamentos de objetos são a parte principal 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 parecido com um objeto no diretório de destino, quais filtros de scoping (se algum) devem ser usados para decidir se provisionar 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 as propriedades e as relações do objeto synchronizationSchema.
Atualizar esquema	Nenhuma	Atualize o esquema de sincronização.
Excluir esquema	Nenhuma	Exclua o esquema personalizado, redefinindo o esquema para a configuração padrão.
Listar operadores de filtro	Coleção filterOperatorSchema	Lista todos os operadores com suporte nos filtros de seleção.
Listar funções de mapeamento de atributos	Coleção attributeMappingFunctionSchema	Lista todas as funções com suporte nas expressões de mapeamento de atributos.
Expressão de mapeamento de atributo de análise	parseExpressionResponse	Analisar uma expressão de cadeia de caracteres em um objeto attributeMappingSource.

Propriedades

Propriedade	Tipo	Descrição
id	String	Identificador exclusivo do esquema.
synchronizationRules	Coleção synchronizationRule	Uma coleção de regras de sincronização configuradas para o synchronizationJob ou synchronizationTemplate.
versão	String	A versão do esquema, atualizada automaticamente a cada alteração de esquema.

Relações

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

Representação JSON

Veja a seguir uma representação JSON do recurso.

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