tipo de recurso de grupo

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 um grupo do Microsoft Entra, que pode ser um grupo do Microsoft 365, uma equipe no Microsoft Teams ou um grupo de segurança. Esse recurso é um tipo aberto que permite propriedades adicionais além daquelas documentadas aqui.

Herda de directoryObject.

Por motivos de desempenho, as operações create, get e list retornam por padrão apenas um subconjunto das propriedades usadas com mais frequência. Essas propriedades padrão estão listadas na seção Propriedades. Para obter qualquer uma das propriedades não retornadas por padrão, especifique-as em uma $select opção de consulta OData.

Esse recurso permite:

O Microsoft Teams e os grupos do Microsoft 365 oferecem suporte à colaboração em grupo. Você pode usar a maioria das APIs de grupos do Microsoft 365 com o Microsoft Teams. Para criar uma equipe, primeiro crie o grupo e, em seguida, adicione uma equipe nele. Para obter detalhes, confira a visão geral do Microsoft Teams.

Métodos

Método Tipo de retorno Descrição
List Coleção group Ler as propriedades e as relações de todos os objetos do grupo.
Create grupo Crie um novo grupo conforme especificado. Pode ser um grupo do Microsoft 365, um grupo dinâmico, um grupo de segurança ou uma equipe.
Get grupo Ler as propriedades e as relações do objeto do grupo.
Atualizar Nenhum Atualizar as propriedades de um objeto group.
Executar upsert group Crie um novo grupo, caso não exista, ou atualize as propriedades de um grupo existente.
Delete Nenhum Excluir um objeto group.
Obter delta Coleção group Obter alterações incrementais para grupos.
Gerenciamento de grupos
Listar membros Coleção directoryObject Obter os usuários e grupos que são membros diretos desse grupo da propriedade de navegação members.
Adicionar membro directoryObject Adicione um membro a esse grupo postando na propriedade de navegação de membros (com suporte apenas para grupos de segurança e grupos do Microsoft 365).
Remover membro Nenhum Remova um membro de um grupo do Microsoft 365 ou de um grupo de segurança por meio da propriedade de navegação membros.
Listar proprietários Coleção directoryObject Obter os proprietários do grupo da propriedade de navegação owners.
Adicionar proprietário directoryObject Adicione um novo proprietário para o grupo postando na propriedade de navegação dos proprietários (com suporte para grupos de segurança e grupos do Microsoft 365 apenas).
Remover proprietário Nenhum Remova um proprietário de um grupo do Microsoft 365 ou de um grupo de segurança por meio da propriedade de navegação proprietários.
Listar associações Coleção directoryObject Obtenha os grupos, funções administrativas e unidades administrativas das quais esse grupo é membro direto da propriedade de navegação memberOf.
Listar membros transitivos Coleção directoryObject Obtenha os usuários, grupos, dispositivos e entidades de serviço que são membros, incluindo membros aninhados desse grupo.
Listar associações transitivas Coleção directoryObject Listar as unidades administrativas e grupos dos quais esse grupo é membro. Essa operação é transitiva e inclui os grupos que são membros aninhados desse grupo.
Listar políticas de ciclo de vida Coleção groupLifecyclePolicy Listar políticas de ciclo de vida de grupo.
Listar pontos de extremidade conjunto ponto de extremidade Obtenha uma coleção de o objeto ponto de extremidade.
Obter o ponto de extremidade ponto de extremidade Leia as propriedades e os relacionamentos do objeto ponto de extremidade.
Atribuir licença group Adicione ou remova assinaturas para o grupo. Você também pode habilitar e desabilitar planos específicos associados a uma assinatura.
Avaliar a associação dinâmica evaluateDynamicMembershipResult Avaliar se um usuário ou dispositivo é ou seria membro de um grupo dinâmico.
Renovar Booliano Renova o período de validade de um grupo. Após renovar um grupo, o período de validade é estendido de acordo com o número de dias definido na política.
Validar propriedades JSON Valide o nome de exibição ou apelido de email de um grupo do Microsoft 365 que esteja em conformidade com as políticas de nomenclatura.
Obter fonte de autoridade (SOA) onPremisesSyncBehavior Verifique se a fonte de autoridade (SOA) do objeto de grupo é a nuvem ou o Active Directory local.
Atualizar fonte de autoridade (SOA) onPremisesSyncBehavior Atualize a SOA (fonte de autoridade) do objeto de grupo para a nuvem ou o Active Directory local.
Atribuição de funções do aplicativo
List appRoleAssignment collection Obtenha os aplicativos e as funções de aplicativo aos quais este grupo foi atribuído.
Add appRoleAssignment Atribuir uma função do aplicativo a esse grupo.
Remove Nenhum. Remover uma atribuição de função do aplicativo desse grupo.
Calendar
Obter calendário calendar Obter o calendário do grupo.
Atualizar calendário Nenhum Atualize o calendário do grupo.
Listar eventos Coleção event Obter uma coleção de objetos de evento.
Criar evento event Criar um novo Event postando na coleção de eventos.
Obter evento event Ler as propriedades de um objeto event.
Atualizar evento Nenhum Atualizar as propriedades de um objeto event.
Excluir evento Nenhum Excluir o objeto event.
Listar modo de exibição de calendário Coleção event Obter um conjunto de eventos em uma janela de tempo especificada.
Licenciamento de nuvem
Listar direitos de uso Coleção microsoft.graph.cloudLicensing.usageRight Obtenha uma lista dos objetos usageRight concedidos a um grupo.
Acertar o uso microsoft.graph.cloudLicensing.usageRight Obtenha as propriedades e relações de um objeto usageRight concedido a um grupo.
Conversas
Listar conversas Coleção conversation Obter uma coleção de objetos Conversation.
Criar conversa conversa Crie uma nova conversa postando na coleção de conversas.
Obter conversa conversation Ler as propriedades de um objeto conversation.
Excluir conversa Nenhum Excluir objeto conversation.
Listar threads Coleção conversationThread Obter todos os threads de um grupo.
Criar thread conversationThread Criar um novo thread de conversa.
Acessar thread conversationThread Ler as propriedades de um objeto thread.
Atualizar thread Nenhum Atualizar as propriedades de um objeto thread.
Excluir thread Nenhum Excluir objeto thread
Listar remetentes aceitos Coleção directoryObject Obtenha uma lista de usuários ou grupos que estão na lista de remetentes aceitos para este grupo.
Adicionar remetente aceito directoryObject Adicionar um Usuário ou Grupo à coleção acceptSenders.
Remover remetente aceito directoryObject Remover um Usuário ou Grupo da coleção acceptedSenders.
Listar remetentes rejeitados Coleção directoryObject Obtenha uma lista de usuários ou grupos que estão na lista de remetentes rejeitados para este grupo.
Adicionar remetente rejeitado directoryObject Adicionar um novo Usuário ou Grupo à coleção rejectedSenders.
Remover remetente rejeitado directoryObject Remover um novo Usuário ou Grupo da coleção Remetentesrejeitados.
Objetos de diretório
Listar itens excluídos Coleção directoryObject Recupere os grupos excluídos no locatário nos últimos 30 dias.
Obter item excluído Coleção directoryObject Recupere um grupo excluído por ID.
Restaurar item excluído Coleção directoryObject Restaure um grupo excluído no locatário nos últimos 30 dias.
Excluir permanentemente item Coleção directoryObject Exclua permanentemente um grupo excluído do locatário.
Listar itens excluídos pertencentes ao usuário Coleção directoryObject Recupere os grupos excluídos no locatário nos últimos 30 dias que pertencem a um usuário.
Verificar grupos de membros Coleção de cadeias de caracteres Verifique se há uma associação em uma lista de grupos. Essa função é transitiva.
Obter grupos de membros String collection Retorne todos os grupos dos quais o grupo é membro. Essa função é transitiva.
Verificar objetos de membro Coleção de cadeias de caracteres Verifique se há associação em uma lista de grupo, função de diretório ou objetos de unidade administrativa. Essa função é transitiva.
Obter objetos de membros String collection Retorne todos os grupos e unidades administrativas dos quais o grupo é membro. Essa função é transitiva.
Unidade
Obter unidade unidade Recuperar as propriedades e as relações de um recurso Drive.
Filhos de lista Coleção de driveItem Retorne uma coleção de objetos driveItem na relação filhos de um driveItem.
Configurações de grupo
List conjunto directorySetting Lista propriedades de todos os objetos de configuração.
Create directorySetting Crie um objeto de configuração com base em um directorySettingTemplate. A solicitação POST deve fornecer settingValues para todas as configurações definidas no modelo. Somente grupos de modelos específicos podem ser usados para esta operação.
Get directorySetting Ler propriedades de um objeto de configuração específico.
Atualizar Nenhum Atualizar um objeto setting.
Delete Nenhum Excluir um objeto de configuração.
Modelos de configuração de lista Nenhum Listar propriedades de todos os modelos de configuração.
Obter modelo de configuração Nenhum Ler as propriedades de um modelo de configuração.
Observações
Listar blocos de anotações Coleção bloco de anotações Recuperar uma lista de objetos do bloco de anotações.
Criar bloco de anotações bloco de anotações Crie um novo bloco de anotações do OneNote.
Credenciais de logon único baseadas em senha
Get coleção passwordSingleSignOnCredentialSet Obtenha a lista de credenciais de logon único baseadas em senha para este grupo. As senhas nunca são retornadas e, em vez disso, são sempre retornadas como nulas.
Delete Nenhum Exclua a credencial de logon único baseada em senha para uma determinada entidade de serviço associada a esse grupo.
name.
Foto do perfil
Get profilePhoto Obtém o profilePhoto especificado ou seus metadados (propriedades profilePhoto).
Atualizar Nenhum Atualiza a foto de qualquer usuário no locatário, incluindo o usuário conectado ou o grupo ou contato especificado.
Delete Nenhum Exclua a foto de qualquer usuário no locatário, incluindo o usuário conectado ou o grupo especificado.
Planner
Listar planos coleção plannerPlan Obter planos atribuídos ao grupo.
Postagens
List Coleção post Obtenha postagens em um tópico de conversa.
Get postagem Obtenha uma postagem específica.
Responder à postagem Nenhum Responder a uma postagem.
Encaminhar postagem Nenhum Encaminhar uma postagem.
Outros recursos de grupo
Listar as concessões de permissões Coleção resourceSpecificPermissionGrant Listar as permissões concedidas aos aplicativos para acessar o grupo.
Configurações do usuário
Adicionar favorito Nenhum Adicionar o grupo à lista de grupos de favoritos do usuário conectado. Apenas grupos do Microsoft 365 são suportados.
Remover favorito Nenhum Remover o grupo da lista de grupos favoritos do usuário conectado. Apenas grupos do Microsoft 365 são suportados.
Listar membro de Coleção directoryObject Obtenha os grupos e unidades administrativas dos quais esse usuário é membro direto da propriedade de navegação memberOf .
Listar equipes unidas Coleção group Obtenha as equipes do Microsoft Teams das quais o usuário é um membro direto.
Listar equipes associadas Coleção associatedTeamInfo Obtenha a lista de objetos associatedTeamInfo no Microsoft Teams as quais um usuário está associado.
Assinar por email Nenhum Defina a propriedade isSubscribedByMail como true. Permitir que o usuário conectado receba conversas por email. Apenas grupos do Microsoft 365 são suportados.
Cancelar assinatura por email Nenhum Defina a propriedade isSubscribedByMail como false. Desabilitar o usuário conectado de receber conversas por email. Apenas grupos do Microsoft 365 são suportados.
Redefinir contagem não vista Nenhum Redefina o unseenCount como 0 para todas as postagens que o usuário conectado não viu desde sua última visita. Apenas grupos do Microsoft 365 são suportados.

