Compartilhar via


Atualizar grupo

Namespace: microsoft.graph

Atualize as propriedades de um objeto de grupo .

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) Group.ReadWrite.All Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Group.ReadWrite.All Directory.ReadWrite.All

Solicitação HTTP

PATCH /groups/{id}

Cabeçalhos de solicitação

Nome Tipo Descrição
Autorização string {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

No corpo da solicitação, forneça apenas os valores das propriedades que devem ser atualizadas. Propriedades existentes que não estão incluídas no corpo da solicitação terão seus valores anteriores mantidos ou serão recalculadas com base nas alterações a outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Propriedade Tipo Descrição
allowExternalSenders Boolean O padrão é false. Indica se as pessoas externas à empresa podem enviar mensagens para o grupo.
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. 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.
autoSubscribeNewMembers Boolean O padrão é false. Indica se novos membros adicionados ao grupo serão automaticamente inscritos para receberem notificações por email. autoSubscribeNewMembers não pode ser true quando subscriptionEnabled é definido como false no grupo.
descrição String Uma descrição opcional para o grupo.
displayName String O nome de exibição do grupo. Essa propriedade é obrigatória quando um grupo é criado e não pode ser apagado durante atualizações.
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.
preferredDataLocation String O local de data preferido para o grupo do Microsoft 365. Para atualizar esta propriedade, tem de ser atribuída ao utilizador de chamada, pelo menos, uma das seguintes funções de 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, confira OneDrive Online Multi-Geo.
securityEnabled Boolean Especifica se o grupo é um grupo de segurança.
Nome único Cadeia de caracteres O identificador exclusivo que pode ser atribuído a um grupo e utilizado como uma chave alternativa. Só pode ser atualizado se null e for imutável uma vez definido.
visibility Cadeia de caracteres Especifica a visibilidade de um grupo do Microsoft 365. Os valores possíveis são: Privado, Público ou vazio (que é interpretado como Público).

Importante

  • Para atualizar as seguintes propriedades, tem de especificá-las no seu próprio pedido PATCH, sem incluir as outras propriedades listadas na tabela anterior: allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribedByMail, unseenCount.
  • Apenas um subconjunto da API de grupo que diz respeito à administração e gestão de grupos principais suporta a aplicação e permissões delegadas. Todos os outros membros da API de grupo, incluindo a atualização automáticaSubscribeNewMembers, suportam apenas permissões delegadas.
  • As regras para atualizar os grupos de segurança habilitados para email no Microsoft Exchange Server podem ser complexas; Para saber mais, confira Gerenciar grupos de segurança habilitados para email no Exchange Server.
  • As permissões de aplicação não são suportadas ao atualizar as assignedLabels.

Gerenciar extensões e dados associados

Use esta API para gerenciar o diretório, o esquema e as extensões abertas e seus dados para grupos, da seguinte maneira:

  • Adicione, atualize e armazene dados nas extensões de um grupo existente.
  • Para extensões de diretório e esquema, remova todos os dados armazenados definindo o valor da propriedade de extensão personalizada como null. Para extensões abertas, use a API Excluir a extensão aberta.

Resposta

Se for bem-sucedido, este método retorna um código de resposta 204 No Content, exceto um código de resposta 200 OK ao atualizar as seguintes propriedades: allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribedByMail, unseenCount.

Exemplo

O exemplo a seguir mostra como atualizar um grupo.

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/v1.0/groups/0d09007d-45b2-458c-b180-880dde3a302e
Content-type: application/json

{
  "description": "Library Assist - ADC",
  "displayName": "Library Assist - ADC",
  "mailNickname": "library-help-adc"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content