组资源类型group resource type

命名空间:microsoft.graphNamespace: microsoft.graph

表示 Azure Active Directory (Azure AD) 组,可以是 Microsoft 365 组或安全组。Represents an Azure Active Directory (Azure AD) group, which can be a Microsoft 365 group, or a security group.

继承自 directoryObjectInherits from directoryObject.

出于性能原因,默认情况下 creategetlist 操作仅返回更常用属性的子集。For performance reasons, the create, get, and list operations return only a subset of more commonly used properties by default. 这些_默认_属性将记录在属性部分中。These default properties are noted in the Properties section. 若要获取非默认返回的任一属性,请在 $select OData 查询选项中指定这些属性。To get any of the properties that are not returned by default, specify them in a $select OData query option.

该资源支持:This resource supports:

方法Methods

方法Method 返回类型Return Type 说明Description
组管理Group management
Create groupCreate group group 新建组。Create a new group. 它可以是 Microsoft 365 组、动态组或安全组。It can be a Microsoft 365 group, dynamic group, or security group.
Get groupGet group group 读取 group 对象的属性。Read properties of a group object.
列出组List groups 集合group collection 列出 group 对象及其属性。List group objects and their properties.
更新组Update group None 更新 group 对象的属性。Update the properties of a group object.
删除组Delete group None 删除组对象。Delete group object.
增量delta 组集合group collection 获取组的增量更改。Get incremental changes for groups.
添加成员Add member None 通过发布到 members 导航属性将用户或组添加到此组(仅支持安全组和启用邮件的安全组新)。Add a user or group to this group by posting to the members navigation property (supported for security groups and mail-enabled security groups only).
添加所有者Add owner None 通过发布到 owners 导航属性,为此组添加新所有者(仅支持为安全组和启用邮件的安全组添加)。Add a new owner for the group by posting to the owners navigation property (supported for security groups and mail-enabled security groups only).
Create settingCreate setting groupSettinggroupSetting 基于 groupSettingTemplate 创建设置对象。POST 请求必须为模板中定义的所有设置提供 settingValues。只有组特定模板可用于此操作。Create a setting object based on a groupSettingTemplate. The POST request must provide settingValues for all the settings defined in the template. Only groups specific templates may be used for this operation.
删除设置Delete setting None 删除 setting 对象。Delete a setting object.
Get endpointGet endpoint endpointendpoint 读取 endpoint 对象的属性和关系。Read properties and relationships of an endpoint object.
Get settingGet setting groupSettinggroupSetting 读取特定设置对象的属性。Read properties of a specific setting object.
List endpointsList endpoints endpoint 集合endpoint collection 获取 endpoint 对象集合。Get an endpoint object collection.
列出 groupLifecyclePolicyList groupLifecyclePolicies groupLifecyclePolicy 集合groupLifecyclePolicy collection 列出组生命周期策略。List group lifecycle policies.
List membersList members directoryObject 集合directoryObject collection members 导航属性中获取属于此组的直接成员的用户和组。Get the users and groups that are direct members of this group from the members navigation property.
List ownersList owners directoryObject 集合directoryObject collection owners 导航属性中获取此组的所有者。Get the owners of the group from the owners navigation property.
List settingsList settings groupSetting 集合groupSetting collection 列出所有设置对象的属性。List properties of all setting objects.
List transitive membersList transitive members directoryObject 集合directoryObject collection 获取属于此组成员(包括嵌套成员)的用户、组和设备。Get the users, groups and devices that are members, including nested members of this group.
List transitive memberOfList transitive memberOf directoryObject 集合directoryObject collection 列出此组所属的组。List the groups that this group is a member of. 此操作是可传递的,并包括此组以嵌套方式所属的组。This operation is transitive and includes the groups that this group is a nested member of.
删除成员Remove member None 通过 members 导航属性删除 Microsoft 365 组、安全组,或这启用邮的安全组中的成员。您可以删除用户或其他组。Remove a member from a Microsoft 365 group, a security group or a mail-enabled security group through the members navigation property. You can remove users or other groups.
删除所有者Remove owner None 通过 owners 导航属性,删除 Microsoft 365 组、安全组或启用邮件安全组的所有者。Remove an owner from a Microsoft 365 group, a security group or a mail-enabled security group through the owners navigation property.
Update settingUpdate setting groupSettinggroupSetting 更新 setting 对象。Update a setting object.
assignLicenseassignLicense group 为组添加或删除订阅。Add or remove subscriptions for the group. 还可以启用和禁用与订阅相关的特定计划。You can also enable and disable specific plans associated with a subscription.
checkMemberGroupscheckMemberGroups String collectionString collection 在一列组中检查此组的成员身份。此函数是可传递的。Check this group for membership in a list of groups. The function is transitive.
checkMemberObjectscheckMemberObjects String 集合String collection 检查组、目录角色或管理单元对象列表中的成员身份。Check for membership in a list of group, directory role, or administrative unit objects. 此函数可传递。The function is transitive.
getMemberGroupsgetMemberGroups String collectionString collection 返回此组是其成员的所有组。此函数是可传递的。Return all the groups that the group is a member of. The function is transitive.
getMemberObjectsgetMemberObjects String collectionString collection 返回此组所属的全部组。此函数可传递。Return all of the groups that the group is a member of. The function is transitive.
续订renew 布尔值Boolean 续订组以更新到期时间。Renews a group's expiration. 续订后,组的有效期就会延长策略中定义的天数。When a group is renewed, the group expiration is extended by the number of days defined in the policy.
validatePropertiesvalidateProperties JSONJSON 验证 Microsoft 365 组的显示名称或邮件昵称是否符合命名策略。Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies.
应用角色分配App role assignments
列出 appRoleAssignmentsList appRoleAssignments appRoleAssignment 集合appRoleAssignment collection 获取已分配到此组的应用和应用角色。Get the apps and app roles which this group has been assigned.
添加 appRoleAssignmentAdd appRoleAssignment appRoleAssignmentappRoleAssignment 向此组分配一个应用角色。Assign an app role to this group.
删除 appRoleAssignmentRemove appRoleAssignment 无。None. 从此组中删除一个应用角色分配。Remove an app role assignment from this group.
CalendarCalendar
创建事件Create event eventevent 通过发布到事件集合新建事件。Create a new event by posting to the events collection.
获取事件Get event eventevent 读取 event 对象的属性。Read properties of an event object.
列出事件List events event 集合event collection 获取 event 对象集合。Get an event object collection.
更新事件Update event None 更新 event 对象的属性。Update the properties of an event object.
删除事件Delete event None 删除 event 对象。Delete event object.
列出 calendarViewList calendarView event 集合event collection 获取指定时间范围内的事件集合。Get a collection of events in a specified time window.
对话Conversations
创建对话Create conversation conversationconversation 通过发布到对话集合新建对话。Create a new conversation by posting to the conversations collection.
获取对话Get conversation conversationconversation 读取 conversation 对象的属性。Read properties of a conversation object.
列出对话List conversations conversation 集合conversation collection 获取 conversation 对象集合。Get a conversation object collection.
删除对话Delete conversation None 删除 conversation 对象。Delete conversation object.
创建线程Create thread conversationThreadconversationThread 创建新的对话线程。Create a new conversation thread.
获取线程Get thread conversationThreadconversationThread 读取 thread 对象的属性。Read properties of a thread object.
列出线程List threads conversationThread 集合conversationThread collection 获取组的所有线程。Get all the threads of a group.
更新线程Update thread None 更新 thread 对象的属性。Update properties of a thread object.
删除线程Delete thread None 删除 thread 对象。Delete thread object.
列出 acceptedSendersList acceptedSenders directoryObject 集合directoryObject collection 获取此组的“接受的发件人”列表中的用户或组列表。Get a list of users or groups that are in the accepted-senders list for this group.
添加 acceptedSenderAdd acceptedSender directoryObjectdirectoryObject 将用户或组添加到 acceptSenders 集合。Add a User or Group to the acceptSenders collection.
删除 acceptedSenderRemove acceptedSender directoryObjectdirectoryObject 从 acceptedSenders 集合中删除用户或组。Remove a User or Group from the acceptedSenders collection.
List rejectedSendersList rejectedSenders directoryObject collectiondirectoryObject collection 获取此组的“遭拒的发件人”列表中的用户或组列表。Get a list of users or groups that are in the rejected-senders list for this group.
Add rejectedSenderAdd rejectedSender directoryObjectdirectoryObject 将新用户或组添加到 rejectedSenders 集合中。Add a new User or Group to the rejectedSenders collection.
Remove rejectedSenderRemove rejectedSender directoryObjectdirectoryObject 从 rejectedSenders 集合中删除新用户或组。Remove new User or Group from the rejectedSenders collection.
Create settingCreate setting groupSettinggroupSetting 基于 groupSettingTemplate 创建设置对象。POST 请求必须为模板中定义的所有设置提供 settingValues。只有组特定模板可用于此操作。Create a setting object based on a groupSettingTemplate. The POST request must provide settingValues for all the settings defined in the template. Only groups specific templates may be used for this operation.
获取设置Get setting groupSettinggroupSetting 读取特定设置对象的属性。Read properties of a specific setting object.
列出设置List settings groupSetting 集合groupSetting collection 列出所有设置对象的属性。List properties of all setting objects.
更新设置Update setting None 更新 setting 对象。Update a setting object.
删除设置Delete setting None 删除 setting 对象。Delete a setting object.
获取设置模板Get setting template None 读取设置模板的属性。Read properties of a setting template.
列出设置模板List setting template None 列出所有设置模板的属性。List properties of all setting templates.
开放扩展Open extensions
创建开放扩展Create open extension openTypeExtensionopenTypeExtension 创建开放扩展,并将自定义属性添加到新资源或现有资源。Create an open extension and add custom properties to a new or existing resource.
获取开放扩展Get open extension openTypeExtension 集合openTypeExtension collection 获取扩展名称标识的开放扩展。Get an open extension identified by the extension name.
架构扩展Schema extensions
添加架构扩展值Add schema extension values None 创建架构扩展定义,然后使用它向资源添加自定义键入数据。Create a schema extension definition and then use it to add custom typed data to a resource.
其他组资源Other group resources
List photosList photos profilePhoto 集合profilePhoto collection 获取组的个人资料照片集合。Get a collection of profile photos for the group.
List plannerPlansList plannerPlans plannerPlan 集合plannerPlan collection 获取组拥有的 Planner 计划。Get Planner plans owned by the group.
用户设置User settings
addFavoriteaddFavorite None 将组添加到登录用户的收藏夹组列表中。Add the group to the list of the signed-in user's favorite groups. 仅支持 Microsoft 365 组。Supported for only Microsoft 365 groups.
removeFavoriteremoveFavorite None 从登录用户收藏夹组列表中删除组。Remove the group from the list of the signed-in user's favorite groups. 仅支持 Microsoft 365 组。Supported for only Microsoft 365 groups.
List memberOfList memberOf directoryObject 集合directoryObject collection 通过 memberOf 导航属性,获取此用户为其直接成员的组和管理单元。Get the groups and administrative units that this user is a direct member of, from the memberOf navigation property.
subscribeByMailsubscribeByMail None 将 isSubscribedByMail 属性设置为 trueSet the isSubscribedByMail property to true. 使登录用户可以接收电子邮件对话。Enabling the signed-in user to receive email conversations. 仅支持 Microsoft 365 组。Supported for only Microsoft 365 groups.
unsubscribeByMailunsubscribeByMail None 将 isSubscribedByMail 属性设置为 falseSet the isSubscribedByMail property to false. 使登录用户无法接收电子邮件对话。Disabling the signed-in user from receive email conversations. 仅支持 Microsoft 365 组。Supported for only Microsoft 365 groups.
resetUnseenCountresetUnseenCount None 将登录用户自上次访问后未查看的所有帖子的 unseenCount 重置为 0。Reset the unseenCount to 0 of all the posts that the signed-in user has not seen since their last visit. 仅支持 Microsoft 365 组。Supported for only Microsoft 365 groups.