Propriedades

Importante

O uso específico de $filter e o parâmetro de consulta $search é suportado somente quando se usa o cabeçalho ConsistencyLevel definido como eventual e $count. Para obter mais informações, consulte Recursos avançados de consulta em objetos de diretório.

Propriedade Tipo Descrição
accessType groupAccessType Indica o tipo de acesso ao grupo. Os valores possíveis são none, private, secrete public.
allowExternalSenders Boolean Indica se as pessoas externas à empresa podem enviar mensagens para o grupo. O valor padrão é false.

Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID})
assignedLabels coleção assignedLabel A lista de pares de rótulos de confidencialidade (ID do rótulo, nome do rótulo) associados a um grupo do Microsoft 365 ou a um grupo de segurança na nuvem. Requer uma licença P1 do Microsoft Entra ID.

Requer $select recuperação. Essa propriedade pode ser especificada durante a criação ou atualização do grupo. No entanto, para grupos de segurança de nuvem, ele é imutável depois de definido. Essa propriedade pode ser atualizada somente em cenários delegados em que o chamador requer a permissão do Microsoft Graph e uma função de administrador com suporte. Consulte Principais diferenças da rotulagem de grupo do Microsoft 365 para saber mais sobre como gerenciar essa propriedade para o Microsoft 365 versus grupos de segurança na nuvem.
assignedLicenses Coleção assignedLicense As licenças que são atribuídas ao grupo.

