Mettre à jour un groupe

Article
10/28/2023

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Mettez à jour les propriétés d’un objet de groupe .

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	Spécifie si le groupe est un groupe de sécurité, y compris les groupes Microsoft 365.
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).
writebackConfiguration	groupWritebackConfiguration	Spécifie si un groupe est configuré pour écrire des propriétés d’objet de groupe dans Active Directory local. Ces propriétés sont utilisées lorsque l’écriture différée de groupe est configurée dans le client de synchronisation Microsoft Entra Connect.

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.

Exemples

Exemple 1 : Mettre à jour le nom complet et la description d’un groupe

Demande

L’exemple suivant illustre une demande.

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

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

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


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



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


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


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


<?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


Import-Module Microsoft.Graph.Beta.Groups

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

Update-MgBetaGroup -GroupId $groupId -BodyParameter $params

Importante


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

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 2 : Appliquer une étiquette de confidentialité à un groupe Microsoft 365

Demande

Vous pouvez obtenir l’ID de l’étiquette que vous souhaitez appliquer à un groupe Microsoft 365 à l’aide de l’étiquette de liste. Vous pouvez ensuite mettre à jour la propriété assignedLabels du groupe avec l’ID d’étiquette.

Note: L’utilisation de cette API pour appliquer des étiquettes de confidentialité aux groupes Microsoft 365 est prise en charge uniquement pour les scénarios d’autorisation déléguée.

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


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



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


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


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


<?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


Import-Module Microsoft.Graph.Beta.Groups

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

Update-MgBetaGroup -GroupId $groupId -BodyParameter $params

Importante


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

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Mettre à jour un groupe

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

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

Réponse

Exemples

Exemple 1 : Mettre à jour le nom complet et la description d’un groupe

Demande

Réponse

Exemple 2 : Appliquer une étiquette de confidentialité à un groupe Microsoft 365

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires

Mettre à jour un groupe

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

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

Réponse

Exemples

Exemple 1 : Mettre à jour le nom complet et la description d’un groupe

Demande

Réponse

Exemple 2 : Appliquer une étiquette de confidentialité à un groupe Microsoft 365

Demande

Réponse

Contenu connexe

Commentaires

Commentaires

Ressources supplémentaires