Actualizar grupo

Espacio de nombres: microsoft.graph

Actualiza las propiedades de un objeto de grupo.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	Group.ReadWrite.All	Directory.ReadWrite.All
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	Group.ReadWrite.All	Directory.ReadWrite.All

Solicitud HTTP

PATCH /groups/{id}

Encabezados de solicitud

Nombre	Tipo	Descripción
Authorization	string	{token} de portador. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, únicamente proporcione los valores de las propiedades que deben actualizarse. Las propiedades existentes que no se incluyan en el cuerpo de la solicitud mantendrán los valores anteriores o se recalcularán según los cambios efectuados en otros valores de propiedad.

En la tabla siguiente se especifican las propiedades que se pueden actualizar.

Propiedad	Tipo	Descripción
allowExternalSenders	Booleano	El valor predeterminado es false. Indica si los usuarios externos a la organización pueden enviar mensajes al grupo.
assignedLabels	Colección assignedLabel	La lista de los pares de etiquetas de confidencialidad (Id. de etiqueta, nombre de etiqueta) asociados a un grupo de Microsoft 365.
autoSubscribeNewMembers	Booleano	El valor predeterminado es false. Indica si los miembros agregados al grupo se suscribirán de forma automática para recibir notificaciones por correo electrónico. autoSubscribeNewMembers no puede ser true si subscriptionEnabled se estableció como false para el grupo.
descripción	String	Una descripción opcional del grupo.
displayName	Cadena	El nombre para mostrar del grupo. Esta propiedad es necesaria cuando se crea un grupo y no se puede borrar durante las actualizaciones.
mailNickname	Cadena	El alias de correo para el grupo, único para los grupos de Microsoft 365 en la organización. La longitud máxima es de 64 caracteres. Esta propiedad solo puede contener caracteres incluidos en el juego de caracteres ASCII de 0 a 127 con estas excepciones: @ () \ [] " ; : . <> , SPACE.
preferredDataLocation	Cadena	Ubicación de datos preferida para el grupo de Microsoft 365. Para actualizar esta propiedad, al usuario que realiza la llamada se le debe asignar uno de los siguientes roles de Microsoft Entra: Administrador global Administrador de cuentas de usuario Escritor de directorios Administrador de Exchange Administrador de SharePoint Para obtener más información sobre esta propiedad, vea OneDrive Online Multi-Geo.
securityEnabled	Booleano	Especifica si el grupo es un grupo de seguridad.
visibility	Cadena	Especifica la visibilidad de un grupo de Microsoft 365. Los valores posibles son: Private, Public o vacío (que se interpreta como Public).

Importante

• Para actualizar las propiedades siguientes, debe especificarlas en su propia solicitud PATCH, sin incluir las otras propiedades enumeradas en la tabla anterior: allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribedByMail, unseenCount.
• Solo un subconjunto de la API de grupo que pertenece a la administración y administración de grupos principales admite permisos delegados y de aplicaciones. Todos los demás miembros de la API de grupo, incluida la actualización de autoSubscribeNewMembers, solo admiten permisos delegados.
• Las reglas para actualizar los grupos de seguridad habilitados para correo de Microsoft Exchange Server pueden ser complejas. Para obtener más información, consulte Administrar grupos de seguridad habilitados para correo en Exchange Server.
• Los permisos de aplicación no se admiten al actualizar assignedLabels.

Administración de extensiones y datos asociados

Use esta API para administrar las extensiones de directorio, esquema y abiertas y sus datos para los grupos como se indica a continuación:

• Agregue, actualice y almacene datos en las extensiones de un grupo existente.
• Para las extensiones de directorio y esquema, quite los datos almacenados estableciendo el valor de la propiedad de extensión personalizada en null. Para las extensiones abiertas, use la API Eliminar extensión abierta.

Respuesta

Si se realiza correctamente, este método devuelve un código de respuesta 204 No Content o un código de respuesta 200 OK si actualiza las siguientes propiedades: allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribedByMail y unseenCount.

Ejemplo

En el siguiente ejemplo se muestra cómo actualizar un grupo.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

HTTP

PATCH https://graph.microsoft.com/v1.0/groups/{id}
Content-type: application/json

{
  "description": "Library Assist",
  "displayName": "Library Assist",
  "groupTypes": [
    "Unified"
  ],
  "mailEnabled": true,
  "mailNickname": "library-help"
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Group
{
	Description = "Library Assist",
	DisplayName = "Library Assist",
	GroupTypes = new List<string>
	{
		"Unified",
	},
	MailEnabled = true,
	MailNickname = "library-help",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Groups["{group-id}"].PatchAsync(requestBody);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups patch --group-id {group-id} --body '{\
  "description": "Library Assist",\
  "displayName": "Library Assist",\
  "groupTypes": [\
    "Unified"\
  ],\
  "mailEnabled": true,\
  "mailNickname": "library-help"\
}\
'

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Ir

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGroup()
description := "Library Assist"
requestBody.SetDescription(&description) 
displayName := "Library Assist"
requestBody.SetDisplayName(&displayName) 
groupTypes := []string {
	"Unified",
}
requestBody.SetGroupTypes(groupTypes)
mailEnabled := true
requestBody.SetMailEnabled(&mailEnabled) 
mailNickname := "library-help"
requestBody.SetMailNickname(&mailNickname) 

groups, err := graphClient.Groups().ByGroupId("group-id").Patch(context.Background(), requestBody, nil)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Group group = new Group();
group.setDescription("Library Assist");
group.setDisplayName("Library Assist");
LinkedList<String> groupTypes = new LinkedList<String>();
groupTypes.add("Unified");
group.setGroupTypes(groupTypes);
group.setMailEnabled(true);
group.setMailNickname("library-help");
Group result = graphClient.groups().byGroupId("{group-id}").patch(group);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
  description: 'Library Assist',
  displayName: 'Library Assist',
  groupTypes: [
    'Unified'
  ],
  mailEnabled: true,
  mailNickname: 'library-help'
};

await client.api('/groups/{id}')
	.update(group);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Group;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Group();
$requestBody->setDescription('Library Assist');
$requestBody->setDisplayName('Library Assist');
$requestBody->setGroupTypes(['Unified', 	]);
$requestBody->setMailEnabled(true);
$requestBody->setMailNickname('library-help');

$result = $graphServiceClient->groups()->byGroupId('group-id')->patch($requestBody)->wait();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PowerShell

Import-Module Microsoft.Graph.Groups

$params = @{
	description = "Library Assist"
	displayName = "Library Assist"
	groupTypes = @(
	"Unified"
)
mailEnabled = $true
mailNickname = "library-help"
}

Update-MgGroup -GroupId $groupId -BodyParameter $params

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.group import Group

graph_client = GraphServiceClient(credentials, scopes)

request_body = Group(
	description = "Library Assist",
	display_name = "Library Assist",
	group_types = [
		"Unified",
	],
	mail_enabled = True,
	mail_nickname = "library-help",
)

result = await graph_client.groups.by_group_id('group-id').patch(request_body)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content