属性Properties

属性Property 类型Type 说明Description
allowExternalSendersallowExternalSenders BooleanBoolean 指明组织外部人员能否向群组发送邮件。Indicates if people external to the organization can send messages to the group. 默认值为 falseDefault value is false.

仅在 $select 上返回。Returned only on $select.
assignedLabelsassignedLabels assignedLabel 集合assignedLabel collection 与 Microsoft 365 组关联的灵敏度标签对(标签 ID、标签名称)列表。The list of sensitivity label pairs (label ID, label name) associated with an Microsoft 365 group.

仅在 $select 上返回。Returned only on $select. 只读。Read-only.
assignedLicensesassignedLicenses assignedLicense 集合assignedLicense collection 分配给该组的许可证。The licenses that are assigned to the group.

仅在 $select 上返回。Returned only on $select. 只读。Read-only.
autoSubscribeNewMembersautoSubscribeNewMembers 布尔值Boolean 指示添加到组中的新成员是否将自动订阅接收电子邮件通知。Indicates if new members added to the group will be auto-subscribed to receive email notifications. 可以在 PATCH 请求中设置组的这个属性;不要在创建该组的初始 POST 请求中设置它。You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group. 默认值为 falseDefault value is false.

仅在 $select 上返回。Returned only on $select.
classificationclassification 字符串String 描述该组的分类(如低、中或高业务影响)。通过根据模板定义创建 ClassificationList 设置值来定义此属性的有效值。Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.