Requer $select recuperação. Suporta $filter (eq). Somente leitura.
autoSubscribeNewMembers Boolean Indica se os novos membros adicionados ao grupo são inscritos automaticamente para receber notificações por email. Você pode definir esta propriedade em uma solicitação PATCH para o grupo; não o defina na solicitação POST inicial que cria o grupo. O valor padrão é false.

Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID})
classificação String Descreve uma classificação para o grupo (como baixo, médio ou alto impacto nos negócios). Os valores válidos para essa propriedade são definidos criando um valor de configuração ClassificationList, com base na definição de modelo.

Retornado por padrão. Suporta $filter (eq, ne, not, ge, le, startsWith).
cloudLicensing microsoft.graph.cloudLicensing.groupCloudLicensing As relações de um grupo com recursos de licenciamento de nuvem.
createdByAppId Cadeia de caracteres ID do aplicativo usado para criar o grupo. Pode ser nulo para alguns grupos.

Retornado por padrão. Somente leitura. Suporta $filter (eq, ne, not, in, startsWith).
createdDateTime DateTimeOffset Carimbo de data/hora da ocasião em que o grupo foi criado. O valor não pode ser modificado e é preenchido automaticamente quando o grupo é criado. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.

Retornado por padrão. Somente leitura.
deletedDateTime DateTimeOffset Para alguns objetos do Microsoft Entra (usuário, grupo, aplicativo), se o objeto for excluído, ele será excluído logicamente primeiro, e esta propriedade será atualizada com a data e hora em que o objeto foi excluído. Caso contrário, essa propriedade é nula. Se o objeto for restaurado, esta propriedade será atualizada para null. Herdado de directoryObject.
description String Uma descrição opcional para o grupo.

