Actualizar grupo

Artículo
08/11/2023

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Actualice 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, incluidos los grupos de Microsoft 365.
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).
writebackConfiguration	groupWritebackConfiguration	Especifica si un grupo está configurado para reescritura de propiedades de objeto de grupo en Active Directory local. Estas propiedades se usan cuando se configura la escritura diferida de grupos en el cliente de sincronización de Microsoft Entra Connect.

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.

Ejemplos

Ejemplo 1: Actualización del nombre para mostrar y la descripción de un grupo

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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

{
   "description":"Contoso Life v2.0",
   "displayName":"Contoso Life Renewed"
}


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

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new Group
{
	Description = "Contoso Life v2.0",
	DisplayName = "Contoso Life Renewed",
};

// 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);

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

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.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta groups patch --group-id {group-id} --body '{\
   "description":"Contoso Life v2.0",\
   "displayName":"Contoso Life Renewed"\
}\
'

Importante

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.



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGroup()
description := "Contoso Life v2.0"
requestBody.SetDescription(&description) 
displayName := "Contoso Life Renewed"
requestBody.SetDisplayName(&displayName) 

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

Importante

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.


// 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("Contoso Life v2.0");
group.setDisplayName("Contoso Life Renewed");
Group result = graphClient.groups().byGroupId("{group-id}").patch(group);

Importante

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.


const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
   description: 'Contoso Life v2.0',
   displayName: 'Contoso Life Renewed'
};

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

Importante

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
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Group;


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

$requestBody = new Group();
$requestBody->setDescription('Contoso Life v2.0');
$requestBody->setDisplayName('Contoso Life Renewed');

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

Importante

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.


Import-Module Microsoft.Graph.Beta.Groups

$params = @{
	description = "Contoso Life v2.0"
	displayName = "Contoso Life Renewed"
}

Update-MgBetaGroup -GroupId $groupId -BodyParameter $params

Importante

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.


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

graph_client = GraphServiceClient(credentials, scopes)

request_body = Group(
	description = "Contoso Life v2.0",
	display_name = "Contoso Life Renewed",
)

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

Importante

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

Ejemplo 2: Aplicación de una etiqueta de confidencialidad a un grupo de Microsoft 365

Solicitud

Puede obtener el identificador de la etiqueta que desea aplicar a un grupo de Microsoft 365 mediante la etiqueta Lista. A continuación, puede actualizar la propiedad assignedLabels del grupo con el identificador de etiqueta.

Nota: El uso de esta API para aplicar etiquetas de confidencialidad a grupos de Microsoft 365 solo se admite en escenarios de permisos delegados.

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

{
  "assignedLabels":
  [
    {
        "labelId" : "45cd0c48-c540-4358-ad79-a3658cdc5b88"
    }
  ]
}


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

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new Group
{
	AssignedLabels = new List<AssignedLabel>
	{
		new AssignedLabel
		{
			LabelId = "45cd0c48-c540-4358-ad79-a3658cdc5b88",
		},
	},
};

// 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);

Importante

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.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta groups patch --group-id {group-id} --body '{\
  "assignedLabels":\
  [\
    {\
        "labelId" : "45cd0c48-c540-4358-ad79-a3658cdc5b88"\
    }\
  ]\
}\
'

Importante

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.



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGroup()


assignedLabel := graphmodels.NewAssignedLabel()
labelId := "45cd0c48-c540-4358-ad79-a3658cdc5b88"
assignedLabel.SetLabelId(&labelId) 

assignedLabels := []graphmodels.AssignedLabelable {
	assignedLabel,
}
requestBody.SetAssignedLabels(assignedLabels)

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

Importante

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.


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Group group = new Group();
LinkedList<AssignedLabel> assignedLabels = new LinkedList<AssignedLabel>();
AssignedLabel assignedLabel = new AssignedLabel();
assignedLabel.setLabelId("45cd0c48-c540-4358-ad79-a3658cdc5b88");
assignedLabels.add(assignedLabel);
group.setAssignedLabels(assignedLabels);
Group result = graphClient.groups().byGroupId("{group-id}").patch(group);

Importante

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.


const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
  assignedLabels: 
  [
    {
        labelId: '45cd0c48-c540-4358-ad79-a3658cdc5b88'
    }
  ]
};

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

Importante

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
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Group;
use Microsoft\Graph\Generated\Models\AssignedLabel;


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

$requestBody = new Group();
$assignedLabelsAssignedLabel1 = new AssignedLabel();
$assignedLabelsAssignedLabel1->setLabelId('45cd0c48-c540-4358-ad79-a3658cdc5b88');
$assignedLabelsArray []= $assignedLabelsAssignedLabel1;
$requestBody->setAssignedLabels($assignedLabelsArray);


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

Importante

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.


Import-Module Microsoft.Graph.Beta.Groups

$params = @{
	assignedLabels = @(
		@{
			labelId = "45cd0c48-c540-4358-ad79-a3658cdc5b88"
		}
	)
}

Update-MgBetaGroup -GroupId $groupId -BodyParameter $params

Importante

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.


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

graph_client = GraphServiceClient(credentials, scopes)

request_body = Group(
	assigned_labels = [
		AssignedLabel(
			label_id = "45cd0c48-c540-4358-ad79-a3658cdc5b88",
		),
	],
)

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

Importante

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

Actualizar grupo

Permissions

Solicitud HTTP

Encabezados de solicitud

Cuerpo de la solicitud

Administración de extensiones y datos asociados

Respuesta

Ejemplos

Ejemplo 1: Actualización del nombre para mostrar y la descripción de un grupo

Solicitud

Respuesta

Ejemplo 2: Aplicación de una etiqueta de confidencialidad a un grupo de Microsoft 365

Solicitud

Respuesta

Comentarios

Comentarios

Recursos adicionales

Actualizar grupo

Permissions

Solicitud HTTP

Encabezados de solicitud

Cuerpo de la solicitud

Administración de extensiones y datos asociados

Respuesta

Ejemplos

Ejemplo 1: Actualización del nombre para mostrar y la descripción de un grupo

Solicitud

Respuesta

Ejemplo 2: Aplicación de una etiqueta de confidencialidad a un grupo de Microsoft 365

Solicitud

Respuesta

Contenido relacionado

Comentarios

Comentarios

Recursos adicionales