默认情况下返回。Returned by default.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset 组的创建时间戳。Timestamp of when the group was created. 值无法修改,并在组创建时自动填充。The value cannot be modified and is automatically populated when the group is created. 时间戳类型表示采用 ISO 8601 格式的日期和时间信息,始终采用 UTC 时区。The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. 例如,2014 年 1 月 1 日午夜 UTC 如下所示:'2014-01-01T00:00:00Z'For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.

默认情况下返回。Returned by default. 只读。Read-only.
deletedDateTimedeletedDateTime DateTimeOffsetDateTimeOffset 对于某些 Azure Active Directory 对象(用户、组、应用程序),如果该对象被删除,先逻辑删除,随后该属性随着对象删除的日期和时间更新。For some Azure Active Directory objects (user, group, application), if the object is deleted, it is first logically deleted, and this property is updated with the date and time when the object was deleted. 否则此属性为空。Otherwise this property is null. 如果对象已还原,则此属性会更新为空。If the object is restored, this property is updated to null.
说明description StringString 可选的组说明。An optional description for the group.

默认情况下返回。Returned by default.
displayNamedisplayName StringString 组的显示名称。The display name for the group. 此属性是在创建组时所必需的,并且在更新过程中不能清除。This property is required when a group is created and cannot be cleared during updates.