Retornado por padrão. Suporta $filter (eq, ne, not, ge, le, startsWith) e $search.
displayName String O nome de exibição do grupo. Obrigatório. O comprimento máximo é de 256 caracteres.

Retornado por padrão. Suporte $filter (eq, ne, not, ge, le, in, startsWith, e eq no null valores), $search, e $orderby.
expirationDateTime DateTimeOffset Data e hora de quando o grupo está configurado para expirar. null É para grupos de segurança, mas para grupos do Microsoft 365, representa quando o grupo está definido para expirar, conforme definido no groupLifecyclePolicy. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.

Retornado por padrão. Suporta $filter (eq, ne, not, ge, le, in). Somente leitura.
groupTypes Coleção de cadeias de caracteres Especifica o tipo de grupo e sua associação.

Se a coleção contiver Unified, o grupo será um grupo do Microsoft 365; caso contrário, será um grupo de segurança ou um grupo de distribuição. Para obter detalhes, confira visão geral sobre grupos.

Se a coleção inclui DynamicMembership, o grupo tem associação dinâmica; caso contrário, a associação é estática.

Retornado por padrão. Suporta $filter (eq, not).
hasMembersWithLicenseErrors Boolean Indica se existem membros neste grupo com erros de licença da sua atribuição de licença baseada em grupo.

Esta propriedade nunca é retornada em uma operação GET. Você pode usá-lo como um argumento $filter para acessar os grupos que têm membros com erros de licença (ou seja, o filtro para essa propriedade é true).

Suporta $filter (eq).
hideFromAddressLists Booliano true se o grupo não for exibido em determinadas partes da interface do usuário do Outlook: no Catálogo de Endereços, nas listas de endereços para selecionar destinatários de mensagens e na caixa de diálogo Procurar Grupos para pesquisar grupos; caso contrário, false. O valor padrão é false.

Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID})
hideFromOutlookClients Booliano trueSe o grupo não for exibido em clientes Outlook, como Outlook para Windows e Outlook na Web, caso contrário, é false. O valor padrão é false.

Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID})
id String O identificador exclusivo do grupo.

Retornado por padrão. Herdado de directoryObject. Chave. Não anulável. Somente leitura.

Suporta $filter (eq, ne, not, in).
isArchived Booliano Quando um grupo está associado a uma equipe, esta propriedade determina se a equipe está em modo somente leitura.
Para ler essa propriedade, use o ponto de extremidade /group/{groupId}/team ou a API Obter equipe. Para atualizar essa propriedade, use as APIs archiveTeam e unarchiveTeam.
isAssignableToRole Booliano Indica se esse grupo pode ser atribuído a uma função do Microsoft Entra. Opcional.

Esta propriedade só pode ser definida durante a criação do grupo e é imutável. Se definido como true, a propriedade securityEnabled também deve ser definida como true, a visibilidade deve ser Hidden, e o grupo não pode ser um grupo dinâmico (ou seja, groupTypes não pode conter DynamicMembership).

Somente chamadores com pelo menos a função Privileged Role Administrator podem definir essa propriedade. O chamador também deve receber a permissão RoleManagement.ReadWrite.Directory para definir essa propriedade ou atualizar a associação desses grupos. Para obter mais informações, consulte Usando um grupo para gerenciar atribuições de função do Microsoft Entra

O uso desse recurso requer uma licença do Microsoft Entra ID P1. Devolvido por padrão. Suporta $filter (eq, ne, not).
isFavorite Boolean Indica se o usuário marcou o grupo como favorito.
isManagementRestricted Booliano Indica se o grupo é membro de uma unidade administrativa de gerenciamento restrito. Caso contrário, o valor padrão será null e o comportamento padrão será false. Somente leitura.

