Обновление группы

Пространство имен: microsoft.graph

Обновление свойств объекта group.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	✅

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Group.ReadWrite.All	Directory.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Для приложений	Group.ReadWrite.All	Directory.ReadWrite.All

HTTP-запрос

PATCH /groups/{id}

Заголовки запросов

Имя	Тип	Описание
Authorization	string	Bearer {token}. Обязательно.

Текст запроса

Укажите в тексте запроса только значения обновляемых свойств. Предыдущие значения существующих свойств, не включенных в текст запроса, будут сохранены или вычислены повторно с учетом изменений, внесенных в значения других свойств.

В следующей таблице указаны свойства, которые можно обновить.

Свойство	Тип	Описание
allowExternalSenders	Логический	Значение по умолчанию: false. Указывает, могут ли пользователи за пределами организации отправлять сообщения в группу.
assignedLabels	Коллекция assignedLabel	Список пар меток конфиденциальности (идентификатор метки, имя метки), связанных с группой Microsoft 365.
autoSubscribeNewMembers	Логический	Значение по умолчанию: false. Указывает, будут ли новые участники группы автоматически подписаны на получение уведомлений по электронной почте. AutoSubscribeNewMembers не может быть true, если в группе установлено false для subscriptionEnabled.
description	String	Необязательное описание для группы.
displayName	String	Отображаемое имя для группы. Это свойство является обязательным при создании группы и ее невозможно очистить во время обновлений.
mailNickname	String	Почтовый псевдоним для группы, уникальный для групп Microsoft 365 в организации. Максимальная длина: 64 символа. Это свойство может содержать только символы из набора символов ASCII от 0 до 127, за исключением следующих: @ () \ [] " ; : . <> , SPACE.
preferredDataLocation	String	Предпочтительное расположение данных для группы Microsoft 365. Чтобы обновить это свойство, вызывающему пользователю необходимо назначить одну из следующих Microsoft Entra ролей: Глобальный администратор Администратор учетных записей пользователей Редактор каталогов Администратор Exchange Администратор SharePoint Дополнительные сведения об этом свойстве см. в статье OneDrive Online с поддержкой нескольких регионов.
securityEnabled	Логический	Указывает, является ли эта группа группой безопасности.
visibility	String	Определяет видимость группы Microsoft 365. Возможные значения: Private (частная), Public (общедоступная) или пустое значение (оно обрабатывается как Public).

Важно!

• Чтобы обновить следующие свойства, необходимо указать их в собственном запросе PATCH, не включив другие свойства, перечисленные в предыдущей таблице: allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribedByMail, unseenCount.
• Только подмножество API группы, относящееся к основному администрированию и управлению группами, поддерживает приложения и делегированные разрешения. Все остальные члены API группы, включая обновление autoSubscribeNewMembers, поддерживают только делегированные разрешения.
• Правила обновления групп безопасности, поддерживающих почту, в Microsoft Exchange Server могут быть сложными. Дополнительные сведения см. в статье Управление группами безопасности с поддержкой электронной почты в Exchange Server.
• Разрешения приложений не поддерживаются при обновлении assignedLabels.

Управление расширениями и связанными данными

Используйте этот API для управления каталогом, схемой и открытыми расширениями и их данными для пользователей следующим образом:

• Добавляйте, обновляйте и сохраняйте данные в расширениях для существующей группы.
• Для расширений каталогов и схем удалите все сохраненные данные, задав для свойства пользовательского расширения значение null. Для открытых расширений используйте API удаления открытых расширений.

Отклик

В случае успеха этот метод возвращает код отклика 204 No Content, за исключением кода отклика 200 OK при обновлении следующих свойств: allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribedByMail, unseenCount.

Пример

В примере ниже показано, как обновить группу.

Запрос

Ниже показан пример запроса.

HTTP

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"
}

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",
	DisplayName = "Library Assist",
	GroupTypes = new List<string>
	{
		"Unified",
	},
	MailEnabled = true,
	MailNickname = "library-help",
};

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

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups patch --group-id {group-id} --body '{\
  "description": "Library Assist",\
  "displayName": "Library Assist",\
  "groupTypes": [\
    "Unified"\
  ],\
  "mailEnabled": true,\
  "mailNickname": "library-help"\
}\
'

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGroup()
description := "Library Assist"
requestBody.SetDescription(&description) 
displayName := "Library Assist"
requestBody.SetDisplayName(&displayName) 
groupTypes := []string {
	"Unified",
}
requestBody.SetGroupTypes(groupTypes)
mailEnabled := true
requestBody.SetMailEnabled(&mailEnabled) 
mailNickname := "library-help"
requestBody.SetMailNickname(&mailNickname) 

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");
group.setDisplayName("Library Assist");
LinkedList<String> groupTypes = new LinkedList<String>();
groupTypes.add("Unified");
group.setGroupTypes(groupTypes);
group.setMailEnabled(true);
group.setMailNickname("library-help");
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',
  displayName: 'Library Assist',
  groupTypes: [
    'Unified'
  ],
  mailEnabled: true,
  mailNickname: 'library-help'
};

await client.api('/groups/{id}')
	.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');
$requestBody->setDisplayName('Library Assist');
$requestBody->setGroupTypes(['Unified', 	]);
$requestBody->setMailEnabled(true);
$requestBody->setMailNickname('library-help');

$result = $graphServiceClient->groups()->byGroupId('group-id')->patch($requestBody)->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Import-Module Microsoft.Graph.Groups

$params = @{
	description = "Library Assist"
	displayName = "Library Assist"
	groupTypes = @(
	"Unified"
)
mailEnabled = $true
mailNickname = "library-help"
}

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",
	display_name = "Library Assist",
	group_types = [
		"Unified",
	],
	mail_enabled = True,
	mail_nickname = "library-help",
)

result = await graph_client.groups.by_group_id('group-id').patch(request_body)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже приводится пример отклика.

HTTP/1.1 204 No Content