默认情况下返回。Returned by default. 支持 $filter 和 $orderby。Supports $filter and $orderby.
expirationDateTimeexpirationDateTime DateTimeOffsetDateTimeOffset 设置的组的过期时间戳。Timestamp of when the group is set to expire. 值无法修改,并在组创建时自动填充。The value cannot be modified and is automatically populated when the group is created. 时间戳类型表示采用 ISO 8601 格式的日期和时间信息,始终采用 UTC 时区。The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. 例如,2014 年 1 月 1 日午夜 UTC 如下所示:'2014-01-01T00:00:00Z'For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.

默认情况下返回。Returned by default. 只读。Read-only.
groupTypesgroupTypes String collectionString collection 指定组类型及其成员身份。Specifies the group type and its membership.

如果集合中包含 Unified,则该组是一个 Microsoft 365 组,否则该组是一个安全组。If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. 有关详细信息,请参阅组概述For details, see groups overview.

如果该集合包含 DynamicMembership,则该组具有动态成员身份;否则,成员身份是静态的。If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static.

默认情况下返回。Returned by default. 支持 $filter。Supports $filter.
hasMembersWithLicenseErrorshasMembersWithLicenseErrors BooleanBoolean 指示此组中是否有该基于组的许可证分配中存在许可证错误的成员。Indicates whether there are members in this group that have license errors from its group-based license assignment.