Para gerenciar um membro do grupo de uma unidade administrativa de gerenciamento restrito, o administrador ou o aplicativo de chamada deve receber uma função do Microsoft Entra no escopo da unidade administrativa de gerenciamento restrita.
infoCatalogs Conjunto de cadeias de caracteres Identifica os segmentos de informações atribuídos ao grupo. Retornado por padrão. Suporta $filter (eq, not, ge, le, startsWith).
isSubscribedByMail Boolean Indica se o usuário conectado está inscrito para receber conversas de email. O valor padrão é true.

Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID})
licenseProcessingState String Indica o status da atribuição de licença do grupo a todos os membros do grupo. Valores possíveis: QueuedForProcessing, ProcessingInProgress e ProcessingComplete.

Requer $select recuperação. Somente leitura.
email String O endereço SMTP do grupo, por exemplo, "serviceadmins@contoso.com".

Retornado por padrão. Somente leitura. Suporte $filter (eq, ne, not, ge, le, in, startsWith, e eq no null valores).
mailEnabled Boolean Especifica se o grupo está habilitado para email. Obrigatório.

Devolvido por padrão. Suporte $filter (eq, ne, not, e eq no null valores).
mailNickname String O alias de email do grupo, exclusivo para grupos do Microsoft 365 na organização. O comprimento máximo é de 64 caracteres. Essa propriedade pode conter apenas caracteres no conjunto de caracteres ASCII de 0 a 127, exceto o seguinte: @ () \ [] " ; : <> , SPACE.

Devolvido por padrão. Suporta $filter (eq, ne, not, ge, le, in, startsWith).
membershipRule String A regra que determina membros para esse grupo se o grupo for um grupo dinâmico (groupTypes contém DynamicMembership). Para saber mais sobre a sintaxe da regra de associação, confira sintaxe regras de associação.

Retornado por padrão. Suporta $filter (eq, ne, not, ge, le, startsWith).
membershipRuleProcessingState String Indica se o processamento de associação dinâmica está ativado ou em pausa. Os valores possíveis são: On ou Paused.

Retornado por padrão. Suporta $filter (eq, ne, not, in).
membershipRuleProcessingStatus membershipRuleProcessingStatus Descreve o status de processamento para grupos dinâmicos baseados em regras. A propriedade é null para grupos dinâmicos não baseados em regras ou se o processamento de grupo dinâmico tiver sido pausado.

Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID}) Somente leitura.
onPremisesDomainName Cadeia de Caracteres Contém o nome de domínio totalmente qualificado (FQDN) local, também chamado de dnsDomainName sincronizado no diretório local. A propriedade é preenchida apenas para clientes que sincronizam seu diretório local com o Microsoft Entra ID por meio do Microsoft Entra Connect.

Retornado por padrão. Somente leitura.
onPremisesExtensionAttributes onPremisesExtensionAttributes Tipo complexo que contém atributos de extensão de 1 a 15 para o grupo, sincronizado do Active Directory local. Retornado apenas em $select. Suporta $filter (eq, ne, not, in).
onPremisesLastSyncDateTime DateTimeOffset Indica a última vez em que o grupo foi sincronizado com o diretório local. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.

Retornado por padrão. Somente leitura. Suporta $filter (eq, ne, not, ge, le, in).
onPremisesNetBiosName Cadeia de Caracteres Contém o netBios name local sincronizado no diretório local. A propriedade é preenchida apenas para clientes que sincronizam seu diretório local com o Microsoft Entra ID por meio do Microsoft Entra Connect.

Retornado por padrão. Somente leitura.
onPremisesProvisioningErrors coleção OnPremisesProvisioningError Erros ao usar o produto de sincronização da Microsoft durante a configuração.

Retornado por padrão. Suporta $filter (eq, not).
onPremisesSamAccountName Cadeia de Caracteres Contém o nome da conta SAM local sincronizado no diretório local. A propriedade é preenchida apenas para clientes que sincronizam seu diretório local com o Microsoft Entra ID por meio do Microsoft Entra Connect.

Devolvido por padrão. Suporta $filter (eq, ne, not, ge, le, in, startsWith). Somente leitura.
onPremisesSecurityIdentifier String Contém o SID (identificador de segurança) local do grupo sincronizado do local para a nuvem. Somente leitura.

Devolvido por padrão. Suporta $filter(eq inclusive em null valores).
onPremisesSyncEnabled Booliano true se esse grupo está sincronizado de um diretório local; false se esse grupo foi originalmente sincronizado de um diretório local, mas não está mais sincronizado; null se esse objeto nunca foi sido sincronizado de um diretório local (padrão).

