Comentários Editar

Tipo de recurso extensionProperty

  • Artigo
  • 2 minutos para o fim da leitura

Namespace: microsoft.graph

Representa uma extensão de diretório que pode ser usada para adicionar uma propriedade personalizada a objetos de diretório sem exigir um armazenamento de dados externo. Por exemplo, se uma organização tiver um aplicativo de linha de negócios (LOB) que exija uma ID do Skype para cada usuário no diretório, o Microsoft Graph poderá ser usado para registrar uma nova propriedade chamada skypeId no objeto User do diretório e, em seguida, gravar um valor na nova propriedade para um usuário específico.

As extensões de diretório podem ser adicionadas aos seguintes objetos de diretório:

Somente 100 valores de extensão, em todos os tipos e todos os aplicativos, podem ser gravados em qualquer recurso Azure AD único.

Use esse recurso e métodos associados para gerenciar as definições de extensão de diretório. Para gerenciar os dados de extensão de diretório na instância de recurso estendido, use a mesma solicitação REST que você usa para gerenciar a instância de recurso.

Para obter mais informações sobre a extensibilidade do Microsoft Graph, consulte Adicionar propriedades personalizadas aos recursos usando extensões.

Herda de directoryObject.

Observação

Extensões criadas por meio do Azure AD Graph (preterido) e dados personalizados sincronizados do Active Directory local usando o Azure AD Connect Sync são representadas como extensões de diretório no Microsoft Graph.

Métodos

Método Tipo de retorno Descrição
Criar extensionProperties extensionProperty Criar uma propriedade de extensão em um objeto de aplicativo.
Listar extensionProperties Coleção extensionProperty Listar propriedades de extensão em um objeto de aplicativo.
Obter extensionProperty Coleção extensionProperty Listar propriedades de extensão em um objeto de aplicativo.
Excluir extensionProperty Nenhum Excluir uma propriedade de extensão de um objeto de aplicativo. Você pode excluir somente as propriedades que não são sincronizadas do Active Directory local.

Dica

  1. Para definir um valor para a propriedade de extensão para uma instância de um recurso especificado em targetObjects, use a operação Atualizar do recurso. Por exemplo, a API atualizar usuário para definir o valor de um usuário.
  2. Para remover a propriedade de extensão e seu valor de uma instância de um recurso especificado em targetObjects, defina o valor da propriedade de extensão como null.

Propriedades

Propriedade Tipo Descrição
appDisplayName Cadeia de caracteres Nome de exibição do objeto de aplicativo no qual essa propriedade de extensão está definida. Somente leitura.
dataType Cadeia de caracteres Especifica o tipo de dados do valor que a propriedade de extensão pode conter. Há suporte para os valores a seguir. Não anulável.
  • Binary - Máximo de 256 bytes
  • Boolean
  • DateTime - Deve ser especificado no formato ISO 8601. Serão armazenados no UTC.
  • Integer - Valor de 32 bits.
  • LargeInteger - Valor de 64 bits.
  • String - Máximo de 256 caracteres
deletedDateTime DateTimeOffset Data e hora em que este objeto foi excluído. Sempre null quando o objeto não tiver sido excluído. Herdado de directoryObject.
isSyncedFromOnPremises Booliano Indica se essa propriedade de extensão foi sincronizada do Active Directory local usando o Azure AD Connect. Somente leitura.
name String Nome da propriedade de extensão. Não anulável.
targetObjects Conjunto de cadeias de caracteres Há suporte para os valores a seguir. Não anulável.
  • User
  • Group
  • Organization
  • Device
  • Application

Relações

Nenhum

Representação JSON

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

{
  "@odata.type": "#microsoft.graph.extensionProperty",
  "id": "String (identifier)",
  "deletedDateTime": "String (timestamp)",
  "appDisplayName": "String",
  "name": "String",
  "dataType": "String",
  "isSyncedFromOnPremises": "Boolean",
  "targetObjects": [
    "String"
  ]
}

Confira também