GET 操作从未返回此属性。This property is never returned on a GET operation. 可将它用作 $filter 参数,获取具有许可证错误的成员的组(也就是说,此属性的筛选器为 true)。You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). 请参阅示例See an example.
hideFromAddressListshideFromAddressLists BooleanBoolean 如果该组未显示在 Outlook UI 的某些部分中(“通讯簿”中、用于选择邮件收件人的地址列表中以及用于搜索组的“浏览组”中),则为 true;否则为 false。True if the group is not displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. 默认值为 falseDefault value is false.

仅在 $select 上返回。Returned only on $select.
hideFromOutlookClientshideFromOutlookClients BooleanBoolean 如果该组未显示在 Outlook 客户端(如 Outlook for Windows 和 Outlook 网页版)中,则为 true;否则为 false。True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. 默认值为 falseDefault value is false.

仅在 $select 上返回。Returned only on $select.
idid StringString 组的唯一标识符。The unique identifier for the group.

默认情况下返回。Returned by default. 继承自 directoryObjectInherited from directoryObject. 键。Key. 不可为 null。Not nullable. 只读。Read-only.
isSubscribedByMailisSubscribedByMail BooleanBoolean 指示登录用户是否订阅接收电子邮件对话。Indicates whether the signed-in user is subscribed to receive email conversations. 默认值为 TrueDefault value is true.

仅在 $select 上返回。Returned only on $select.
licenseProcessingStatelicenseProcessingState StringString 指示对所有组成员的组许可证分配的状态。Indicates status of the group license assignment to all members of the group. 默认值为 falseDefault value is false. 只读。Read-only. 可能的值是:QueuedForProcessingProcessingInProgressProcessingCompletePossible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.

仅在 $select 上返回。Returned only on $select. 只读。Read-only.
mailmail StringString 组的 SMTP 地址,例如,“serviceadmins@contoso.onmicrosoft.com”。The SMTP address for the group, for example, "serviceadmins@contoso.onmicrosoft.com".

默认情况下返回。Returned by default. 只读。Read-only. 支持 $filter。Supports $filter.
mailEnabledmailEnabled 布尔Boolean 指定是否为启用邮件的组。Specifies whether the group is mail-enabled.

默认返回。Returned by default.
membershipRulemembershipRule StringString 组为动态组时(groupTypes 包含 DynamicMembership),用于确定该组成员的规则。The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). 有关成员身份规则语法的详细信息,请参阅成员身份规则语法For more information about the syntax of the membership rule, see Membership Rules syntax.

默认情况下返回。Returned by default.
membershipRuleProcessingStatemembershipRuleProcessingState StringString 指示动态成员身份处理正在进行中,还是已暂停。Indicates whether the dynamic membership processing is on or paused. 可能的值为:“正在进行”或“已暂停”。Possible values are "On" or "Paused".

默认返回。Returned by default.
onPremisesSamAccountNameonPremisesSamAccountName StringString 包含从本地目录同步的本地 SAM 帐户名Contains the on-premises SAM account name synchronized from the on-premises directory. 仅当客户正在通过 Azure AD Connect 将其本地目录同步到 Azure Active Directory 时,才会填充该属性。The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect.

默认情况下返回。Returned by default. 只读。Read-only.
onPremisesSecurityIdentifieronPremisesSecurityIdentifier StringString 包含从本地同步到云的组的本地安全标识符 (SID)。Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud.

默认情况下返回。Returned by default. 只读。Read-only.
onPremisesSyncEnabledonPremisesSyncEnabled 布尔Boolean 如果此组从本地目录同步,则为 true;如果此组最初从本地目录同步,但以后不再同步,则为 false;如果此对象从未从本地目录同步,则为 null(默认值)。true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default).

