Mettre à jour un groupe

Espace de noms: microsoft.graph

Mettre à jour les propriétés d’un objet « group ».

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	Group.ReadWrite.All	Directory.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Group.ReadWrite.All	Directory.ReadWrite.All

Requête HTTP

PATCH /groups/{id}

En-têtes de demande

Nom	Type	Description
Autorisation	string	Porteur {token}. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez uniquement les valeurs des propriétés qui doivent être mises à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conserveront leurs valeurs précédentes ou seront recalculées en fonction des modifications apportées à d’autres valeurs des propriétés.

Le tableau ci-dessous spécifie les propriétés pouvant être mises à jour.

Propriété	Type	Description
allowExternalSenders	Boolean	La valeur par défaut est false. Indique si les personnes extérieures à l’organisation peuvent envoyer des messages au groupe.
assignedLabels	Collection assignedLabel	La liste des paires d’étiquettes de confidentialité (ID d’étiquette, nom d’étiquette) associées à un groupe Microsoft 365.
autoSubscribeNewMembers	Boolean	La valeur par défaut est false. Indique si les nouveaux membres ajoutés au groupe seront automatiquement inscrits pour recevoir des notifications par courrier électronique. autoSubscribeNewMembers ne peut pas être true lorsque subscriptionEnabled est false sur le groupe.
description	String	Description facultative du groupe.
displayName	String	Nom complet du groupe. Cette propriété est requise lors de la création d’un groupe et ne peut pas être désactivée lors des mises à jour.
mailNickname	String	Alias de messagerie du groupe, unique pour Microsoft 365 de l’organisation. Longueur maximale : 64 caractères. Cette propriété ne peut contenir que des caractères dans le jeu de caractères ASCII 0 – 127, sauf les caractères suivants : @ () \ [] " ; : . <> , SPACE.
preferredDataLocation	Chaîne	Emplacement de données préféré pour le groupe Microsoft 365. Pour mettre à jour cette propriété, l’utilisateur appelant doit se voir attribuer l’un des rôles Microsoft Entra suivants : Administrateur général Administrateur de compte d’utilisateur Rédacteur d’annuaire Administrateur Exchange Administrateur SharePoint Pour plus d'informations sur cette propriété, voir OneDrive en ligne Multi-Geo.
securityEnabled	Boolean	Indique si le groupe est un groupe de sécurité.
visibility	String	Spécifie la visibilité d’un groupe Microsoft 365. Les valeurs possibles sont les suivantes : Private, Public ou vide (qui est interprété comme étant Public).

Importante

• Pour mettre à jour les propriétés suivantes, vous devez les spécifier dans leur propre demande PATCH, sans inclure les autres propriétés répertoriées dans le tableau précédent : allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribeByMail, unseenCount.
• Seul un sous-ensemble de l’API de groupe qui se rapporte à l’administration et à la gestion du groupe principal prend en charge les autorisations d’application et déléguées. Tous les autres membres de l’API de groupe, y compris la mise à jour d’autoSubscribeNewMembers, prennent uniquement en charge les autorisations déléguées.
• Les règles de mise à jour des groupes de sécurité à extension messagerie dans Microsoft Exchange Server peuvent être complexes. Pour en savoir plus, voir gérer les groupes de sécurité à extension messagerie dans Exchange Server.
• Les autorisations d’application ne sont pas prises en charge lors de la mise à jour de assignedLabels.

Gérer les extensions et les données associées

Utilisez cette API pour gérer le répertoire, le schéma et les extensions ouvertes et leurs données pour les utilisateurs, de la manière suivante :

• Ajoutez, mettez à jour et stockez des données dans les extensions pour un groupe existant.
• Pour les extensions de répertoire et de schéma, supprimez toutes les données stockées en définissant la valeur de la propriété d’extension personnalisée sur null. Pour les extensions ouvertes, utilisez l’API Supprimer une extension ouverte.

Réponse

En cas de réussite, cette méthode renvoie un code de réponse 204 No Content à l’exception d’un code de réponse 200 OK lors de la mise à jour des propriétés suivantes : allowExternalSenders, autoSubscribeNewMembers, FromAddressLists, hideFromOutlookClients, isSubscribedByMail, unseenCount.

Exemple

L’exemple ci-après montre comment faire la mise à jour d’un groupe.

Demande

L’exemple suivant illustre une demande.

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

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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"\
}\
'

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

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)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content