创建设置

命名空间：microsoft.graph

基于 groupSettingTemplates 中可用的模板创建新的组设置。 这些设置可以位于租户级别或组级别。

以下组设置模板可用于组：

  • Group.Unified：配置所有或特定Microsoft 365 组的设置。
  • Group.Unified.Guest：配置特定Microsoft 365 组的来宾访问设置。
  • Group.Security：配置所有或特定云安全组的设置，例如启用 MIP 敏感度标签。 需要 Microsoft Entra ID P1 许可证。
  • Group.Security.Policies：配置特定云安全组的设置。 需要 Microsoft Entra ID P1 许可证。

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

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

权限

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

创建租户范围的设置

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

重要

对于使用工作或学校帐户的委派访问，必须为登录用户分配受支持的Microsoft Entra角色或授予此操作所需权限的自定义角色。 此操作支持以下内置角色，这些角色仅提供所需的最小特权：

  • 读取有关设置模板和设置的基本属性 - Microsoft Entra加入的设备本地管理员、目录读取器、全局读取器
  • 管理所有组/目录设置 - 目录编写器
  • 管理组的全局和本地设置;管理和Group.Unified.GuestGroup.Unified设置 - 组管理员
  • 更新 Password Rule Settings - 身份验证策略管理员
  • 更新设置，读取有关设置模板和设置的基本属性 - 用户管理员

向应用授予委派 Directory.Read.All 或 Directory.ReadWrite.All 权限后，已登录用户只需要默认成员角色。 无需其他Microsoft Entra角色。 仅当向调用应用授予了更有限的委托权限（例如 GroupSettings.Read.All）时才需要上面列出的Microsoft Entra角色。 在这种情况下，已登录用户必须持有列出的角色之一。

创建组特定的设置

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

HTTP 请求

创建租户范围的设置。

POST /groupSettings

创建组特定的设置。

POST /groups/{id}/settings

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json

请求正文

在请求正文中，提供 groupSetting 对象的 JSON 表示形式。 显示名称、templateId 和说明继承自引用的 groupSettingTemplates 对象。 只能更改默认值的值属性。

创建 groupSetting 对象时需要以下属性。

参数 类型 说明
templateId String 用于创建此组级设置对象的租户级 groupSettingTemplates 对象的唯一标识符。 只读。
values settingValue 集合 与引用组SettingTemplates 对象中的 name 和 defaultValue 属性对应的名称/值对的集合。

响应

如果成功，此方法将在响应正文中返回 201 Created 响应代码和 groupSetting 对象。

示例

示例 1：为租户中所有Microsoft 365 个组创建新设置

请求

只有名为 Group.Unified 的 groupSettingTemplates 对象可以应用于租户级别的所有Microsoft 365 个组。

POST https://graph.microsoft.com/v1.0/groupSettings
Content-type: application/json

{
    "templateId": "62375ab9-6b52-47ed-826b-58e47e0e304b",
    "values": [
        {
            "name": "GuestUsageGuidelinesUrl",
            "value": "https://privacy.contoso.com/privacystatement"
        },
        {
            "name": "EnableMSStandardBlockedWords",
            "value": "true"
        },
        {
            "name": "EnableMIPLabels",
            "value": "true"
        },
        {
            "name": "PrefixSuffixNamingRequirement",
            "value": "[Contoso-][GroupName]"
        }
    ]
}

响应

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groupSettings/$entity",
    "id": "844d252c-4de2-43eb-a784-96df77231aae",
    "displayName": null,
    "templateId": "62375ab9-6b52-47ed-826b-58e47e0e304b",
    "values": [
        {
            "name": "GuestUsageGuidelinesUrl",
            "value": "https://privacy.contoso.com/privacystatement"
        },
        {
            "name": "EnableMSStandardBlockedWords",
            "value": "true"
        },
        {
            "name": "EnableMIPLabels",
            "value": "true"
        },
        {
            "name": "PrefixSuffixNamingRequirement",
            "value": "[Contoso-][GroupName]"
        }
    ]
}

displayName 属性和其他名称/值对将填充与 templateId 匹配的 groupSettingTemplates 对象的默认值。

示例 2：创建设置以阻止特定Microsoft 365 组的来宾

请求

只有名为 Group.Unified.Guest 的 groupSettingTemplates 对象可以应用于 365 个组的特定Microsoft。

POST https://graph.microsoft.com/v1.0/groups/055a5d18-a3a9-4338-b9c5-de92559b7ebf/settings
Content-type: application/json

{
    "templateId": "08d542b9-071f-4e16-94b0-74abb372e3d9",
    "values": [
        {
            "name": "AllowToAddGuests",
            "value": "false"
        }
    ]
}

在请求正文中，提供 groupSetting 对象的 JSON 表示形式。

响应

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groupSettings/$entity",
    "id": "a06fa228-3042-4662-bd09-33e298da1afe",
    "displayName": null,
    "templateId": "08d542b9-071f-4e16-94b0-74abb372e3d9",
    "values": [
        {
            "name": "AllowToAddGuests",
            "value": "false"
        }
    ]
}

示例 3：为租户中的所有云安全组启用敏感度标签

只有名为 Group.Security的 groupSettingTemplates 对象可以应用于租户级别的所有云安全组。

注意

此功能需要Microsoft Entra ID P1 许可证。

请求

POST https://graph.microsoft.com/v1.0/groupSettings
Content-type: application/json

{
    "templateId": "d209f6fa-3839-4d70-b83f-60b1c64d0e8f",
    "values": [
        {
            "name": "EnableMIPLabels",
            "value": "true"
        }
    ]
}

响应

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groupSettings/$entity",
    "id": "3e4a9b9d-1234-5678-abcd-1234567890ab",
    "displayName": null,
    "templateId": "d209f6fa-3839-4d70-b83f-60b1c64d0e8f",
    "values": [
        {
            "name": "EnableMIPLabels",
            "value": "true"
        }
    ]
}

示例 4：阻止特定云安全组的来宾

只有名为 Group.Security.Policies的 groupSettingTemplates 对象可以应用于特定的云安全组。

注意

此功能需要Microsoft Entra ID P1 许可证。

请求

POST https://graph.microsoft.com/v1.0/groups/{securityGroupId}/settings
Content-type: application/json

{
    "templateId": "7e0abea2-5c20-405f-9658-bfc9a523fd49",
    "values": [
        {
            "name": "AllowToAddGuests",
            "value": "false"
        }
    ]
}

响应

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groupSettings/$entity",
    "id": "fa6df613-abcd-1234-add2-1234567890ab",
    "displayName": null,
    "templateId": "7e0abea2-5c20-405f-9658-bfc9a523fd49",
    "values": [
        {
            "name": "AllowToAddGuests",
            "value": "false"
        }
    ]
}
  • Last updated on