默认情况下返回。Returned by default. 只读。Read-only. 支持 $filter。Supports $filter.
preferredDataLocationpreferredDataLocation StringString 组的首选数据位置。The preferred data location for the group. 有关详细信息,请参阅 OneDrive Online 多地理位置For more information, see OneDrive Online Multi-Geo.

默认情况下返回。Returned by default.
preferredLanguagepreferredLanguage 字符串String Microsoft 365 组的首选语言。The preferred language for an Microsoft 365 group. 应遵循 ISO 639-1 代码;例如“en-US”。Should follow ISO 639-1 Code; for example "en-US".

默认情况下返回。Returned by default.
proxyAddressesproxyAddresses String 集合String collection 指向同一组邮箱的组的电子邮件地址。Email addresses for the group that direct to the same group mailbox. 例如:["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]For example: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]. 需要 any 运算符筛选多值属性上的表达式。The any operator is required to filter expressions on multi-valued properties.

默认情况下返回。Returned by default. 只读。Read-only. 不可为 null。Not nullable. 支持 $filter。Supports $filter.
renewedDateTimerenewedDateTime DateTimeOffsetDateTimeOffset 组的上次续订时间戳。Timestamp of when the group was last renewed. 值不能直接修改,只能通过续订服务操作进行更新。This cannot be modified directly and is only updated via the renew service action. 时间戳类型表示采用 ISO 8601 格式的日期和时间信息,始终采用 UTC 时区。The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. 例如,2014 年 1 月 1 日午夜 UTC 如下所示:'2014-01-01T00:00:00Z'For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.

默认情况下返回。Returned by default. 只读。Read-only.
resourceBehaviorOptionsresourceBehaviorOptions 字符串集合String collection 指定在创建期间可为 Microsoft 365 组设置的组行为。Specifies the group behaviors that can be set for a Microsoft 365 group during creation. 可设置为只为创建的一部分(POST)。This can be set only as part of creation (POST). 可取值为:AllowOnlyMembersToPostHideGroupInOutlookSubscribeNewGroupMembersWelcomeEmailDisabledPossible values are AllowOnlyMembersToPost, HideGroupInOutlook, SubscribeNewGroupMembers, WelcomeEmailDisabled. 有关详细信息,请参阅 设置 Microsoft 365 组行为和预配选项 For more information, see Set Microsoft 365 group behaviors and provisioning options.
resourceProvisioningOptionsresourceProvisioningOptions 字符串集合String collection 指定预配为创建 Microsoft 365 组的一部分,但通常不是创建默认组的组资源。Specifies the group resources that are provisioned as part of Microsoft 365 group creation, that are not normally part of default group creation. 可能值为 TeamPossible value is Team. 有关详细信息,请参阅 设置 Microsoft 365 组行为和预配选项 For more information, see Set Microsoft 365 group behaviors and provisioning options.
securityEnabledsecurityEnabled 布尔Boolean 指定是否为安全组。Specifies whether the group is a security group.

默认情况下返回。Returned by default. 支持 $filter。Supports $filter.
securityIdentifiersecurityIdentifier 字符串String 组的安全标识符,用于 Windows 方案。Security identifier of the group, used in Windows scenarios.

默认情况下返回。Returned by default.
themetheme 字符串String 指定 Microsoft 365 组的颜色主题。Specifies an Microsoft 365 group's color theme. 可能的值为:TealPurpleGreenBluePinkOrangeRedPossible values are Teal, Purple, Green, Blue, Pink, Orange or Red.

默认情况下返回。Returned by default.
unseenCountunseenCount Int32Int32 自登录用户上次访问该组以来收到新帖子的对话计数。Count of conversations that have received new posts since the signed-in user last visited the group.

仅在 $select 上返回。Returned only on $select.
visibilityvisibility 字符串String 指定 Microsoft 365 组的可见性。Specifies the visibility of a Microsoft 365 group. 可能的值为:PrivatePublicHiddenmembership;空白值视为公共值。Possible values are: Private, Public, or Hiddenmembership; blank values are treated as public. 请参阅组可见性选项以了解详细信息。See group visibility options to learn more.
只有在创建组时才能设置可见性;不能对其进行编辑。Visibility can be set only when a group is created; it is not editable.
只有统一组才支持可见性;安全组不支持可见性。Visibility is supported only for unified groups; it is not supported for security groups.

默认情况下返回。Returned by default.

组可见性选项Group visibility options

每个 visibility 属性值的含义如下:Here's what each visibility property value means:

Value 说明Description
公共Public 任何人均可在不需要所有者许可的情况下加入组。Anyone can join the group without needing owner permission.
任何人均可查看组的内容。Anyone can view the contents of the group.
私人Private 需要所有者许可才能加入组。Owner permission is needed to join the group.
非成员无法查看组的内容。Non-members cannot view the contents of the group.
HiddenmembershipHiddenmembership 需要所有者许可才能加入组。Owner permission is needed to join the group.
非成员无法查看组的内容。Non-members cannot view the contents of the group.
非成员无法查看组的成员。Non-members cannot see the members of the group.
管理员(全局、公司、用户和支持人员)可以查看组的成员资格。Administrators (global, company, user, and helpdesk) can view the membership of the group.
该组显示在全局通讯簿 (GAL) 中。The group appears in the global address book (GAL).

关系Relationships

关系Relationship 类型Type DescriptionDescription
acceptedSendersacceptedSenders directoryObject 集合directoryObject collection 允许在此组中创建帖子或日历事件的用户或组列表。如果此列表为非空,则仅允许此处列出的用户或组发布内容。The list of users or groups that are allowed to create post's or calendar events in this group. If this list is non-empty then only users or groups listed here are allowed to post.
日历calendar 日历calendar 组日历。只读。The group's calendar. Read-only.
calendarViewcalendarView 事件 集合event collection 日历的日历视图。只读。The calendar view for the calendar. Read-only.
conversationsconversations 对话 集合conversation collection 组对话。The group's conversations.
createdOnBehalfOfcreatedOnBehalfOf directoryObjectdirectoryObject 创建组的用户(或应用程序)。注意:如果用户是管理员,则不设置此关系。只读。The user (or application) that created the group. NOTE: This is not set if the user is an administrator. Read-only.
驱动器drive drivedrive 组的默认驱动器。The group's default drive. 只读。Read-only.
drivesdrives drive 集合drive collection 组的驱动器。The group's drives. 只读。Read-only.
活动events 事件 集合event collection 组的日历事件。The group's calendar events.
extensionsextensions 扩展集合extension collection 为组定义的开放扩展集合。只读。可为 NULL。The collection of open extensions defined for the group. Read-only. Nullable.
groupLifecyclePoliciesgroupLifecyclePolicies groupLifecyclePolicy 集合groupLifecyclePolicy collection 此组的生命周期策略集合。The collection of lifecycle policies for this group. 只读。Read-only. 可为 NULL。Nullable.
memberOfmemberOf directoryObject 集合directoryObject collection 此组所属的组。HTTP 方法:GET(支持所有组)只读。可为 Null。Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable.
membersmembers directoryObject 集合directoryObject collection 属于此组成员的用户和组。Users and groups that are members of this group. HTTP 方法:GET(支持所有组),POST(支持 Microsoft 365 组、安全组和启用邮件的安全组)、DELETE(支持 Microsoft 365 组和安全组),可为 Null。HTTP Methods: GET (supported for all groups), POST (supported for Microsoft 365 groups, security groups and mail-enabled security groups), DELETE (supported for Microsoft 365 groups and security groups) Nullable.
membersWithLicenseErrorsmembersWithLicenseErrors User 集合User collection 在该基于组的许可证分配中存在许可证错误的组成员列表。A list of group members with license errors from this group-based license assignment. 只读。Read-only.
onenoteonenote OnenoteOnenote 只读。Read-only.
ownersowners directoryObject 集合directoryObject collection 组的所有者。The owners of the group. 所有者是一组允许修改此对象的非管理员用户。The owners are a set of non-admin users who are allowed to modify this object. 仅限 100 个所有者。Limited to 100 owners. HTTP 方法:GET(支持所有组),POST(支持 Microsoft 365 组、安全组和启用邮件的安全组)、DELETE(支持 Microsoft 365 组和安全组)。HTTP Methods: GET (supported for all groups), POST (supported for Microsoft 365 groups, security groups and mail-enabled security groups), DELETE (supported for Microsoft 365 groups and security groups). 可为 NULL。Nullable.
photophoto profilePhotoprofilePhoto 组的个人资料照片The group's profile photo
photosphotos profilePhoto 集合profilePhoto collection 组拥有的个人资料照片。只读。可为 Null。The profile photos owned by the group. Read-only. Nullable.
plannerplanner plannerGroupplannerGroup 统一组可能存在的 Planner 资源入口点。Entry-point to Planner resource that might exist for a Unified Group.
rejectedSendersrejectedSenders directoryObject 集合directoryObject collection 不允许在此组中创建帖子或日历事件的用户或组列表。可为 NullThe list of users or groups that are not allowed to create posts or calendar events in this group. Nullable
设置settings groupSetting 集合groupSetting collection 只读。可为 NULL。Read-only. Nullable.
sitessites 网站site collection 该组中的 SharePoint 网站的列表。使用 /sites/root 访问默认网站。The list of SharePoint sites in this group. Access the default site with /sites/root.
threadsthreads conversationThread 集合conversationThread collection 组的对话线程。可为 Null。The group's conversation threads. Nullable.

JSON 表示形式JSON representation

下面是资源的 JSON 表示形式。The following is a JSON representation of the resource.

{
  "allowExternalSenders": false,
  "assignedLicenses": [{"@odata.type": "microsoft.graph.assignedLicense"}],
  "autoSubscribeNewMembers": true,
  "classification": "string",
  "createdDateTime": "String (timestamp)",
  "description": "string",
  "displayName": "string",
  "groupTypes": ["string"],
  "hasMembersWithLicenseErrors": "Boolean",
  "hideFromAddressLists": false,
  "hideFromOutlookClients": false,
  "id": "string (identifier)",
  "isSubscribedByMail": true,
  "licenseProcessingState": "string",
  "mail": "string",
  "mailEnabled": true,
  "mailNickname": "string",
  "onPremisesLastSyncDateTime": "String (timestamp)",
  "onPremisesProvisioningErrors": [{"@odata.type": "microsoft.graph.onPremisesProvisioningError"}],
  "onPremisesSecurityIdentifier": "string",
  "onPremisesSyncEnabled": true,
  "preferredDataLocation": "string",
  "proxyAddresses": ["string"],
  "renewedDateTime": "String (timestamp)",
  "resourceBehaviorOptions": ["String"],
  "resourceProvisioningOptions": ["String"],
  "securityEnabled": true,
  "securityIdentifier": "String",
  "unseenCount": 1024,
  "visibility": "string",
  "acceptedSenders": [ { "@odata.type": "microsoft.graph.directoryObject"} ],
  "calendar": { "@odata.type": "microsoft.graph.calendar" },
  "calendarView": [{ "@odata.type": "microsoft.graph.event" }],
  "conversations": [ { "@odata.type": "microsoft.graph.conversation" }],
  "createdOnBehalfOf": { "@odata.type": "microsoft.graph.directoryObject" },
  "drive": { "@odata.type": "microsoft.graph.drive" },
  "events": [ { "@odata.type": "microsoft.graph.event" }],
  "memberOf": [ { "@odata.type": "microsoft.graph.directoryObject" } ],
  "members": [ { "@odata.type": "microsoft.graph.directoryObject" } ],
  "membersWithLicenseErrors": [{"@odata.type": "microsoft.graph.user"}],
  "owners": [ { "@odata.type": "microsoft.graph.directoryObject" } ],
  "photo": { "@odata.type": "microsoft.graph.profilePhoto" },
  "rejectedSenders": [ { "@odata.type": "microsoft.graph.directoryObject" } ],
  "sites": [ { "@odata.type": "microsoft.graph.site" } ],
  "threads": [ { "@odata.type": "microsoft.graph.conversationThread" }]
}

另请参阅See also