Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Пространство имен: microsoft.graph
Обновление свойств объекта группы .
Примечание.
При добавлении members@odata.bind участников с помощью PATCHэтого запроса могут возникать задержки репликации для недавно созданных групп. Полная репликация объекта группы между Microsoft Entra ID репликами каталогов может занять некоторое время. В этом окне запросы на добавление участников в группу могут возвращать 400 Bad Request сообщение об ошибке: "Объект исходного ресурса или один из объектов, на которые ссылается ссылка, не существует".
Чтобы устранить это поведение, выполните следующие действия:
- Повторите попытку после краткой задержки — подождите несколько секунд и повторите запрос. Задержка обычно кратковременна.
Дополнительные сведения см. в разделе Проектирование итоговой согласованности для Microsoft Entra.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
|---|---|---|
| Делегированные (рабочая или учебная учетная запись) | Group-NestingSupport.ReadWrite.All | Directory.ReadWrite.All, Group.ManageProtection.All, Group.ReadWrite.All |
| Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
| Приложение | Group-NestingSupport.ReadWrite.All | Directory.ReadWrite.All, Group.ManageProtection.All, Group.ReadWrite.All |
HTTP-запрос
PATCH /groups/{id}
Заголовки запросов
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Текст запроса
Укажите в тексте запроса только значения обновляемых свойств. Предыдущие значения существующих свойств, не включенных в текст запроса, будут сохранены или вычислены повторно с учетом изменений, внесенных в значения других свойств.
В следующей таблице указаны свойства, которые можно обновить.
| Свойство | Тип | Описание |
|---|---|---|
| allowExternalSenders | Логический | Значение по умолчанию: false. Указывает, могут ли пользователи за пределами организации отправлять сообщения в группу. |
| assignedLabels | Коллекция assignedLabel | Список пар меток конфиденциальности (идентификатор метки, имя метки), связанных с группой Microsoft 365. Это свойство можно обновить только в делегированных сценариях, когда вызывающей стороне требуется разрешение Microsoft Graph и поддерживаемая роль администратора. |
| 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 ролей:
Дополнительные сведения об этом свойстве см. в статье OneDrive Online с поддержкой нескольких регионов. |
| securityEnabled | Логический | Указывает, является ли эта группа группой безопасности. |
| uniqueName | Строка | Уникальный идентификатор, который можно назначить группе и использовать в качестве альтернативного ключа. Может обновляться только в том случае, если null и является неизменяемым после установки. |
| visibility | String | Определяет видимость группы Microsoft 365. Возможные значения: Private (частная), Public (общедоступная) или пустое значение (оно обрабатывается как Public). |
Важно!
- Чтобы обновить эти свойства (allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribedByMail, unseenCount), необходимо:
- Укажите их в собственном запросе PATCH без включения других свойств из предыдущей таблицы
- Разрешение Group.ReadWrite.All (Каталог.ReadWrite.All не поддерживается для этих свойств)
- Только подмножество API группы, относящееся к основному администрированию и управлению группами, поддерживает приложения и делегированные разрешения. Все остальные члены API группы, включая обновление autoSubscribeNewMembers, поддерживают только делегированные разрешения.
- Правила обновления групп безопасности, поддерживающих почту, в Microsoft Exchange Server могут быть сложными. Дополнительные сведения см. в статье Управление группами безопасности с поддержкой электронной почты в Exchange Server.
- Разрешения приложений не поддерживаются при обновлении assignedLabels.
Управление расширениями и связанными данными
Используйте этот API для управления каталогом, схемой и открытыми расширениями и их данными для пользователей следующим образом:
- Добавляйте, обновляйте и сохраняйте данные в расширениях для существующей группы.
- Для расширений каталогов и схем удалите все сохраненные данные, задав для свойства пользовательского расширения значение
null. Для открытых расширений используйте API удаления открытых расширений.
Отклик
В случае успеха этот метод возвращает код отклика 204 No Content, за исключением кода отклика 200 OK при обновлении следующих свойств: allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribedByMail, unseenCount.
Ошибки
| Код состояния | Код ошибки | Сообщение об ошибке | Описание |
|---|---|---|---|
400 Bad Request |
Request_BadRequest |
"Объект исходного ресурса или один из объектов, на которые ссылается ссылка, не существуют". | Группа была создана недавно и не полностью реплицировалась во всех репликах каталогов. Эта ошибка связана с операциями записи ссылок (добавление членов через members@odata.bind). Повторите запрос после краткой задержки. |
Пример
В примере ниже показано, как обновить группу.
Запрос
Ниже показан пример запроса.
PATCH https://graph.microsoft.com/v1.0/groups/0d09007d-45b2-458c-b180-880dde3a302e
Content-type: application/json
{
"description": "Library Assist - ADC",
"displayName": "Library Assist - ADC",
"mailNickname": "library-help-adc"
}
Отклик
Ниже приводится пример отклика.
HTTP/1.1 204 No Content