Group extends DirectoryObject
Group class
Tags
Table of Contents
- $_propDict : array<string|int, mixed>
- The array of properties available to the model
- __construct() : mixed
- Construct a new Entity
- getAcceptedSenders() : array<string|int, mixed>|null
- Gets the acceptedSenders 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.
- getAllowExternalSenders() : bool|null
- Gets the allowExternalSenders Indicates if people external to the organization can send messages to the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- getAppRoleAssignments() : array<string|int, mixed>|null
- Gets the appRoleAssignments Represents the app roles a group has been granted for an application. Supports $expand.
- getAssignedLabels() : array<string|int, mixed>|null
- Gets the assignedLabels The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select. Read-only.
- getAssignedLicenses() : array<string|int, mixed>|null
- Gets the assignedLicenses The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq).Read-only.
- getAutoSubscribeNewMembers() : bool|null
- Gets the autoSubscribeNewMembers Indicates if new members added to the group will be auto-subscribed to receive email notifications. 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. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- getCalendar() : Calendar|null
- Gets the calendar The group's calendar. Read-only.
- getCalendarView() : array<string|int, mixed>|null
- Gets the calendarView The calendar view for the calendar. Read-only.
- getClassification() : string|null
- Gets the classification 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. Supports $filter (eq, ne, NOT, ge, le, startsWith).
- getConversations() : array<string|int, mixed>|null
- Gets the conversations The group's conversations.
- getCreatedDateTime() : DateTime|null
- Gets the createdDateTime Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
- getCreatedOnBehalfOf() : DirectoryObject|null
- Gets the createdOnBehalfOf The user (or application) that created the group. NOTE: This is not set if the user is an administrator. Read-only.
- getDeletedDateTime() : DateTime|null
- Gets the deletedDateTime
- getDescription() : string|null
- Gets the description An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search.
- getDisplayName() : string|null
- Gets the displayName The display name for the group. This property is required when a group is created and cannot be cleared during updates. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy.
- getDrive() : Drive|null
- Gets the drive The group's default drive. Read-only.
- getDrives() : array<string|int, mixed>|null
- Gets the drives The group's drives. Read-only.
- getEvents() : array<string|int, mixed>|null
- Gets the events The group's calendar events.
- getExpirationDateTime() : DateTime|null
- Gets the expirationDateTime Timestamp of when the group is set to expire. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
- getExtensions() : array<string|int, mixed>|null
- Gets the extensions The collection of open extensions defined for the group. Read-only. Nullable.
- getGroupLifecyclePolicies() : array<string|int, mixed>|null
- Gets the groupLifecyclePolicies The collection of lifecycle policies for this group. Read-only. Nullable.
- getGroupTypes() : string|null
- Gets the groupTypes Specifies the group type and its membership. 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.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT).
- getHasMembersWithLicenseErrors() : bool|null
- Gets the hasMembersWithLicenseErrors Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. 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. Supports $filter (eq).
- getHideFromAddressLists() : bool|null
- Gets the hideFromAddressLists 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. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- getHideFromOutlookClients() : bool|null
- Gets the hideFromOutlookClients True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- getId() : string|null
- Gets the id Read-only.
- getIsArchived() : bool|null
- Gets the isArchived
- getIsAssignableToRole() : bool|null
- Gets the isAssignableToRole Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the memership of such groups. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT).
- getIsSubscribedByMail() : bool|null
- Gets the isSubscribedByMail Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- getLicenseProcessingState() : LicenseProcessingState|null
- Gets the licenseProcessingState Indicates status of the group license assignment to all members of the group. Default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.Returned only on $select. Read-only.
- getMail() : string|null
- Gets the mail The SMTP address for the group, for example<EMAIL_ADDRESS>Returned by default. Read-only. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
- getMailEnabled() : bool|null
- Gets the mailEnabled Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, NOT).
- getMailNickname() : string|null
- Gets the mailNickname The mail alias for the group, unique in the organization. Required. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
- getMemberOf() : array<string|int, mixed>|null
- Gets the memberOf Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.
- getMembers() : array<string|int, mixed>|null
- Gets the members Users and groups that are members of this group. 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. Supports $expand.
- getMembershipRule() : string|null
- Gets the membershipRule 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. Supports $filter (eq, ne, NOT, ge, le, startsWith).
- getMembershipRuleProcessingState() : string|null
- Gets the membershipRuleProcessingState Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in).
- getMembersWithLicenseErrors() : array<string|int, mixed>|null
- Gets the membersWithLicenseErrors A list of group members with license errors from this group-based license assignment. Read-only.
- getODataType() : string|null
- Gets the ODataType
- getOnenote() : Onenote|null
- Gets the onenote Read-only.
- getOnPremisesDomainName() : string|null
- Gets the onPremisesDomainName Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises 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.
- getOnPremisesLastSyncDateTime() : DateTime|null
- Gets the onPremisesLastSyncDateTime Indicates the last time at which the group was synced with the on-premises directory.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, NOT, ge, le, in).
- getOnPremisesNetBiosName() : string|null
- Gets the onPremisesNetBiosName Contains the on-premises netBios name synchronized from the on-premises 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.
- getOnPremisesProvisioningErrors() : array<string|int, mixed>|null
- Gets the onPremisesProvisioningErrors Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, NOT).
- getOnPremisesSamAccountName() : string|null
- Gets the onPremisesSamAccountName Contains the on-premises SAM account name synchronized from the on-premises 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. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). Read-only.
- getOnPremisesSecurityIdentifier() : string|null
- Gets the onPremisesSecurityIdentifier Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Returned by default. Supports $filter on null values. Read-only.
- getOnPremisesSyncEnabled() : bool|null
- Gets the onPremisesSyncEnabled 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. Supports $filter (eq, ne, NOT, in).
- getOwners() : array<string|int, mixed>|null
- Gets the owners The owners of the group. The owners are a set of non-admin users who are allowed to modify this object. Limited to 100 owners. 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. Supports $expand.
- getPermissionGrants() : array<string|int, mixed>|null
- Gets the permissionGrants The permission that has been granted for a group to a specific application. Supports $expand.
- getPhoto() : ProfilePhoto|null
- Gets the photo The group's profile photo
- getPhotos() : array<string|int, mixed>|null
- Gets the photos The profile photos owned by the group. Read-only. Nullable.
- getPlanner() : PlannerGroup|null
- Gets the planner Entry-point to Planner resource that might exist for a Unified Group.
- getPreferredDataLocation() : string|null
- Gets the preferredDataLocation The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default.
- getPreferredLanguage() : string|null
- Gets the preferredLanguage The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
- getProperties() : array<string|int, mixed>
- Gets the property dictionary of the Entity
- getProxyAddresses() : string|null
- Gets the proxyAddresses Email addresses for the group that direct to the same group mailbox. For example: ['SMTP<EMAIL_ADDRESS>'smtp<EMAIL_ADDRESS>The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith).
- getRejectedSenders() : array<string|int, mixed>|null
- Gets the rejectedSenders The list of users or groups that are not allowed to create posts or calendar events in this group. Nullable
- getRenewedDateTime() : DateTime|null
- Gets the renewedDateTime Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
- getSecurityEnabled() : bool|null
- Gets the securityEnabled Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, NOT, in).
- getSecurityIdentifier() : string|null
- Gets the securityIdentifier Security identifier of the group, used in Windows scenarios. Returned by default.
- getSettings() : array<string|int, mixed>|null
- Gets the settings Read-only. Nullable.
- getSites() : array<string|int, mixed>|null
- Gets the sites The list of SharePoint sites in this group. Access the default site with /sites/root.
- getTeam() : Team|null
- Gets the team
- getTheme() : string|null
- Gets the theme Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.
- getThreads() : array<string|int, mixed>|null
- Gets the threads The group's conversation threads. Nullable.
- getTransitiveMemberOf() : array<string|int, mixed>|null
- Gets the transitiveMemberOf
- getTransitiveMembers() : array<string|int, mixed>|null
- Gets the transitiveMembers
- getUnseenCount() : int|null
- Gets the unseenCount Count of conversations that have received new posts since the signed-in user last visited the group. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- getVisibility() : string|null
- Gets the visibility Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. Nullable.
- jsonSerialize() : array<string|int, mixed>
- Serializes the object by property array Manually serialize DateTime into RFC3339 format
- setAcceptedSenders() : Group
- Sets the acceptedSenders 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.
- setAllowExternalSenders() : Group
- Sets the allowExternalSenders Indicates if people external to the organization can send messages to the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- setAppRoleAssignments() : Group
- Sets the appRoleAssignments Represents the app roles a group has been granted for an application. Supports $expand.
- setAssignedLabels() : Group
- Sets the assignedLabels The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select. Read-only.
- setAssignedLicenses() : Group
- Sets the assignedLicenses The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq).Read-only.
- setAutoSubscribeNewMembers() : Group
- Sets the autoSubscribeNewMembers Indicates if new members added to the group will be auto-subscribed to receive email notifications. 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. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- setCalendar() : Group
- Sets the calendar The group's calendar. Read-only.
- setCalendarView() : Group
- Sets the calendarView The calendar view for the calendar. Read-only.
- setClassification() : Group
- Sets the classification 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. Supports $filter (eq, ne, NOT, ge, le, startsWith).
- setConversations() : Group
- Sets the conversations The group's conversations.
- setCreatedDateTime() : Group
- Sets the createdDateTime Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
- setCreatedOnBehalfOf() : Group
- Sets the createdOnBehalfOf The user (or application) that created the group. NOTE: This is not set if the user is an administrator. Read-only.
- setDeletedDateTime() : DirectoryObject
- Sets the deletedDateTime
- setDescription() : Group
- Sets the description An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search.
- setDisplayName() : Group
- Sets the displayName The display name for the group. This property is required when a group is created and cannot be cleared during updates. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy.
- setDrive() : Group
- Sets the drive The group's default drive. Read-only.
- setDrives() : Group
- Sets the drives The group's drives. Read-only.
- setEvents() : Group
- Sets the events The group's calendar events.
- setExpirationDateTime() : Group
- Sets the expirationDateTime Timestamp of when the group is set to expire. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
- setExtensions() : Group
- Sets the extensions The collection of open extensions defined for the group. Read-only. Nullable.
- setGroupLifecyclePolicies() : Group
- Sets the groupLifecyclePolicies The collection of lifecycle policies for this group. Read-only. Nullable.
- setGroupTypes() : Group
- Sets the groupTypes Specifies the group type and its membership. 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.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT).
- setHasMembersWithLicenseErrors() : Group
- Sets the hasMembersWithLicenseErrors Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. 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. Supports $filter (eq).
- setHideFromAddressLists() : Group
- Sets the hideFromAddressLists 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. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- setHideFromOutlookClients() : Group
- Sets the hideFromOutlookClients True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- setId() : Entity
- Sets the id Read-only.
- setIsArchived() : Group
- Sets the isArchived
- setIsAssignableToRole() : Group
- Sets the isAssignableToRole Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the memership of such groups. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT).
- setIsSubscribedByMail() : Group
- Sets the isSubscribedByMail Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- setLicenseProcessingState() : Group
- Sets the licenseProcessingState Indicates status of the group license assignment to all members of the group. Default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.Returned only on $select. Read-only.
- setMail() : Group
- Sets the mail The SMTP address for the group, for example<EMAIL_ADDRESS>Returned by default. Read-only. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
- setMailEnabled() : Group
- Sets the mailEnabled Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, NOT).
- setMailNickname() : Group
- Sets the mailNickname The mail alias for the group, unique in the organization. Required. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
- setMemberOf() : Group
- Sets the memberOf Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.
- setMembers() : Group
- Sets the members Users and groups that are members of this group. 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. Supports $expand.
- setMembershipRule() : Group
- Sets the membershipRule 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. Supports $filter (eq, ne, NOT, ge, le, startsWith).
- setMembershipRuleProcessingState() : Group
- Sets the membershipRuleProcessingState Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in).
- setMembersWithLicenseErrors() : Group
- Sets the membersWithLicenseErrors A list of group members with license errors from this group-based license assignment. Read-only.
- setODataType() : Entity
- Sets the ODataType
- setOnenote() : Group
- Sets the onenote Read-only.
- setOnPremisesDomainName() : Group
- Sets the onPremisesDomainName Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises 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.
- setOnPremisesLastSyncDateTime() : Group
- Sets the onPremisesLastSyncDateTime Indicates the last time at which the group was synced with the on-premises directory.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, NOT, ge, le, in).
- setOnPremisesNetBiosName() : Group
- Sets the onPremisesNetBiosName Contains the on-premises netBios name synchronized from the on-premises 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.
- setOnPremisesProvisioningErrors() : Group
- Sets the onPremisesProvisioningErrors Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, NOT).
- setOnPremisesSamAccountName() : Group
- Sets the onPremisesSamAccountName Contains the on-premises SAM account name synchronized from the on-premises 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. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). Read-only.
- setOnPremisesSecurityIdentifier() : Group
- Sets the onPremisesSecurityIdentifier Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Returned by default. Supports $filter on null values. Read-only.
- setOnPremisesSyncEnabled() : Group
- Sets the onPremisesSyncEnabled 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. Supports $filter (eq, ne, NOT, in).
- setOwners() : Group
- Sets the owners The owners of the group. The owners are a set of non-admin users who are allowed to modify this object. Limited to 100 owners. 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. Supports $expand.
- setPermissionGrants() : Group
- Sets the permissionGrants The permission that has been granted for a group to a specific application. Supports $expand.
- setPhoto() : Group
- Sets the photo The group's profile photo
- setPhotos() : Group
- Sets the photos The profile photos owned by the group. Read-only. Nullable.
- setPlanner() : Group
- Sets the planner Entry-point to Planner resource that might exist for a Unified Group.
- setPreferredDataLocation() : Group
- Sets the preferredDataLocation The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default.
- setPreferredLanguage() : Group
- Sets the preferredLanguage The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
- setProxyAddresses() : Group
- Sets the proxyAddresses Email addresses for the group that direct to the same group mailbox. For example: ['SMTP<EMAIL_ADDRESS>'smtp<EMAIL_ADDRESS>The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith).
- setRejectedSenders() : Group
- Sets the rejectedSenders The list of users or groups that are not allowed to create posts or calendar events in this group. Nullable
- setRenewedDateTime() : Group
- Sets the renewedDateTime Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
- setSecurityEnabled() : Group
- Sets the securityEnabled Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, NOT, in).
- setSecurityIdentifier() : Group
- Sets the securityIdentifier Security identifier of the group, used in Windows scenarios. Returned by default.
- setSettings() : Group
- Sets the settings Read-only. Nullable.
- setSites() : Group
- Sets the sites The list of SharePoint sites in this group. Access the default site with /sites/root.
- setTeam() : Group
- Sets the team
- setTheme() : Group
- Sets the theme Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.
- setThreads() : Group
- Sets the threads The group's conversation threads. Nullable.
- setTransitiveMemberOf() : Group
- Sets the transitiveMemberOf
- setTransitiveMembers() : Group
- Sets the transitiveMembers
- setUnseenCount() : Group
- Sets the unseenCount Count of conversations that have received new posts since the signed-in user last visited the group. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
- setVisibility() : Group
- Sets the visibility Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. Nullable.
Properties
$_propDict
The array of properties available to the model
protected
array<string|int, mixed>
$_propDict
Methods
__construct()
Construct a new Entity
public
__construct([array<string|int, mixed> $propDict = array() ]) : mixed
Parameters
- $propDict : array<string|int, mixed> = array()
-
A list of properties to set
Return values
mixed —getAcceptedSenders()
Gets the acceptedSenders 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.
public
getAcceptedSenders() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The acceptedSenders
getAllowExternalSenders()
Gets the allowExternalSenders Indicates if people external to the organization can send messages to the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
getAllowExternalSenders() : bool|null
Return values
bool|null —The allowExternalSenders
getAppRoleAssignments()
Gets the appRoleAssignments Represents the app roles a group has been granted for an application. Supports $expand.
public
getAppRoleAssignments() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The appRoleAssignments
getAssignedLabels()
Gets the assignedLabels The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select. Read-only.
public
getAssignedLabels() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The assignedLabels
getAssignedLicenses()
Gets the assignedLicenses The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq).Read-only.
public
getAssignedLicenses() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The assignedLicenses
getAutoSubscribeNewMembers()
Gets the autoSubscribeNewMembers Indicates if new members added to the group will be auto-subscribed to receive email notifications. 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. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
getAutoSubscribeNewMembers() : bool|null
Return values
bool|null —The autoSubscribeNewMembers
getCalendar()
Gets the calendar The group's calendar. Read-only.
public
getCalendar() : Calendar|null
Return values
Calendar|null —The calendar
getCalendarView()
Gets the calendarView The calendar view for the calendar. Read-only.
public
getCalendarView() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The calendarView
getClassification()
Gets the classification 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. Supports $filter (eq, ne, NOT, ge, le, startsWith).
public
getClassification() : string|null
Return values
string|null —The classification
getConversations()
Gets the conversations The group's conversations.
public
getConversations() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The conversations
getCreatedDateTime()
Gets the createdDateTime Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
public
getCreatedDateTime() : DateTime|null
Return values
DateTime|null —The createdDateTime
getCreatedOnBehalfOf()
Gets the createdOnBehalfOf The user (or application) that created the group. NOTE: This is not set if the user is an administrator. Read-only.
public
getCreatedOnBehalfOf() : DirectoryObject|null
Return values
DirectoryObject|null —The createdOnBehalfOf
getDeletedDateTime()
Gets the deletedDateTime
public
getDeletedDateTime() : DateTime|null
Return values
DateTime|null —The deletedDateTime
getDescription()
Gets the description An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search.
public
getDescription() : string|null
Return values
string|null —The description
getDisplayName()
Gets the displayName The display name for the group. This property is required when a group is created and cannot be cleared during updates. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy.
public
getDisplayName() : string|null
Return values
string|null —The displayName
getDrive()
Gets the drive The group's default drive. Read-only.
public
getDrive() : Drive|null
Return values
Drive|null —The drive
getDrives()
Gets the drives The group's drives. Read-only.
public
getDrives() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The drives
getEvents()
Gets the events The group's calendar events.
public
getEvents() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The events
getExpirationDateTime()
Gets the expirationDateTime Timestamp of when the group is set to expire. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
public
getExpirationDateTime() : DateTime|null
Return values
DateTime|null —The expirationDateTime
getExtensions()
Gets the extensions The collection of open extensions defined for the group. Read-only. Nullable.
public
getExtensions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The extensions
getGroupLifecyclePolicies()
Gets the groupLifecyclePolicies The collection of lifecycle policies for this group. Read-only. Nullable.
public
getGroupLifecyclePolicies() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The groupLifecyclePolicies
getGroupTypes()
Gets the groupTypes Specifies the group type and its membership. 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.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT).
public
getGroupTypes() : string|null
Return values
string|null —The groupTypes
getHasMembersWithLicenseErrors()
Gets the hasMembersWithLicenseErrors Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. 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. Supports $filter (eq).
public
getHasMembersWithLicenseErrors() : bool|null
Return values
bool|null —The hasMembersWithLicenseErrors
getHideFromAddressLists()
Gets the hideFromAddressLists 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. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
getHideFromAddressLists() : bool|null
Return values
bool|null —The hideFromAddressLists
getHideFromOutlookClients()
Gets the hideFromOutlookClients True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
getHideFromOutlookClients() : bool|null
Return values
bool|null —The hideFromOutlookClients
getId()
Gets the id Read-only.
public
getId() : string|null
Return values
string|null —The id
getIsArchived()
Gets the isArchived
public
getIsArchived() : bool|null
Return values
bool|null —The isArchived
getIsAssignableToRole()
Gets the isAssignableToRole Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the memership of such groups. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT).
public
getIsAssignableToRole() : bool|null
Return values
bool|null —The isAssignableToRole
getIsSubscribedByMail()
Gets the isSubscribedByMail Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
getIsSubscribedByMail() : bool|null
Return values
bool|null —The isSubscribedByMail
getLicenseProcessingState()
Gets the licenseProcessingState Indicates status of the group license assignment to all members of the group. Default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.Returned only on $select. Read-only.
public
getLicenseProcessingState() : LicenseProcessingState|null
Return values
LicenseProcessingState|null —The licenseProcessingState
getMail()
Gets the mail The SMTP address for the group, for example<EMAIL_ADDRESS>Returned by default. Read-only. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
public
getMail() : string|null
Return values
string|null —The mail
getMailEnabled()
Gets the mailEnabled Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, NOT).
public
getMailEnabled() : bool|null
Return values
bool|null —The mailEnabled
getMailNickname()
Gets the mailNickname The mail alias for the group, unique in the organization. Required. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
public
getMailNickname() : string|null
Return values
string|null —The mailNickname
getMemberOf()
Gets the memberOf Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.
public
getMemberOf() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The memberOf
getMembers()
Gets the members Users and groups that are members of this group. 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. Supports $expand.
public
getMembers() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The members
getMembershipRule()
Gets the membershipRule 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. Supports $filter (eq, ne, NOT, ge, le, startsWith).
public
getMembershipRule() : string|null
Return values
string|null —The membershipRule
getMembershipRuleProcessingState()
Gets the membershipRuleProcessingState Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in).
public
getMembershipRuleProcessingState() : string|null
Return values
string|null —The membershipRuleProcessingState
getMembersWithLicenseErrors()
Gets the membersWithLicenseErrors A list of group members with license errors from this group-based license assignment. Read-only.
public
getMembersWithLicenseErrors() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The membersWithLicenseErrors
getODataType()
Gets the ODataType
public
getODataType() : string|null
Return values
string|null —The ODataType
getOnenote()
Gets the onenote Read-only.
public
getOnenote() : Onenote|null
Return values
Onenote|null —The onenote
getOnPremisesDomainName()
Gets the onPremisesDomainName Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises 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.
public
getOnPremisesDomainName() : string|null
Return values
string|null —The onPremisesDomainName
getOnPremisesLastSyncDateTime()
Gets the onPremisesLastSyncDateTime Indicates the last time at which the group was synced with the on-premises directory.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, NOT, ge, le, in).
public
getOnPremisesLastSyncDateTime() : DateTime|null
Return values
DateTime|null —The onPremisesLastSyncDateTime
getOnPremisesNetBiosName()
Gets the onPremisesNetBiosName Contains the on-premises netBios name synchronized from the on-premises 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.
public
getOnPremisesNetBiosName() : string|null
Return values
string|null —The onPremisesNetBiosName
getOnPremisesProvisioningErrors()
Gets the onPremisesProvisioningErrors Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, NOT).
public
getOnPremisesProvisioningErrors() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The onPremisesProvisioningErrors
getOnPremisesSamAccountName()
Gets the onPremisesSamAccountName Contains the on-premises SAM account name synchronized from the on-premises 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. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). Read-only.
public
getOnPremisesSamAccountName() : string|null
Return values
string|null —The onPremisesSamAccountName
getOnPremisesSecurityIdentifier()
Gets the onPremisesSecurityIdentifier Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Returned by default. Supports $filter on null values. Read-only.
public
getOnPremisesSecurityIdentifier() : string|null
Return values
string|null —The onPremisesSecurityIdentifier
getOnPremisesSyncEnabled()
Gets the onPremisesSyncEnabled 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. Supports $filter (eq, ne, NOT, in).
public
getOnPremisesSyncEnabled() : bool|null
Return values
bool|null —The onPremisesSyncEnabled
getOwners()
Gets the owners The owners of the group. The owners are a set of non-admin users who are allowed to modify this object. Limited to 100 owners. 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. Supports $expand.
public
getOwners() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The owners
getPermissionGrants()
Gets the permissionGrants The permission that has been granted for a group to a specific application. Supports $expand.
public
getPermissionGrants() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The permissionGrants
getPhoto()
Gets the photo The group's profile photo
public
getPhoto() : ProfilePhoto|null
Return values
ProfilePhoto|null —The photo
getPhotos()
Gets the photos The profile photos owned by the group. Read-only. Nullable.
public
getPhotos() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The photos
getPlanner()
Gets the planner Entry-point to Planner resource that might exist for a Unified Group.
public
getPlanner() : PlannerGroup|null
Return values
PlannerGroup|null —The planner
getPreferredDataLocation()
Gets the preferredDataLocation The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default.
public
getPreferredDataLocation() : string|null
Return values
string|null —The preferredDataLocation
getPreferredLanguage()
Gets the preferredLanguage The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
public
getPreferredLanguage() : string|null
Return values
string|null —The preferredLanguage
getProperties()
Gets the property dictionary of the Entity
public
getProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of properties
getProxyAddresses()
Gets the proxyAddresses Email addresses for the group that direct to the same group mailbox. For example: ['SMTP<EMAIL_ADDRESS>'smtp<EMAIL_ADDRESS>The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith).
public
getProxyAddresses() : string|null
Return values
string|null —The proxyAddresses
getRejectedSenders()
Gets the rejectedSenders The list of users or groups that are not allowed to create posts or calendar events in this group. Nullable
public
getRejectedSenders() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The rejectedSenders
getRenewedDateTime()
Gets the renewedDateTime Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
public
getRenewedDateTime() : DateTime|null
Return values
DateTime|null —The renewedDateTime
getSecurityEnabled()
Gets the securityEnabled Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, NOT, in).
public
getSecurityEnabled() : bool|null
Return values
bool|null —The securityEnabled
getSecurityIdentifier()
Gets the securityIdentifier Security identifier of the group, used in Windows scenarios. Returned by default.
public
getSecurityIdentifier() : string|null
Return values
string|null —The securityIdentifier
getSettings()
Gets the settings Read-only. Nullable.
public
getSettings() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The settings
getSites()
Gets the sites The list of SharePoint sites in this group. Access the default site with /sites/root.
public
getSites() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The sites
getTeam()
Gets the team
public
getTeam() : Team|null
Return values
Team|null —The team
getTheme()
Gets the theme Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.
public
getTheme() : string|null
Return values
string|null —The theme
getThreads()
Gets the threads The group's conversation threads. Nullable.
public
getThreads() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The threads
getTransitiveMemberOf()
Gets the transitiveMemberOf
public
getTransitiveMemberOf() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The transitiveMemberOf
getTransitiveMembers()
Gets the transitiveMembers
public
getTransitiveMembers() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The transitiveMembers
getUnseenCount()
Gets the unseenCount Count of conversations that have received new posts since the signed-in user last visited the group. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
getUnseenCount() : int|null
Return values
int|null —The unseenCount
getVisibility()
Gets the visibility Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. Nullable.
public
getVisibility() : string|null
Return values
string|null —The visibility
jsonSerialize()
Serializes the object by property array Manually serialize DateTime into RFC3339 format
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of properties
setAcceptedSenders()
Sets the acceptedSenders 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.
public
setAcceptedSenders(DirectoryObject $val) : Group
Parameters
- $val : DirectoryObject
-
The acceptedSenders
Return values
Group —setAllowExternalSenders()
Sets the allowExternalSenders Indicates if people external to the organization can send messages to the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
setAllowExternalSenders(bool $val) : Group
Parameters
- $val : bool
-
The allowExternalSenders
Return values
Group —setAppRoleAssignments()
Sets the appRoleAssignments Represents the app roles a group has been granted for an application. Supports $expand.
public
setAppRoleAssignments(AppRoleAssignment $val) : Group
Parameters
- $val : AppRoleAssignment
-
The appRoleAssignments
Return values
Group —setAssignedLabels()
Sets the assignedLabels The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select. Read-only.
public
setAssignedLabels(AssignedLabel $val) : Group
Parameters
- $val : AssignedLabel
-
The assignedLabels
Return values
Group —setAssignedLicenses()
Sets the assignedLicenses The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq).Read-only.
public
setAssignedLicenses(AssignedLicense $val) : Group
Parameters
- $val : AssignedLicense
-
The assignedLicenses
Return values
Group —setAutoSubscribeNewMembers()
Sets the autoSubscribeNewMembers Indicates if new members added to the group will be auto-subscribed to receive email notifications. 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. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
setAutoSubscribeNewMembers(bool $val) : Group
Parameters
- $val : bool
-
The autoSubscribeNewMembers
Return values
Group —setCalendar()
Sets the calendar The group's calendar. Read-only.
public
setCalendar(Calendar $val) : Group
Parameters
- $val : Calendar
-
The calendar
Return values
Group —setCalendarView()
Sets the calendarView The calendar view for the calendar. Read-only.
public
setCalendarView(Event $val) : Group
Parameters
- $val : Event
-
The calendarView
Return values
Group —setClassification()
Sets the classification 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. Supports $filter (eq, ne, NOT, ge, le, startsWith).
public
setClassification(string $val) : Group
Parameters
- $val : string
-
The classification
Return values
Group —setConversations()
Sets the conversations The group's conversations.
public
setConversations(Conversation $val) : Group
Parameters
- $val : Conversation
-
The conversations
Return values
Group —setCreatedDateTime()
Sets the createdDateTime Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
public
setCreatedDateTime(DateTime $val) : Group
Parameters
- $val : DateTime
-
The createdDateTime
Return values
Group —setCreatedOnBehalfOf()
Sets the createdOnBehalfOf The user (or application) that created the group. NOTE: This is not set if the user is an administrator. Read-only.
public
setCreatedOnBehalfOf(DirectoryObject $val) : Group
Parameters
- $val : DirectoryObject
-
The createdOnBehalfOf
Return values
Group —setDeletedDateTime()
Sets the deletedDateTime
public
setDeletedDateTime(DateTime $val) : DirectoryObject
Parameters
- $val : DateTime
-
The deletedDateTime
Return values
DirectoryObject —setDescription()
Sets the description An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search.
public
setDescription(string $val) : Group
Parameters
- $val : string
-
The description
Return values
Group —setDisplayName()
Sets the displayName The display name for the group. This property is required when a group is created and cannot be cleared during updates. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy.
public
setDisplayName(string $val) : Group
Parameters
- $val : string
-
The displayName
Return values
Group —setDrive()
Sets the drive The group's default drive. Read-only.
public
setDrive(Drive $val) : Group
Parameters
- $val : Drive
-
The drive
Return values
Group —setDrives()
Sets the drives The group's drives. Read-only.
public
setDrives(Drive $val) : Group
Parameters
- $val : Drive
-
The drives
Return values
Group —setEvents()
Sets the events The group's calendar events.
public
setEvents(Event $val) : Group
Parameters
- $val : Event
-
The events
Return values
Group —setExpirationDateTime()
Sets the expirationDateTime Timestamp of when the group is set to expire. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
public
setExpirationDateTime(DateTime $val) : Group
Parameters
- $val : DateTime
-
The expirationDateTime
Return values
Group —setExtensions()
Sets the extensions The collection of open extensions defined for the group. Read-only. Nullable.
public
setExtensions(Extension $val) : Group
Parameters
- $val : Extension
-
The extensions
Return values
Group —setGroupLifecyclePolicies()
Sets the groupLifecyclePolicies The collection of lifecycle policies for this group. Read-only. Nullable.
public
setGroupLifecyclePolicies(GroupLifecyclePolicy $val) : Group
Parameters
- $val : GroupLifecyclePolicy
-
The groupLifecyclePolicies
Return values
Group —setGroupTypes()
Sets the groupTypes Specifies the group type and its membership. 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.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT).
public
setGroupTypes(string $val) : Group
Parameters
- $val : string
-
The groupTypes
Return values
Group —setHasMembersWithLicenseErrors()
Sets the hasMembersWithLicenseErrors Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. 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. Supports $filter (eq).
public
setHasMembersWithLicenseErrors(bool $val) : Group
Parameters
- $val : bool
-
The hasMembersWithLicenseErrors
Return values
Group —setHideFromAddressLists()
Sets the hideFromAddressLists 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. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
setHideFromAddressLists(bool $val) : Group
Parameters
- $val : bool
-
The hideFromAddressLists
Return values
Group —setHideFromOutlookClients()
Sets the hideFromOutlookClients True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
setHideFromOutlookClients(bool $val) : Group
Parameters
- $val : bool
-
The hideFromOutlookClients
Return values
Group —setId()
Sets the id Read-only.
public
setId(string $val) : Entity
Parameters
- $val : string
-
The id
Return values
Entity —setIsArchived()
Sets the isArchived
public
setIsArchived(bool $val) : Group
Parameters
- $val : bool
-
The isArchived
Return values
Group —setIsAssignableToRole()
Sets the isAssignableToRole Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the memership of such groups. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT).
public
setIsAssignableToRole(bool $val) : Group
Parameters
- $val : bool
-
The isAssignableToRole
Return values
Group —setIsSubscribedByMail()
Sets the isSubscribedByMail Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
setIsSubscribedByMail(bool $val) : Group
Parameters
- $val : bool
-
The isSubscribedByMail
Return values
Group —setLicenseProcessingState()
Sets the licenseProcessingState Indicates status of the group license assignment to all members of the group. Default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.Returned only on $select. Read-only.
public
setLicenseProcessingState(LicenseProcessingState $val) : Group
Parameters
- $val : LicenseProcessingState
-
The licenseProcessingState
Return values
Group —setMail()
Sets the mail The SMTP address for the group, for example<EMAIL_ADDRESS>Returned by default. Read-only. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
public
setMail(string $val) : Group
Parameters
- $val : string
-
The mail
Return values
Group —setMailEnabled()
Sets the mailEnabled Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, NOT).
public
setMailEnabled(bool $val) : Group
Parameters
- $val : bool
-
The mailEnabled
Return values
Group —setMailNickname()
Sets the mailNickname The mail alias for the group, unique in the organization. Required. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
public
setMailNickname(string $val) : Group
Parameters
- $val : string
-
The mailNickname
Return values
Group —setMemberOf()
Sets the memberOf Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.
public
setMemberOf(DirectoryObject $val) : Group
Parameters
- $val : DirectoryObject
-
The memberOf
Return values
Group —setMembers()
Sets the members Users and groups that are members of this group. 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. Supports $expand.
public
setMembers(DirectoryObject $val) : Group
Parameters
- $val : DirectoryObject
-
The members
Return values
Group —setMembershipRule()
Sets the membershipRule 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. Supports $filter (eq, ne, NOT, ge, le, startsWith).
public
setMembershipRule(string $val) : Group
Parameters
- $val : string
-
The membershipRule
Return values
Group —setMembershipRuleProcessingState()
Sets the membershipRuleProcessingState Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in).
public
setMembershipRuleProcessingState(string $val) : Group
Parameters
- $val : string
-
The membershipRuleProcessingState
Return values
Group —setMembersWithLicenseErrors()
Sets the membersWithLicenseErrors A list of group members with license errors from this group-based license assignment. Read-only.
public
setMembersWithLicenseErrors(DirectoryObject $val) : Group
Parameters
- $val : DirectoryObject
-
The membersWithLicenseErrors
Return values
Group —setODataType()
Sets the ODataType
public
setODataType(string $val) : Entity
Parameters
- $val : string
-
The ODataType
Return values
Entity —setOnenote()
Sets the onenote Read-only.
public
setOnenote(Onenote $val) : Group
Parameters
- $val : Onenote
-
The onenote
Return values
Group —setOnPremisesDomainName()
Sets the onPremisesDomainName Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises 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.
public
setOnPremisesDomainName(string $val) : Group
Parameters
- $val : string
-
The onPremisesDomainName
Return values
Group —setOnPremisesLastSyncDateTime()
Sets the onPremisesLastSyncDateTime Indicates the last time at which the group was synced with the on-premises directory.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, NOT, ge, le, in).
public
setOnPremisesLastSyncDateTime(DateTime $val) : Group
Parameters
- $val : DateTime
-
The onPremisesLastSyncDateTime
Return values
Group —setOnPremisesNetBiosName()
Sets the onPremisesNetBiosName Contains the on-premises netBios name synchronized from the on-premises 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.
public
setOnPremisesNetBiosName(string $val) : Group
Parameters
- $val : string
-
The onPremisesNetBiosName
Return values
Group —setOnPremisesProvisioningErrors()
Sets the onPremisesProvisioningErrors Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, NOT).
public
setOnPremisesProvisioningErrors(OnPremisesProvisioningError $val) : Group
Parameters
- $val : OnPremisesProvisioningError
-
The onPremisesProvisioningErrors
Return values
Group —setOnPremisesSamAccountName()
Sets the onPremisesSamAccountName Contains the on-premises SAM account name synchronized from the on-premises 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. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). Read-only.
public
setOnPremisesSamAccountName(string $val) : Group
Parameters
- $val : string
-
The onPremisesSamAccountName
Return values
Group —setOnPremisesSecurityIdentifier()
Sets the onPremisesSecurityIdentifier Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Returned by default. Supports $filter on null values. Read-only.
public
setOnPremisesSecurityIdentifier(string $val) : Group
Parameters
- $val : string
-
The onPremisesSecurityIdentifier
Return values
Group —setOnPremisesSyncEnabled()
Sets the onPremisesSyncEnabled 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. Supports $filter (eq, ne, NOT, in).
public
setOnPremisesSyncEnabled(bool $val) : Group
Parameters
- $val : bool
-
The onPremisesSyncEnabled
Return values
Group —setOwners()
Sets the owners The owners of the group. The owners are a set of non-admin users who are allowed to modify this object. Limited to 100 owners. 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. Supports $expand.
public
setOwners(DirectoryObject $val) : Group
Parameters
- $val : DirectoryObject
-
The owners
Return values
Group —setPermissionGrants()
Sets the permissionGrants The permission that has been granted for a group to a specific application. Supports $expand.
public
setPermissionGrants(ResourceSpecificPermissionGrant $val) : Group
Parameters
- $val : ResourceSpecificPermissionGrant
-
The permissionGrants
Return values
Group —setPhoto()
Sets the photo The group's profile photo
public
setPhoto(ProfilePhoto $val) : Group
Parameters
- $val : ProfilePhoto
-
The photo
Return values
Group —setPhotos()
Sets the photos The profile photos owned by the group. Read-only. Nullable.
public
setPhotos(ProfilePhoto $val) : Group
Parameters
- $val : ProfilePhoto
-
The photos
Return values
Group —setPlanner()
Sets the planner Entry-point to Planner resource that might exist for a Unified Group.
public
setPlanner(PlannerGroup $val) : Group
Parameters
- $val : PlannerGroup
-
The planner
Return values
Group —setPreferredDataLocation()
Sets the preferredDataLocation The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default.
public
setPreferredDataLocation(string $val) : Group
Parameters
- $val : string
-
The preferredDataLocation
Return values
Group —setPreferredLanguage()
Sets the preferredLanguage The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
public
setPreferredLanguage(string $val) : Group
Parameters
- $val : string
-
The preferredLanguage
Return values
Group —setProxyAddresses()
Sets the proxyAddresses Email addresses for the group that direct to the same group mailbox. For example: ['SMTP<EMAIL_ADDRESS>'smtp<EMAIL_ADDRESS>The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith).
public
setProxyAddresses(string $val) : Group
Parameters
- $val : string
-
The proxyAddresses
Return values
Group —setRejectedSenders()
Sets the rejectedSenders The list of users or groups that are not allowed to create posts or calendar events in this group. Nullable
public
setRejectedSenders(DirectoryObject $val) : Group
Parameters
- $val : DirectoryObject
-
The rejectedSenders
Return values
Group —setRenewedDateTime()
Sets the renewedDateTime Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.
public
setRenewedDateTime(DateTime $val) : Group
Parameters
- $val : DateTime
-
The renewedDateTime
Return values
Group —setSecurityEnabled()
Sets the securityEnabled Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, NOT, in).
public
setSecurityEnabled(bool $val) : Group
Parameters
- $val : bool
-
The securityEnabled
Return values
Group —setSecurityIdentifier()
Sets the securityIdentifier Security identifier of the group, used in Windows scenarios. Returned by default.
public
setSecurityIdentifier(string $val) : Group
Parameters
- $val : string
-
The securityIdentifier
Return values
Group —setSettings()
Sets the settings Read-only. Nullable.
public
setSettings(GroupSetting $val) : Group
Parameters
- $val : GroupSetting
-
The settings
Return values
Group —setSites()
Sets the sites The list of SharePoint sites in this group. Access the default site with /sites/root.
public
setSites(Site $val) : Group
Parameters
- $val : Site
-
The sites
Return values
Group —setTeam()
Sets the team
public
setTeam(Team $val) : Group
Parameters
- $val : Team
-
The team
Return values
Group —setTheme()
Sets the theme Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.
public
setTheme(string $val) : Group
Parameters
- $val : string
-
The theme
Return values
Group —setThreads()
Sets the threads The group's conversation threads. Nullable.
public
setThreads(ConversationThread $val) : Group
Parameters
- $val : ConversationThread
-
The threads
Return values
Group —setTransitiveMemberOf()
Sets the transitiveMemberOf
public
setTransitiveMemberOf(DirectoryObject $val) : Group
Parameters
- $val : DirectoryObject
-
The transitiveMemberOf
Return values
Group —setTransitiveMembers()
Sets the transitiveMembers
public
setTransitiveMembers(DirectoryObject $val) : Group
Parameters
- $val : DirectoryObject
-
The transitiveMembers
Return values
Group —setUnseenCount()
Sets the unseenCount Count of conversations that have received new posts since the signed-in user last visited the group. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
public
setUnseenCount(int $val) : Group
Parameters
- $val : int
-
The unseenCount
Return values
Group —setVisibility()
Sets the visibility Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. Nullable.
public
setVisibility(string $val) : Group
Parameters
- $val : string
-
The visibility


The American phrase “OK,” as in “everything is alright, I’m OK,” first appeared in common
use as a result of an abbreviation fad that swept Boston in the late 1830s;
OK was
an abbreviation of the purposely misspelled phrase “oll korrect” (a variation of “all
correct”).


Jose Sachango
About
Portfolio
Contact
Portfolio
Fig.1 - Calendar App.
Fig.2 - Pet Resume App.
Fig.3 - Password Generator App.
Fig.4 - Weather Dashboard App.
Fig.5 - Quiz Game App.
Fig.6 - Burger App.
Fig.7 - Chat App.
Fig.8 - Notetaker App.