Tipo de recurso schemaExtension (extensões de esquema)
Namespace: microsoft.graph
As extensões de esquema permitem que você defina um esquema para estender e adicionar dados personalizados digitados a um tipo de recurso. Os dados personalizados aparecem como um tipo complexo no recurso estendido. As extensões de esquema são suportadas pelos seguintes tipos de recursos:
- user
- group
- administrativeUnit
- application
- contact
- device
- evento (para calendários de usuário e grupo)
- message
- organização
- postagem
Use esse recurso e métodos associados para gerenciar as definições de extensão de esquema. Para gerenciar os dados de extensão de esquema na instância de recurso estendido, use a mesma solicitação REST que você usa para gerenciar a instância de recurso. Confira o exemplo de extensão de esquema para aprender a adicionar dados personalizados aos grupos.
Para obter mais informações sobre a extensibilidade do Microsoft Graph, incluindo limites para extensões de esquema, consulte Adicionar propriedades personalizadas aos recursos usando extensões.
Métodos
Método | Tipo de retorno | Descrição |
---|---|---|
Criar | schemaExtension | Crie uma definição de extensão de esquema e sua propriedade de extensão de esquema associada. |
Listar | schemaExtension | Lista as definições de schemaExtension disponíveis e suas propriedades. |
Get | schemaExtension | Leia as propriedades da definição de schemaExtension específica. |
Atualizar | schemaExtension | Atualize uma definição de schemaExtension. Use essa operação para atualizar a descrição, status, tipos de destino ou adicionar mais propriedades à definição de extensão de esquema. |
Delete | None | Exclua uma definição de schemaExtension. |
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
description | String | Descrição da extensão de esquema. Suporta $filter (eq ). |
id | String | O identificador exclusivo da definição de extensão de esquema. Você pode atribuir um valor em uma destas duas maneiras:
$filter (eq ). Observação: recomendamos que sua id comece com uma letra alfabética entre A-Z porque os recursos de consulta podem ser limitados para as IDs que começam com inteiros. Suporta $filter (eq ). |
owner | String | O appId do aplicativo que é o proprietário da extensão de esquema. O proprietário da definição de esquema deve ser especificado explicitamente durante as operações Criar e Atualizar, ou será implícito e atribuído automaticamente por Microsoft Entra ID da seguinte maneira:
Portanto, por exemplo, se criar uma nova definição de extensão de esquema usando o Graph Explorer, você deverá fornecer a propriedade proprietário. Uma vez definida, essa propriedade é somente leitura e não pode ser alterada. Suporta $filter (eq ). |
properties | Coleção extensionSchemaProperty | A coleção de tipos e nomes de propriedades que compõem a definição da extensão de esquema. |
status | String | O estado do ciclo de vida da extensão de esquema. Os estados possíveis são InDevelopment , Available e Deprecated . Definido automaticamente como InDevelopment na criação. Para obter mais informações sobre as possíveis transições de estado e comportamentos, consulte Ciclo de vida das extensões de esquema. Suporta $filter (eq ). |
targetTypes | Coleção de cadeias de caracteres | O conjunto de tipos do Microsoft Graph (que podem suportar extensões) ao qual a extensão de esquema pode ser aplicada. Selecione entre administrativeUnit, contato, dispositivo, evento, grupo, mensagem, organização, postagem, todoTask, todoTaskList ou usuário. |
Ciclo de vida das extensões do esquema
Quando o aplicativo cria uma definição de extensão do esquema, ele é marcado como proprietária da extensão do esquema.
O aplicativo proprietário pode mover a extensão por diferentes estados de um ciclo de vida, usando uma operação PATCH em sua propriedade status. Dependendo do estado atual, o aplicativo proprietário pode ser capaz de atualizar ou excluir a extensão. Todas as atualizações de uma extensão de esquema sempre devem ser aditivas e não quebras.
Estado | Comportamento de estado de ciclo de vida |
---|---|
InDevelopment |
|
Disponível |
|
Preterido |
|
Observação
As definições de extensão de esquema (marcadas como Available
) criadas por outros desenvolvedores de outros locatários são visíveis para todos os desenvolvedores (listando todas as extensões de esquema). Isto é diferente de outras APIs que retornam apenas os dados específicos do locatário. Por outro lado, os dados de extensão criados com base nas definições de extensão de esquema, são específicos do locatário e só podem ser acessados por aplicativos explicitamente autorizados.
Representação JSON
A representação JSON a seguir mostra o tipo de recurso.
{
"description": "String",
"id": "String (identifier)",
"owner": "String",
"properties": [{"@odata.type": "microsoft.graph.extensionSchemaProperty"}],
"status": "String",
"targetTypes": ["String"]
}
Conteúdo relacionado
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de