Actualizar grupo

Espacio de nombres: microsoft.graph

Actualizar las propiedades de un objeto de grupo .

Nota:

Cuando se usa members@odata.bind para agregar miembros a través de PATCH, esta solicitud puede tener retrasos de replicación para grupos creados recientemente. El objeto de grupo puede tardar un poco en replicarse completamente en las réplicas del directorio de Microsoft Entra ID. Durante esta ventana, las solicitudes para agregar miembros al grupo pueden devolver un 400 Bad Request error con el mensaje: "El objeto de recurso de origen o uno de los objetos a los que se hace referencia no existe".

Para mitigar este comportamiento:

• Vuelva a intentarlo después de un breve retraso : espere unos segundos y vuelva a intentar la solicitud. El retraso suele ser breve.

Para obtener más información, consulte Diseño para lograr coherencia eventual para Microsoft Entra.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global	Administración pública de EE. UU.	Gobierno de EE. UU. L5 (DOD)	China operado por 21Vianet
✅	✅	✅	✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos 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-NestingSupport.ReadWrite.all	Directory.ReadWrite.All, Group-PreferredDataLocation.ReadWrite.All, Group.ManageProtection.All, Group.ReadWrite.All
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	group-NestingSupport.ReadWrite.all	Directory.ReadWrite.All, Group-PreferredDataLocation.ReadWrite.All, Group.ManageProtection.All, Group.ReadWrite.All

Permisos para escenarios específicos

• Group-NestingSupport.ReadWrite.All es el permiso con privilegios mínimos para actualizar la propiedad disableNesting .

• Group.ManageProtection.All El permiso delegado es el permiso con privilegios mínimos para actualizar la propiedad assignedLabels para los grupos de seguridad en la nube. No se admiten escenarios de solo aplicación.

Solicitud HTTP

PATCH /groups/{id}

Encabezados de solicitud

Nombre	Tipo	Descripción
Authorization	string	{token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.

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 pares de etiquetas de confidencialidad (id. de etiqueta, nombre de etiqueta) asociados a un grupo de Microsoft 365 o un grupo de seguridad en la nube. Requiere una licencia de Microsoft Entra ID P1. Esta propiedad se puede especificar durante la creación o actualización del grupo. Sin embargo, para los grupos de seguridad en la nube, es inmutable una vez que se establece. Para los grupos de Microsoft 365, esta propiedad solo se puede actualizar en escenarios delegados donde el autor de la llamada requiere tanto el permiso de Microsoft Graph como un rol de administrador admitido. Group.ManageProtection.All es el permiso con privilegios mínimos para actualizar esta propiedad para los grupos de seguridad en la nube. No se admiten escenarios de solo aplicación. Consulte Diferencias clave con el etiquetado de grupos de Microsoft 365 para obtener más información sobre cómo administrar esta propiedad para los grupos de seguridad de Microsoft 365 frente a los grupos de seguridad en la nube.
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 llama se le debe asignar al menos uno de los siguientes roles de Microsoft Entra: 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.
uniqueName	Cadena	Identificador único que puede asignarse a un grupo y usarse como clave alternativa. Solo se puede actualizar si null y es inmutable una vez que se establece.
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 estas propiedades (accessType, allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isFavorite, isSubscribedByMail, unseenConversationsCount, unseenCount, unseenMessagesCount), debe:
  • Identifíquelos en su propia solicitud PATCH sin incluir otras propiedades de la tabla anterior
  • Tener el permiso Group.ReadWrite.All (Directory.ReadWrite.All no es compatible con estas propiedades)
• Solo un subconjunto de la API de grupo que pertenece a la administración y gestión del grupo principal admite permisos delegados y de aplicación. Todos los demás miembros de la API del 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. Group.ManageProtection.All es el permiso con privilegios mínimos para actualizar assignedLabels para grupos de seguridad en la nube.

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 tiene éxito, este método devuelve un 204 No Content código de respuesta, excepto un 200 OK código de respuesta al actualizar las siguientes propiedades: accessType, allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isFavorite, isSubscribedByMail, unseenConversationsCount, unseenCount, unseenMessagesCount.

Errores

Código de estado	Código de error	Mensaje de error	Descripción
400 Bad Request	Request_BadRequest	"El objeto de recurso de origen o uno de los objetos a los que se hace referencia no existe".	El grupo se creó recientemente y no se ha replicado completamente en todas las réplicas de directorio. Este error es específico de las operaciones de escritura de vínculos (agregar miembros a través de members@odata.bind). Vuelva a intentar la solicitud después de un breve retraso.

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/0d09007d-45b2-458c-b180-880dde3a302e
Content-type: application/json

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

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 - ADC",
	DisplayName = "Library Assist - ADC",
	MailNickname = "library-help-adc",
};

// 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.

Ir

// Code snippets are only available for the latest major version. Current major version is $v1.*

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

requestBody := graphmodels.NewGroup()
description := "Library Assist - ADC"
requestBody.SetDescription(&description) 
displayName := "Library Assist - ADC"
requestBody.SetDisplayName(&displayName) 
mailNickname := "library-help-adc"
requestBody.SetMailNickname(&mailNickname) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
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 - ADC");
group.setDisplayName("Library Assist - ADC");
group.setMailNickname("library-help-adc");
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 - ADC',
  displayName: 'Library Assist - ADC',
  mailNickname: 'library-help-adc'
};

await client.api('/groups/0d09007d-45b2-458c-b180-880dde3a302e')
	.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 - ADC');
$requestBody->setDisplayName('Library Assist - ADC');
$requestBody->setMailNickname('library-help-adc');

$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 - ADC"
	displayName = "Library Assist - ADC"
	mailNickname = "library-help-adc"
}

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

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.group import Group
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Group(
	description = "Library Assist - ADC",
	display_name = "Library Assist - ADC",
	mail_nickname = "library-help-adc",
)

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