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

Статья
08/11/2023

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

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Обновление свойств объекта группы .

Этот 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	Логический	Указывает, является ли группа группой безопасности, включая группы Microsoft 365.
visibility	String	Определяет видимость группы Microsoft 365. Возможные значения: Private (частная), Public (общедоступная) или пустое значение (оно обрабатывается как Public).
writebackConfiguration	groupWritebackConfiguration	Указывает, настроена ли группа для записи свойств объекта группы обратно в локальную службу Active Directory. Эти свойства используются при настройке обратной записи групп в клиенте синхронизации Microsoft Entra Connect.

Важно!

Чтобы обновить следующие свойства, необходимо указать их в собственном запросе 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.

Примеры

Пример 1. Обновление отображаемого имени и описания группы

Запрос

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

PATCH https://graph.microsoft.com/beta/groups/{id}
Content-type: application/json

{
   "description":"Contoso Life v2.0",
   "displayName":"Contoso Life Renewed"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new Group
{
	Description = "Contoso Life v2.0",
	DisplayName = "Contoso Life Renewed",
};

// 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 для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

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


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta groups patch --group-id {group-id} --body '{\
   "description":"Contoso Life v2.0",\
   "displayName":"Contoso Life Renewed"\
}\
'

Важно!

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



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGroup()
description := "Contoso Life v2.0"
requestBody.SetDescription(&description) 
displayName := "Contoso Life Renewed"
requestBody.SetDisplayName(&displayName) 

groups, err := graphClient.Groups().ByGroupId("group-id").Patch(context.Background(), requestBody, nil)

Важно!

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


// 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("Contoso Life v2.0");
group.setDisplayName("Contoso Life Renewed");
Group result = graphClient.groups().byGroupId("{group-id}").patch(group);

Важно!

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


const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
   description: 'Contoso Life v2.0',
   displayName: 'Contoso Life Renewed'
};

await client.api('/groups/{id}')
	.version('beta')
	.update(group);

Важно!

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


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Group;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Group();
$requestBody->setDescription('Contoso Life v2.0');
$requestBody->setDisplayName('Contoso Life Renewed');

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

Важно!

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


Import-Module Microsoft.Graph.Beta.Groups

$params = @{
	description = "Contoso Life v2.0"
	displayName = "Contoso Life Renewed"
}

Update-MgBetaGroup -GroupId $groupId -BodyParameter $params

Важно!

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


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

graph_client = GraphServiceClient(credentials, scopes)

request_body = Group(
	description = "Contoso Life v2.0",
	display_name = "Contoso Life Renewed",
)

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

Важно!

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

Отклик

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

HTTP/1.1 204 No Content

Пример 2. Применение метки конфиденциальности к группе Microsoft 365

Запрос

Идентификатор метки, которую вы хотите применить к группе Microsoft 365, можно с помощью метки списка. Затем можно обновить свойство assignedLabels группы с идентификатором метки.

Примечание: Использование этого API для применения меток конфиденциальности к группам Microsoft 365 поддерживается только в сценариях делегированных разрешений.

PATCH https://graph.microsoft.com/beta/groups/{id}
Content-type: application/json

{
  "assignedLabels":
  [
    {
        "labelId" : "45cd0c48-c540-4358-ad79-a3658cdc5b88"
    }
  ]
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new Group
{
	AssignedLabels = new List<AssignedLabel>
	{
		new AssignedLabel
		{
			LabelId = "45cd0c48-c540-4358-ad79-a3658cdc5b88",
		},
	},
};

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


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta groups patch --group-id {group-id} --body '{\
  "assignedLabels":\
  [\
    {\
        "labelId" : "45cd0c48-c540-4358-ad79-a3658cdc5b88"\
    }\
  ]\
}\
'

Важно!

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



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGroup()


assignedLabel := graphmodels.NewAssignedLabel()
labelId := "45cd0c48-c540-4358-ad79-a3658cdc5b88"
assignedLabel.SetLabelId(&labelId) 

assignedLabels := []graphmodels.AssignedLabelable {
	assignedLabel,
}
requestBody.SetAssignedLabels(assignedLabels)

groups, err := graphClient.Groups().ByGroupId("group-id").Patch(context.Background(), requestBody, nil)

Важно!

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


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Group group = new Group();
LinkedList<AssignedLabel> assignedLabels = new LinkedList<AssignedLabel>();
AssignedLabel assignedLabel = new AssignedLabel();
assignedLabel.setLabelId("45cd0c48-c540-4358-ad79-a3658cdc5b88");
assignedLabels.add(assignedLabel);
group.setAssignedLabels(assignedLabels);
Group result = graphClient.groups().byGroupId("{group-id}").patch(group);

Важно!

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


const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
  assignedLabels: 
  [
    {
        labelId: '45cd0c48-c540-4358-ad79-a3658cdc5b88'
    }
  ]
};

await client.api('/groups/{id}')
	.version('beta')
	.update(group);

Важно!

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


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Group;
use Microsoft\Graph\Generated\Models\AssignedLabel;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Group();
$assignedLabelsAssignedLabel1 = new AssignedLabel();
$assignedLabelsAssignedLabel1->setLabelId('45cd0c48-c540-4358-ad79-a3658cdc5b88');
$assignedLabelsArray []= $assignedLabelsAssignedLabel1;
$requestBody->setAssignedLabels($assignedLabelsArray);


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

Важно!

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


Import-Module Microsoft.Graph.Beta.Groups

$params = @{
	assignedLabels = @(
		@{
			labelId = "45cd0c48-c540-4358-ad79-a3658cdc5b88"
		}
	)
}

Update-MgBetaGroup -GroupId $groupId -BodyParameter $params

Важно!

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


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

graph_client = GraphServiceClient(credentials, scopes)

request_body = Group(
	assigned_labels = [
		AssignedLabel(
			label_id = "45cd0c48-c540-4358-ad79-a3658cdc5b88",
		),
	],
)

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

Важно!

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

Отклик

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

HTTP/1.1 204 No Content

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

Разрешения

HTTP-запрос

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

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

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

Отклик

Примеры

Пример 1. Обновление отображаемого имени и описания группы

Запрос

Отклик

Пример 2. Применение метки конфиденциальности к группе Microsoft 365

Запрос

Отклик

Обратная связь

Обратная связь

Дополнительные ресурсы

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

Разрешения

HTTP-запрос

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

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

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

Отклик

Примеры

Пример 1. Обновление отображаемого имени и описания группы

Запрос

Отклик

Пример 2. Применение метки конфиденциальности к группе Microsoft 365

Запрос

Отклик

Связанные материалы

Обратная связь

Обратная связь

Дополнительные ресурсы