groupLifecyclePolicy resource type

  • 2 minutes to read
  • Contributors
    • Dan Kershaw [MSFT]
    • Jeremy Thake (Microsoft)
    • Office GSX
    • daron
    • Pat Altimore

Represents a a lifecycle policy for an Office 365 group. A group lifecycle policy allows administrators to set an expiration period for groups. For example, after 180 days, a group expires. When a group reaches its expiration, owners of the group are required to renew their group within a time interval defined by the administrator. Once renewed, the group expiration is extended by the number of days defined in the policy. For example, the group's new expiration is 180 days after renewal. If the group is not renewed, it expires and is deleted. The group can be restored within a period of 30 days from deletion.

Methods

Method Return Type Description
Get groupLifecyclePolicy groupLifecyclePolicy Read properties and relationships of a groupLifecyclePolicy object.
List groupLifecyclePolicies groupLifecyclePolicy collection List all the groupLifecyclePolicies.
Update groupLifecyclePolicy groupLifecyclePolicy Update a groupLifecyclePolicy object.
Delete groupLifecyclePolicy None Delete a groupLifecyclePolicy object.
Add a group to a groupLifecyclePolicy None Add a group to a lifecycle policy
Remove a group from a groupLifecyclePolicy None Remove a group to a lifecycle policy.

Properties

Property Type Description
alternateNotificationEmails String List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon.
groupLifetimeInDays Int32 Number of days before a group expires and needs to be renewed. Once renewed, the group expiration is extended by the number of days defined.
id Guid A unique identifier for a policy. Read-only.
managedGroupTypes String The group type for which the expiration policy applies. Possible values are All, Selected or None.

Relationships

None.

JSON representation

Here is a JSON representation of the resource.

{
  "alternateNotificationEmails": "String",
  "groupLifetimeInDays": 180,
  "id": "Guid (identifier)",
  "managedGroupTypes": "String"
}