更新组
命名空间: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角色之一:
有关此属性详细信息,请参阅 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。
示例
以下示例演示如何更新组。
请求
以下示例显示了一个请求。
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"
}
响应
以下示例显示了相应的响应。
HTTP/1.1 204 No Content
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