更新组

更新组对象的属性。

先决条件

要执行此 API,需要以下范围Group.ReadWrite.All

HTTP 请求

PATCH /groups/{id}

请求标头

名称 类型 说明
Authorization string Bearer . Required.

请求正文

在请求正文中,提供应更新的相关字段的值。请求正文中不包括的现有属性将保留其以前的值,或根据对其他属性值的更改重新计算。为了获得最佳性能,不应包括尚未更改的现有值。

属性 类型 说明
autoSubscribeNewMembers Boolean 默认为 false。指示添加到组中的新成员是否将自动订阅接收电子邮件通知。
description String 可选的组说明。
displayName String 组的显示名称。此属性是在创建组时所必需的,并且在更新过程中不能清除。支持 $filter 和 $orderby。
groupTypes String collection 指定要创建的组的类型。可取值为 Unified(要创建 Office 365 组)或 DynamicMembership(要创建动态组)。对于其他所有组类型(如启用安全机制的组和启用电子邮件的安全组),请勿设置此属性。
mailEnabled Boolean 指定该组是否启用邮件。如果 securityEnabled 属性也为 true,则该组是已启用邮件的安全组;否则是 Microsoft Exchange 通讯组。
mailNickname String 组的邮件别名。创建组时必须指定此属性。支持 $filter。
securityEnabled Boolean 指定是否为安全组。如果 mailEnabled 属性也为 true,则为启用邮件的安全组;否则为安全组。对于 Office 365 组,此属性必须为 false。支持 $filter。
visibility Boolean 指定 Office 365 组的可见性。可能的值是:专用公用或空(解释为公用)。

注意

  • 可以更新 autoSubscribeNewMembers,方法是在其自身的 PATCH 请求中指定它,而不包括上表中的其他属性。
  • 只有一部分与核心组管理和管理相关的组 API 才同时支持应用程序权限和委派权限。其他所有的组 API 成员(包括更新 autoSubscribeNewMembers)仅支持委派权限。有关示例,请参阅已知问题

响应

如果成功,此方法在响应正文中返回 200 OK 响应代码和更新的 group 对象。

示例

请求

下面是一个请求示例。

PATCH https://graph.microsoft.com/v1.0/groups/{id}
Content-type: application/json
Content-length: 211

{
  "description": "description-value",
  "displayName": "displayName-value",
  "groupTypes": [
    "groupTypes-value"
  ],
  "mail": "mail-value",
  "mailEnabled": true,
  "mailNickname": "mailNickname-value"
}
响应

下面是一个响应示例。注意:为了简单起见,可能会将此处所示的响应对象截断。将从实际调用中返回所有属性。

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 211

{
  "description": "description-value",
  "displayName": "displayName-value",
  "groupTypes": [
    "groupTypes-value"
  ],
  "mail": "mail-value",
  "mailEnabled": true,
  "mailNickname": "mailNickname-value"
}