Partilhar via

extensionProperty resource type (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 utilizada para adicionar uma propriedade personalizada a objetos de diretório sem que seja necessário um arquivo de dados externo. Por exemplo, se uma organização tiver uma aplicação de linha de negócio (LOB) que necessite de um ID do Skype para cada utilizador no diretório, o Microsoft Graph pode ser utilizado para registar uma nova propriedade chamada skypeId no objeto Utilizador do diretório e, em seguida, escrever um valor na nova propriedade para um utilizador específico. As extensões de diretório também podem estar disponíveis em aplicações multi-inquilino que tenham sido consentidas no inquilino.

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 todas as aplicações, podem ser escritos em qualquer instância de recurso do Microsoft Entra.

Utilize este recurso e métodos associados para gerir as definições da extensão de diretório. Para gerir os dados da extensão de diretório na instância de recurso expandida, utilize o mesmo pedido REST que utiliza para gerir a instância de recurso.

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

Herda de directoryObject.

Observação

As extensões criadas através do Azure AD Graph (atualmente no ciclo de descontinuação) e os dados personalizados sincronizados a partir do Active Directory no local com o 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 extensionProperty Criar uma extensão de diretório num objeto de aplicação.
List Coleção extensionProperty Listar extensões de diretório num objeto de aplicação.
Get Coleção extensionProperty Obter uma extensão de diretório para um objeto de aplicação.
Delete Nenhum Elimine a extensão de diretório de um objeto de aplicação. Só pode eliminar extensões de diretório que não são sincronizadas a partir do active directory no local.

Dica

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

Propriedades

Propriedade Tipo Descrição
appDisplayName Cadeia de caracteres Nome a apresentar do objeto da aplicação no qual esta 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. São suportados os seguintes valores.
  • Binary - Máximo de 256 bytes
  • Boolean
  • DateTime - Tem de 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 carateres
Não anulável. Para extensões de diretório de valores múltiplos, estes limites aplicam-se 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 esta propriedade de extensão foi sincronizada a partir do active directory no local com o Microsoft Entra Connect. Somente leitura.
name Cadeia de caracteres Nome da propriedade da extensão. Não anulável. Suporta $filter (eq).
isMultiValued Booliano Define a extensão de diretório como uma propriedade de valores múltiplos. Quando true, a propriedade da extensão de diretório pode armazenar uma coleção de objetos do dataType; por exemplo, uma coleção de tipos de cadeia, como "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]. O valor padrão é false. Suporta $filter (eq).
targetObjects String collection São suportados os seguintes valores. Não anulável.
  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

Relações

Nenhum

Representação JSON

A representação JSON seguinte mostra o tipo de 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