更新组

命名空间：microsoft.graph

更新 group 对象的属性。

此 API 可用于以下国家级云部署。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	✅	✅	✅

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	Group.ReadWrite.All	Directory.ReadWrite.All
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	Group.ReadWrite.All	Directory.ReadWrite.All

HTTP 请求

PATCH /groups/{id}

请求标头

名称	类型	说明
Authorization	string	持有者 {token}。 必填。 详细了解 身份验证和授权。

请求正文

在请求正文中，仅提供应更新的属性的值。 请求正文中不包括的现有属性将保留其以前的值，或根据对其他属性值的更改重新计算。

下表指定可更新的属性。

属性	类型	说明
allowExternalSenders	Boolean	默认值为“false”。 指示组织外部人员是否可以向该组发送邮件。
assignedLabels	assignedLabel 集合	与 Microsoft 365 组关联的敏感度标签对（标签 ID、标签名称）列表。
autoSubscribeNewMembers	Boolean	默认值为“false”。 指示添加到组中的新成员是否将自动订阅接收电子邮件通知。 当组上的subscriptionEnabled设置为 false 时，autoSubscribeNewMembers不能为 true。
说明	String	可选的组说明。
displayName	String	组的显示名称。 此属性是在创建组时所必需的，并且在更新过程中不能清除。
mailNickname	String	组的邮件别名，它对于组织中的 Microsoft 365 组是唯一的。 最大长度为 64 个字符。 此属性只能包含ASCII 字符集 0 - 127 中的字符，以下除外： @ () \ [] " ; : . <> , SPACE。
preferredDataLocation	String	Microsoft 365 组的首选数据位置。 若要更新此属性，必须至少为调用用户分配以下Microsoft Entra 角色之一： 用户帐户管理员 目录写入程序 Exchange 管理员 SharePoint 管理员 有关此属性详细信息，请参阅 OneDrive Online 多地理位置。
securityEnabled	布尔	指定是否为安全组。
唯一名称	String	可分配给组并用作备用键的唯一标识符。 仅当 null 和 设置为不可变时，才能更新。
visibility	String	指定 Microsoft 365 组的可见性。 可能的是包括：专用、公用或为空（解释为公用）。

重要

• 若要更新以下属性，必须在自己的 PATCH 请求中指定它们，而不包括上表中列出的其他属性： allowExternalSenders、 autoSubscribeNewMembers、 hideFromAddressLists、 hideFromOutlookClients、 isSubscribedByMail、 unseenCount。
• 只有与核心组管理相关的组 API 子集支持应用程序和委派权限。 组 API 的所有其他成员（包括更新 autoSubscribeNewMembers）仅支持委派的权限。
• 在 Microsoft Exchange Server 中更新启用邮件的安全组的规则可能很复杂；若要了解详细信息，请参阅在 Exchange Server 中管理启用邮件的安全组。
• 更新 assignedLabels 时不支持应用程序权限。

管理扩展和关联的数据

使用此 API 管理组的 目录、架构和开放扩展 及其数据，如下所示：

• 在现有组的扩展中添加、更新和存储数据。
• 对于目录和架构扩展，可通过将自定义扩展属性的值设置为 null 来删除任何存储的数据。 对于开放扩展，请使用 删除开放扩展 API。

响应

如果成功， 此方法返回 204 No Content 响应代码 - 更新下列属性时除了 200 OK 响应代码：allowEx在alSenders、 autoSubendNewMembers， HideFromAddressList， hideFromOutlookClients， isSubeendByMail， unseenCount。

示例

以下示例演示如何更新组。

请求

以下示例显示了一个请求。

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

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

CLI

mgc groups patch --group-id {group-id} --body '{\
  "description": "Library Assist - ADC",\
  "displayName": "Library Assist - ADC",\
  "mailNickname": "library-help-adc"\
}\
'

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Go

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

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 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);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 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);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 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();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 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

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Python

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

graph_client = GraphServiceClient(credentials, scopes)

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)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content