Descrição geral da API de configuração do utilizador no Microsoft Graph (pré-visualização)

A API de configuração do utilizador no Microsoft Graph permite que a sua aplicação armazene e obtenha dados de configuração por pasta juntamente com o conteúdo de uma caixa de correio Exchange Online. Um objeto userConfiguration (item associado à pasta, FAI) está associado a uma pasta de correio específica e identificado por uma chave exclusiva nessa pasta. Cada objeto aplica-se a uma única pasta em vez de a caixa de correio inteira. Este âmbito permite que a sua aplicação mantenha o estado próximo do conteúdo a que está relacionada.

A API dá à sua aplicação controlo completo de criação, leitura, atualização e eliminação sobre objetos userConfiguration e suporta vários estilos de payload que lhe permitem armazenar o formato mais adequado ao seu cenário: dados binários arbitrários, XML serializado ou pares chave-valor fortemente escritos.

Porquê integrar com a API de configuração do utilizador?

Armazenar o estado e as definições da aplicação por pasta

Muitas aplicações precisam de um local fiável para manter as definições ou o estado que diz respeito a uma pasta de correio específica. Os exemplos incluem o ID do item sincronizado pela última vez para uma ferramenta de sincronização de caixa de entrada, as preferências de visualização de uma pasta personalizada ou os sinalizadores de funcionalidades no âmbito de uma pasta. A API de configuração de utilizador fornece à sua aplicação uma localização de armazenamento dedicada e residente na caixa de correio para este tipo de dados, para que não tenha de manter um arquivo externo separado.

Manter os metadados da aplicação juntamente com o conteúdo da caixa de correio

Os objetos de configuração do utilizador estão dentro da caixa de correio. Como resultado, os dados estão próximos do conteúdo a que se relaciona e os mesmos controlos de acesso que protegem os outros conteúdos da caixa de correio do utilizador também protegem estes dados. Este padrão de armazenamento faz com que a API seja adequada para metadados de aplicações que devem permanecer ligados a uma pasta específica.

Escolher o estilo de payload que se adequa aos seus dados

O recurso userConfiguration suporta três propriedades de payload e pode escolher a forma certa para o seu cenário:

• Utilize binaryData para conteúdo binário arbitrário.
• Utilize xmlData para XML serializado.
• Utilize structuredData para armazenar pares chave-valor escritos sem serializar o seu próprio formato. Os tipos complexos structuredDataEntry e structuredDataEntryTypedValue modelam os tipos de valor suportados.

Um único objeto userConfiguration pode transportar qualquer combinação destas propriedades. Pode misturar estilos de payload à medida que a sua aplicação evolui.

Referência da API

Está procurando a referência de API para esse serviço? Veja o tipo de recurso userConfiguration e os respetivos métodos suportados.

Próximas etapas

• Explore o tipo de recurso userConfiguration e os respetivos métodos suportados (Criar, Obter, Atualizar, Eliminar).
• Experimente a API de configuração do utilizador no Graph Explorer.