Retornado por padrão. Somente leitura. Suporte $filter (eq, ne, not, in, e eq no null valores).
preferredDataLocation String O local de data preferido para o grupo do Microsoft 365. Por padrão, o grupo herda o local de dados preferencial do criador do grupo. Para definir essa propriedade, o aplicativo de chamada deve receber a permissão Directory.ReadWrite.All e o usuário deve receber pelo menos uma das seguintes funções do Microsoft Entra:
  • Administrador de Conta de Usuário
  • Escritor de Diretórios
  • Administrador do Exchange
  • Administrador do SharePoint

Para obter mais informações sobre essa propriedade, consulte OneDrive Online Multi-Geo e Criar um grupo do Microsoft 365 com um PDL específico.

Anulável. Retornado por padrão.
preferredLanguage Cadeia de caracteres Idioma de preferência de um grupo do Microsoft 365. Deve seguir o Código ISO 639-1; por exemplo, en-US.

Devolvido por padrão. Suporte $filter (eq, ne, not, ge, le, in, startsWith, e eq no null valores).
proxyAddresses String collection Endereços de email para o grupo que direcionam para a mesma caixa de correio do grupo. Por exemplo: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]. O operador any é obrigatório para expressões de filtro em propriedades de vários valores.

Retornado por padrão. Somente leitura. Não anulável. Suporta $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).
renewedDateTime DateTimeOffset Carimbo de data/hora da ocasião em que o grupo foi renovado pela última vez. Não é possível modificar isso diretamente e a atualização ocorre apenas por meio da ação de renovação de serviço. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.

Retornado por padrão. Suporta $filter (eq, ne, not, ge, le, in). Apenas leitura.
resourceBehaviorOptions Conjunto de cadeias de caracteres Especifica os comportamentos de grupo que podem ser configurados para um grupo do Microsoft 365 durante sua criação. Esta propriedade pode ser definida somente como parte da criação (POST). Para obter a lista de valores possíveis, consulte Comportamentos de grupo e opções de provisionamento do Microsoft 365.
resourceProvisioningOptions Conjunto de cadeias de caracteres Especifica os recursos do grupo que estão associados ao grupo do Microsoft 365. O valor possível é Team. Para obter mais informações, consulte Comportamentos de grupo do Microsoft 365 e opções de provisionamento.

Devolvido por padrão. Suporta $filter (eq, not, startsWith).
securityEnabled Boolean Especifica se o grupo é um grupo de segurança. Obrigatório.

Devolvido por padrão. Suporta $filter (eq, ne, not, in).
securityIdentifier Cadeia de Caracteres Identificador de segurança do grupo, usado em cenários do Windows. Somente leitura.

Devolvido por padrão.
serviceProvisioningErrors serviceProvisioningError (em inglês) Erros publicados por um serviço federado descrevendo um erro não transitório, específico do serviço em relação às propriedades ou ao link de um objeto de grupo.
tema Cadeia de caracteres Especifica o tema de cor de um grupo do Microsoft 365. Os valores possíveis são: Teal, Purple, Green, Blue,Pink, Orange ou Red.

Retornado por padrão.
Nome único Cadeia de caracteres O identificador exclusivo que pode ser atribuído a um grupo e usado como uma chave alternativa. Imutável. Somente leitura.
unseenConversationsCount Int32 Contagem de conversas entregues uma ou mais novas postagens desde a última visita do usuário conectado ao grupo. Essa propriedade é igual a unseenCount.

Requer $select recuperação.
unseenCount Int32 Contagem das conversas que receberam novas postagens desde que o usuário conectado visitou o grupo pela última vez. Essa propriedade é igual a unseenConversationsCount.

Requer $select recuperação. Suportado apenas para Obter API de grupo (GET /groups/{ID}).
unseenMessagesCount Int32 Contagem de novas postagens que foram entregues às conversas do grupo desde a última visita do usuário conectado ao grupo.

Requer $select recuperação.
visibility Cadeia de caracteres Especifica a política de associação ao grupo e a visibilidade do conteúdo do grupo para grupos. Os valores possíveis são: Private, Public, ou HiddenMembership. HiddenMembership podem ser definidos somente para grupos do Microsoft 365 quando os grupos são criados. Não pode ser atualizado posteriormente. Outros valores de visibilidade podem ser atualizados após a criação do grupo.
Se o valor de visibilidade não for especificado durante a criação do grupo no Microsoft Graph, um grupo de segurança será criado como Private por padrão, e o grupo do Microsoft 365 será Public. Grupos atribuídos a funções são sempre Private. Para saber mais, confira opções de visibilidade do grupo.

