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 Microsoft Entra, que pode ser um grupo do Microsoft 365, uma equipa no Microsoft Teams ou um grupo de segurança. Esse recurso é um tipo aberto que permite que outras propriedades sejam passadas.
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 devolvidas por predefinição, especifique-as numa $select
opção de consulta OData.
Esse recurso permite:
- Adicionar os seus dados a propriedades personalizadas como extensões.
- Assinar as notificações de alteração.
- Usar a consulta delta para controlar adições, exclusões e atualizações incrementais oferecendo uma função delta.
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. |
Delete | Nenhum | Excluir um objeto group. |
Obter delta | Coleção group | Obter alterações incrementais para grupos. |
Upsert | group | Crie um novo grupo se não existir ou atualize as propriedades de um grupo existente. |
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 este grupo ao publicar na propriedade de navegação dos membros (suportada 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 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. |
Listar membro de | Coleção directoryObject | Obter os grupos e as unidades administrativas dos quais esse grupo é membro direto, da propriedade de navegação memberOf. |
Listar políticas de ciclo de vida de grupo | Coleção groupLifecyclePolicy | Listar políticas de ciclo de vida de grupo. |
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 membro transitivo de | 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. |
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 a apresentar ou a alcunha de correio de um grupo do Microsoft 365 que esteja em conformidade com as políticas de nomenclatura. |
Atribuição de funções do aplicativo | ||
List | appRoleAssignment collection | Obtenha as aplicações e as funções de aplicação às 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 | Obtenha 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. |
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 aceite | 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 | Obtenha os grupos eliminados no inquilino nos últimos 30 dias que pertencem a um utilizador. |
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 | Devolver todos os grupos de que 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 | Coleção de cadeias de caracteres | Devolver todos os grupos e unidades administrativas de que 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 | Devolver uma coleção de objetos driveItem na relação subordinada 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 definição com base num diretórioDefiniçãoTemplata. O pedido POST tem de fornecer settingValues para todas as definições definidas no modelo. Apenas os modelos específicos de grupos podem ser utilizados 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 definiçã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 início de sessão único baseado em palavra-passe | ||
Get | passwordSingleSignOnCredentialSet collection (coleção passwordSingleSignOnCredentialSet) | Obtenha a lista de credenciais de início de sessão único baseado em palavra-passe para este grupo. As palavras-passe nunca são devolvidas e, em vez disso, são sempre devolvidas como nulas. |
Delete | Nenhum | Elimine a credencial de início de sessão único baseado em palavra-passe para um determinado principal de serviço associado a este grupo. |
nome. | ||
Fotografia de 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 | Elimine a fotografia de qualquer utilizador no inquilino, incluindo o utilizador com sessão iniciada ou o grupo especificado. |
Planner | ||
Listar planos | coleção plannerPlan | Obter planos atribuídos ao grupo. |
Mensagens | ||
List | Coleção post | Obter mensagens num tópico de conversação. |
Get | postagem | Obter uma publicação específica. |
Responder a publicar | Nenhum | Responder a uma mensagem. |
Encaminhar postagem | Nenhum | Reencaminhar uma mensagem. |
Outros recursos de grupo | ||
Listar as concessões de permissões | Coleção resourceSpecificPermissionGrant | Liste as permissões concedidas às aplicações para aceder ao 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 este utilizador é um 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 . Desativar o utilizador com sessão iniciada para receber conversações por e-mail. Apenas grupos do Microsoft 365 são suportados. |
Redefinir contagem não vista | Nenhum | Reponha a unseenCount para 0 para todas as publicações que o utilizador com sessão iniciada não vê desde a ú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, veja Capacidades avançadas 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 , secret e public . |
allowExternalSenders | Boolean | Indica se as pessoas externas à empresa podem enviar mensagens para o grupo. O valor padrão é false . Retornado apenas em $select . Com suporte apenas para Obter API de grupo (GET /groups/{ID} ) |
assignedLabels | coleção assignedLabel | Lista de pares de rótulos de confidencialidade (ID do rótulo, nome do rótulo) associados a um grupo do Microsoft 365. Retornado apenas em $select . Esta propriedade só pode ser atualizada em cenários delegados em que o autor da chamada necessita da permissão do Microsoft Graph e de uma função de administrador suportada. |
assignedLicenses | Coleção assignedLicense | As licenças que são atribuídas ao grupo. Retornado apenas em $select . Suporta $filter (eq ). Somente leitura. |
autoSubscribeNewMembers | Boolean | Indica se os novos membros adicionados ao grupo estão inscritos automaticamente para receber notificações por email. Pode definir esta propriedade num pedido PATCH para o grupo; não o defina no pedido POST inicial que cria o grupo. O valor padrão é false . Retornado apenas em $select . Com suporte apenas para Obter API de grupo (GET /groups/{ID} ) |
classificação | String | Descreve uma classificação para o grupo (como impacto comercial baixo, médio ou elevado). Os valores válidos para esta propriedade são definidos através da criação de um valor de definição ClassificationList, com base na definição do modelo. Retornado por padrão. Suporta $filter (eq , ne , not , ge , le , startsWith ). |
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 carimbo de data/hora representa informações de data e hora com 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 Microsoft Entra objetos (utilizador, grupo, aplicação), se o objeto for eliminado, primeiro é eliminado logicamente e esta propriedade é atualizada com a data e hora em que o objeto foi eliminado. 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. Destina-se null a grupos de segurança, mas para grupos do Microsoft 365, representa quando o grupo está definido para expirar conforme definido no grupoLifecyclePolicy. O tipo carimbo de data/hora representa informações de data e hora com 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 é um grupo do Microsoft 365; caso contrário, é 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 apresentado em determinadas partes da interface de utilizador do Outlook: no Livro de Endereços, nas listas de endereços para selecionar destinatários de mensagens e na caixa de diálogo Procurar Grupos para procurar grupos; caso contrário, falso. O valor padrão é false . Retornado apenas em $select . Com suporte apenas para Obter API de grupo (GET /groups/{ID} ) |
hideFromOutlookClients | Booliano |
true se o grupo não for apresentado nos clientes do Outlook, como o Outlook para Windows e Outlook na Web, caso contrário, falso. O valor padrão é false . Retornado apenas em $select . 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 este grupo pode ser atribuído a uma função de Microsoft Entra. Opcional. Esta propriedade só pode ser definida durante a criação do grupo e é imutável. Se definida como true , a propriedade securityEnabled também tem de ser definida como , a true visibilidade tem de ser Hidden e o grupo não pode ser um grupo dinâmico (ou seja, groupTypes não pode conter DynamicMembership ). Apenas os autores de chamadas com, pelo menos, a função Administrador de Função Privilegiada podem definir esta propriedade. O autor da chamada também tem de ter a permissão RoleManagement.ReadWrite.Directory para definir esta propriedade ou atualizar a associação desses grupos. Para obter mais informações, veja Utilizar um grupo para gerir atribuições de funções Microsoft Entra Utilizar esta funcionalidade requer uma licença Microsoft Entra ID P1. Devolvido por padrão. Suporta $filter (eq , ne , not ). |
isFavorite | Boolean | Indica se o utilizador marcou o grupo como favorito. |
isManagementRestricted | Booliano | Indica se o grupo é membro de uma unidade administrativa de gestão restrita. O valor padrão é false . Somente leitura. Para gerir um membro do grupo de uma unidade administrativa de gestão restrita, tem de ser atribuída ao administrador ou à aplicação de chamada uma função de Microsoft Entra no âmbito da unidade administrativa de gestão 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 . Retornado apenas em $select . Com suporte apenas para Obter API de grupo (GET /groups/{ID} ) |
licenseProcessingState | String | Indica a status da atribuição de licença de grupo a todos os membros do grupo. Valores possíveis: QueuedForProcessing , ProcessingInProgress e ProcessingComplete . Retornado apenas em $select . Somente leitura. |
String | O endereço SMTP para o 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 destina-se null a grupos dinâmicos não baseados em regras ou se o processamento de grupo dinâmico foi colocado em pausa. Retornado apenas em $select . 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 só é preenchida para clientes que sincronizam o respetivo diretório no local para Microsoft Entra ID através do Microsoft Entra Connect. Retornado por padrão. Somente leitura. |
onPremisesLastSyncDateTime | DateTimeOffset | Indica a última vez em que o grupo foi sincronizado com o diretório no local. O tipo carimbo de data/hora representa informações de data e hora com 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 só é preenchida para clientes que sincronizam o respetivo diretório no local para Microsoft Entra ID através 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 só é preenchida para clientes que sincronizam o respetivo diretório no local para Microsoft Entra ID através do Microsoft Entra Connect. Devolvido por padrão. Suporta $filter (eq , ne , not , ge , le , in , startsWith ). Somente leitura. |
onPremisesSecurityIdentifier | String | Contém o identificador de segurança (SID) no local para o grupo sincronizado do local para a cloud. 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 esta propriedade, a aplicação de chamadas tem de ter a permissão Directory.ReadWrite.All e ser atribuída ao utilizador, pelo menos, uma das seguintes funções de Microsoft Entra:
Para obter mais informações sobre esta 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 carimbo de data/hora representa informações de data e hora com 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 só pode ser definida como parte da criação (POST). Para obter a lista de valores possíveis, consulte Comportamento do grupo do Microsoft 365 e opções de aprovisionamento. |
resourceProvisioningOptions | Conjunto de cadeias de caracteres | Especifica os recursos de grupo associados ao grupo do Microsoft 365. O valor possível é Team . Para obter mais informações, consulte Comportamento do grupo do Microsoft 365 e opções de aprovisionamento. 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 collection | Erros publicados por um serviço federado que descreve um erro não transitório específico do serviço relativo às propriedades ou ligação 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 utilizado como uma chave alternativa. Imutável. Somente leitura. |
unseenConversationsCount | Int32 | A contagem de conversações efetuou uma ou mais novas publicações desde a última visita do utilizador com sessão iniciada ao grupo. Essa propriedade é igual a unseenCount. Retornado apenas em $select . |
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. Retornado apenas em $select . 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. Retornado apenas em $select . |
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 só pode ser definido 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, é criado um grupo de segurança como Private por predefinição e o grupo do Microsoft 365 é Public . Grupos atribuídos a funções são sempre Private . Para saber mais, veja opções de visibilidade de grupo. Retornado por padrão. Anulável. |
writebackConfiguration | groupWritebackConfiguration | Especifica se um grupo está ou não configurado para escrever as propriedades do objeto de grupo para Active Directory local. Estas propriedades são utilizadas quando a repetição de escrita de grupos é configurada no cliente de sincronização do Microsoft Entra Connect. |
Opções de visibilidade do grupo
Valor | Descrição |
---|---|
Público | Qualquer pessoa pode aderir ao grupo sem a permissão do proprietário. Qualquer pessoa pode ver os conteúdos 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 utilizadores ou grupos autorizados a criar mensagens ou eventos de calendário neste grupo. Se esta lista não estiver vazia, apenas os utilizadores ou grupos listados aqui podem publicar. |
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. Nota: Esta opção não é definida se o utilizador 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 utilizadores, dispositivos, outros grupos ou principais 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. |
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. $filter Suporta (/$count eq 0 , /$count ne 0 , /$count eq 1 , /$count ne 1 ); Suporta, $expand incluindo o aninhado $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 a uma aplicação específica. Suporta $expand . |
photo | profilePhoto | A foto de perfil do grupo. |
fotos | Coleção profilePhoto | As fotografias 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 utilizadores ou grupos não autorizados a criar mensagens 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. Aceda ao site predefinido com /sites/raiz. |
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 de que um grupo é membro, diretamente ou através da 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 seguinte mostra o tipo de recurso.
{
"accessType": "String",
"assignedLabels": [{ "@odata.type": "microsoft.graph.assignedLabel" }],
"assignedLicenses": [{ "@odata.type": "microsoft.graph.assignedLicense" }],
"allowExternalSenders": false,
"autoSubscribeNewMembers": true,
"createdByAppId": "String",
"createdDateTime": "String (timestamp)",
"deletedDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"expirationDateTime": "String (timestamp)",
"groupTypes": ["String"],
"hideFromAddressLists": false,
"hideFromOutlookClients": false,
"id": "String (identifier)",
"isFavorite": true,
"isArchived": false,
"isAssignableToRole": false,
"isSubscribedByMail": true,
"licenseProcessingState": "String",
"mail": "String",
"mailEnabled": true,
"mailNickname": "String",
"onPremisesDomainName": "String",
"onPremisesLastSyncDateTime": "String (timestamp)",
"onPremisesNetBiosName": "String",
"onPremisesProvisioningErrors": [
{ "@odata.type": "microsoft.graph.onPremisesProvisioningError" }
],
"onPremisesSamAccountName": "String",
"onPremisesSecurityIdentifier": "String",
"onPremisesSyncEnabled": true,
"preferredDataLocation": "String",
"proxyAddresses": ["String"],
"renewedDateTime": "String (timestamp)",
"resourceBehaviorOptions": ["String"],
"resourceProvisioningOptions": ["String"],
"securityEnabled": true,
"securityIdentifier": "String",
"serviceProvisioningErrors": [
{ "@odata.type": "microsoft.graph.serviceProvisioningXmlError" }
],
"uniqueName": "String",
"unseenConversationsCount": 1024,
"unseenCount": 1024,
"unseenMessagesCount": 1024,
"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": true,
"membershipRule": "String",
"membershipRuleProcessingState": "String",
"membershipRuleProcessingStatus": {
"@odata.type": "microsoft.graph.membershipRuleProcessingStatus"
},
"preferredLanguage": "String",
"theme": "String"
}