tipo de recurso extensionProperty (extensões de diretório)

  • Artigo

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.

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 LOB (linha de negócios) que requer 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, escrever um valor para a nova propriedade para um usuário específico. As extensões de diretório também podem estar disponíveis em aplicativos multilocatários que foram consentidos no locatário.

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

Apenas 100 valores de extensão, em todos os tipos e em todos os aplicativos, podem ser gravados em qualquer instância de recurso Microsoft Entra.

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 estendida, 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

As extensões criadas por meio do Azure AD Graph (atualmente em seu ciclo de aposentadoria) e os dados personalizados sincronizados de Active Directory local usando Microsoft Entra Connect Sync são representados como extensões de diretório no Microsoft Graph.

Métodos

Método Tipo de retorno Descrição
Criar extensionProperties extensionProperty Crie uma extensão de diretório em um objeto de aplicativo.
Listar extensionProperties Coleção extensionProperty Listar extensões de diretório em um objeto de aplicativo.
Obter extensionProperty Coleção extensionProperty Obtenha uma extensão de diretório de um objeto de aplicativo.
Excluir extensionProperty Nenhum Exclua a extensão de diretório de um objeto de aplicativo. Você pode excluir apenas extensões de diretório que não são sincronizadas do diretório ativo local.

Dica

  1. Para definir um valor para a propriedade de extensão como uma instância de um recurso especificado em targetObjects, use a operação Atualizar do recurso. Por exemplo, a API do usuário atualizar para definir o valor para 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 do aplicativo no qual essa propriedade de extensão é 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 valores a seguir.
  • Binary - 256 bytes máximos
  • 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 - 256 caracteres no máximo
Não anulável. Para extensões de diretório multivalorizado, esses limites se aplicam por valor na coleção.
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 diretório ativo local usando Microsoft Entra Connect. Somente leitura.
name Cadeia de caracteres Nome da propriedade de extensão. Não anulável. Suporta $filter (eq).
isMultiValued Booliano Define a extensão de diretório como uma propriedade de vários valores. Quando true, a propriedade de extensão de diretório pode armazenar uma coleção de objetos do dataType; por exemplo, uma coleção de tipos de cadeia de caracteres como "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]. O valor padrão é false. Suporta $filter (eq).
targetObjects Coleção de cadeias de caracteres Há suporte para valores a seguir. Não anulável.
  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

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",
  "isMultiValued": "Boolean",
  "targetObjects": [
    "String"
  ]
}

Conteúdo relacionado