Retornado por padrão. Anulável.
welcomeMessageEnabled Booliano Indica se uma mensagem de boas-vindas é enviada aos novos membros quando eles são adicionados ao grupo. O valor padrão é true.

Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID})
writebackConfiguration groupWritebackConfiguration Especifica se um grupo está configurado ou não para fazer write-back de propriedades de objeto de grupo para o Active Directory local. Essas propriedades são usadas quando o write-back de grupo é configurado no cliente de sincronização do Microsoft Entra Connect.

Opções de visibilidade do grupo

Valor Descrição
Público Qualquer pessoa pode ingressar no grupo sem a permissão do proprietário.
Qualquer pessoa pode exibir o conteúdo do grupo.
Privado A permissão de proprietário é necessária para ingressar no grupo.
Não membros não podem exibir o conteúdo do grupo.
HiddenMembership A permissão de proprietário é necessária para ingressar no grupo.
Não membros não podem exibir o conteúdo do grupo.
Não membros não podem ver os membros do grupo.
Administradores (global, empresa, usuário e helpdesk) podem visualizar a associação do grupo.
O grupo aparece no catálogo de endereços global (GAL).

Relações

Relação Tipo Descrição
acceptedSenders Coleção directoryObject A lista de usuários ou grupos com permissão para criar postagens ou eventos de calendário neste grupo. Se essa lista não estiver vazia, somente os usuários ou grupos listados aqui poderão postar.
appRoleAssignments appRoleAssignment collection Representa as funções de aplicativo que um grupo recebeu para um aplicativo. Suporta o $expand.
calendar calendar O calendário do grupo. Somente leitura.
calendarView Coleção event O modo de exibição do calendário. Somente leitura.
conversations Coleção conversation As conversas do grupo.
createdOnBehalfOf directoryObject O usuário (ou aplicativo) que criou o grupo. Observação: Isso não será definido se o usuário for um administrador. Apenas leitura.
drive unidade Unidade padrão do grupo. Somente leitura.
unidades Coleção drive As unidades do grupo. Somente leitura.
pontos de extremidade conjunto Ponto de extremidade Pontos de extremidade do grupo. Somente leitura. Anulável.
eventos Coleção event Eventos do grupo.
extensions Coleção extension A coleção de extensões abertas definidas para o grupo. Somente leitura. Anulável.
groupLifecyclePolicies Coleção groupLifecyclePolicy O conjunto de políticas de ciclo de vida para esse grupo. Somente leitura. Anulável.
memberOf Coleção directoryObject Grupos e unidades administrativas dos quais esse grupo é membro. Métodos HTTP: GET (suporte para todos os grupos). Somente leitura. Anulável. Suporta o $expand.
membros Coleção directoryObject Membros diretos do grupo, que podem ser usuários, dispositivos, outros grupos ou entidades de serviço. Suporta as operações Membros da lista, Adicionar membro e Remover membro. Anulável.
Suporta $expand incluindo $select aninhado. Por exemplo, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName).
membersWithLicenseErrors Coleção usuário Uma lista de membros do grupo com erros de licença desse grupo baseado em atribuição de licença. Somente leitura.
onenote onenote Somente leitura.
onPremisesSyncBehavior onPremisesSyncBehavior Indica o estado da sincronização de um grupo entre a nuvem e o Active Directory local. Suporte $filter apenas com recursos avançados de consulta. Por exemplo, $filter=onPremisesSyncBehavior/isCloudManaged eq true&$count=true.
owners Coleção directoryObject Os proprietários do grupo que podem ser usuários ou entidades de serviço. Limitado a 100 proprietários. Anulável.
  • Se essa propriedade não for especificada ao criar um grupo do Microsoft 365, o usuário de chamada (administrador ou não administrador) será atribuído automaticamente como o proprietário do grupo.
  • Um usuário não administrador não pode se adicionar explicitamente a essa coleção ao criar o grupo. Para obter mais informações, consulte o problema conhecido relacionado.
  • Para grupos de segurança, o usuário administrador não é adicionado automaticamente a essa coleção. Para obter mais informações, consulte o problema conhecido relacionado.

    Suporta $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1); Dá suporte $expand à inclusão de aninhamento $select. Por exemplo, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName).
permissionGrants resourceSpecificPermissionGrant As permissões concedidas para um grupo para um aplicativo específico. Suporta $expand.
photo profilePhoto A foto de perfil do grupo.
fotos Coleção profilePhoto As fotos de perfil pertencentes ao grupo. Somente leitura. Anulável.
planejador plannerGroup Serviços de planejador seletivo disponíveis para o grupo. Somente leitura. Anulável.
rejectedSenders Coleção directoryObject A lista de usuários ou grupos que não têm permissão para criar postagens ou eventos de calendário neste grupo. Anulável
configurações conjunto directorySetting Configurações que podem controlar o comportamento desse grupo, como membros poderem convidar usuários convidados para o grupo. Anulável.
sites conjunto de sites A lista de sites do SharePoint neste grupo. Acesse o site padrão com /sites/root.
team Coleção channel A equipe associada a este grupo.
threads Coleção conversationThread Os threads de conversas do grupo. Anulável.
transitiveMemberOf Coleção directoryObject Os grupos dos quais um grupo é membro, diretamente ou por meio de associação aninhada. Anulável.
transitiveMembers Coleção directoryObject Os membros diretos e transitórios de um grupo. Anulável.

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
  "accessType": "String",
  "assignedLabels": [{ "@odata.type": "microsoft.graph.assignedLabel" }],
  "assignedLicenses": [{ "@odata.type": "microsoft.graph.assignedLicense" }],
  "allowExternalSenders": "Boolean",
  "autoSubscribeNewMembers": "Boolean",
  "cloudLicensing": { "@odata.type": "microsoft.graph.cloudLicensing.groupCloudLicensing" },
  "createdByAppId": "String",
  "createdDateTime": "String (timestamp)",
  "deletedDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "expirationDateTime": "String (timestamp)",
  "groupTypes": ["String"],
  "hideFromAddressLists": "Boolean",
  "hideFromOutlookClients": "Boolean",
  "welcomeMessageEnabled": "Boolean",
  "id": "String (identifier)",
  "isFavorite": "Boolean",
  "isArchived": "Boolean",
  "isAssignableToRole": "Boolean",
  "isManagementRestricted": "Boolean",
  "isSubscribedByMail": "Boolean",
  "licenseProcessingState": "String",
  "mail": "String",
  "mailEnabled": "Boolean",
  "mailNickname": "String",
  "onPremisesDomainName": "String",
  "onPremisesExtensionAttributes": { "@odata.type": "microsoft.graph.onPremisesExtensionAttributes" }, 
  "onPremisesLastSyncDateTime": "String (timestamp)",
  "onPremisesNetBiosName": "String",
  "onPremisesProvisioningErrors": [
    { "@odata.type": "microsoft.graph.onPremisesProvisioningError" }
  ],
  "onPremisesSamAccountName": "String",
  "onPremisesSecurityIdentifier": "String",
  "onPremisesSyncEnabled": "Boolean",
  "preferredDataLocation": "String",
  "proxyAddresses": ["String"],
  "renewedDateTime": "String (timestamp)",
  "resourceBehaviorOptions": ["String"],
  "resourceProvisioningOptions": ["String"],
  "securityEnabled": "Boolean",
  "securityIdentifier": "String",
  "serviceProvisioningErrors": [
    { "@odata.type": "microsoft.graph.serviceProvisioningXmlError" }
  ],
  "uniqueName": "String",
  "unseenConversationsCount": "Int32",
  "unseenCount": "Int32",
  "unseenMessagesCount": "Int32",
  "visibility": "String",
  "acceptedSenders": [{ "@odata.type": "microsoft.graph.directoryObject" }],
  "calendar": { "@odata.type": "microsoft.graph.calendar" },
  "calendarView": [{ "@odata.type": "microsoft.graph.event" }],
  "conversations": [{ "@odata.type": "microsoft.graph.conversation" }],
  "createdOnBehalfOf": { "@odata.type": "microsoft.graph.directoryObject" },
  "drive": { "@odata.type": "microsoft.graph.drive" },
  "events": [{ "@odata.type": "microsoft.graph.event" }],
  "memberOf": [{ "@odata.type": "microsoft.graph.directoryObject" }],
  "members": [{ "@odata.type": "microsoft.graph.directoryObject" }],
  "membersWithLicenseErrors": [{ "@odata.type": "microsoft.graph.user" }],
  "owners": [{ "@odata.type": "microsoft.graph.directoryObject" }],
  "photo": { "@odata.type": "microsoft.graph.profilePhoto" },
  "photos": [{ "@odata.type": "microsoft.graph.profilePhoto" }],
  "rejectedSenders": [{ "@odata.type": "microsoft.graph.directoryObject" }],
  "sites": [{ "@odata.type": "microsoft.graph.site" }],
  "threads": [{ "@odata.type": "microsoft.graph.conversationThread" }],
  "classification": "String",
  "hasMembersWithLicenseErrors": "Boolean",
  "membershipRule": "String",
  "membershipRuleProcessingState": "String",
  "membershipRuleProcessingStatus": {
    "@odata.type": "microsoft.graph.membershipRuleProcessingStatus"
  },
  "preferredLanguage": "String",
  "theme": "String"
}

Conteúdo relacionado

  • Last updated on