Update-MgGroupLifecyclePolicy
Update the properties of a groupLifecyclePolicygroupLifecyclePolicy resource type object.
Note
To view the beta release of this cmdlet, view Update-MgBetaGroupLifecyclePolicy
Syntax
Update-MgGroupLifecyclePolicy
-GroupLifecyclePolicyId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AlternateNotificationEmails <String>]
[-GroupLifetimeInDays <Int32>]
[-Id <String>]
[-ManagedGroupTypes <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgGroupLifecyclePolicy
-GroupLifecyclePolicyId <String>
-GroupId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AlternateNotificationEmails <String>]
[-GroupLifetimeInDays <Int32>]
[-Id <String>]
[-ManagedGroupTypes <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgGroupLifecyclePolicy
-GroupLifecyclePolicyId <String>
-GroupId <String>
-BodyParameter <IMicrosoftGraphGroupLifecyclePolicy>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgGroupLifecyclePolicy
-GroupLifecyclePolicyId <String>
-BodyParameter <IMicrosoftGraphGroupLifecyclePolicy>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgGroupLifecyclePolicy
-InputObject <IGroupsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AlternateNotificationEmails <String>]
[-GroupLifetimeInDays <Int32>]
[-Id <String>]
[-ManagedGroupTypes <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgGroupLifecyclePolicy
-InputObject <IGroupsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AlternateNotificationEmails <String>]
[-GroupLifetimeInDays <Int32>]
[-Id <String>]
[-ManagedGroupTypes <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgGroupLifecyclePolicy
-InputObject <IGroupsIdentity>
-BodyParameter <IMicrosoftGraphGroupLifecyclePolicy>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgGroupLifecyclePolicy
-InputObject <IGroupsIdentity>
-BodyParameter <IMicrosoftGraphGroupLifecyclePolicy>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update the properties of a groupLifecyclePolicygroupLifecyclePolicy resource type object.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Directory.ReadWrite.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Directory.ReadWrite.All | Not available. |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Groups
$params = @{
groupLifetimeInDays = 180
managedGroupTypes = "Selected"
alternateNotificationEmails = "admin@contoso.com"
}
Update-MgGroupLifecyclePolicy -GroupLifecyclePolicyId $groupLifecyclePolicyId -BodyParameter $params
This example shows how to use the Update-MgGroupLifecyclePolicy Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AlternateNotificationEmails
List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
groupLifecyclePolicy To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphGroupLifecyclePolicy |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GroupId
The unique identifier of group
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GroupLifecyclePolicyId
The unique identifier of groupLifecyclePolicy
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GroupLifetimeInDays
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.
Type: | Int32 |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
Type: | IDictionary |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IGroupsIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ManagedGroupTypes
The group type for which the expiration policy applies. Possible values are All, Selected or None.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
Type: | ActionPreference |
Aliases: | proga |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Type: | String |
Aliases: | RHV |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IGroupsIdentity
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphGroupLifecyclePolicy
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphGroupLifecyclePolicy
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
BODYPARAMETER <IMicrosoftGraphGroupLifecyclePolicy>
: groupLifecyclePolicy
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[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.[ManagedGroupTypes <String>]
: The group type for which the expiration policy applies. Possible values are All, Selected or None.
INPUTOBJECT <IGroupsIdentity>
: Identity Parameter
[AttachmentId <String>]
: The unique identifier of attachment[BaseSitePageId <String>]
: The unique identifier of baseSitePage[ContentTypeId <String>]
: The unique identifier of contentType[ConversationId <String>]
: The unique identifier of conversation[ConversationThreadId <String>]
: The unique identifier of conversationThread[DirectoryObjectId <String>]
: The unique identifier of directoryObject[DocumentSetVersionId <String>]
: The unique identifier of documentSetVersion[DriveId <String>]
: The unique identifier of drive[DriveItemId <String>]
: The unique identifier of driveItem[DriveItemVersionId <String>]
: The unique identifier of driveItemVersion[EndDateTime <String>]
: Usage: endDateTime='{endDateTime}'[EventId <String>]
: The unique identifier of event[ExtensionId <String>]
: The unique identifier of extension[GroupId <String>]
: The unique identifier of group[GroupLifecyclePolicyId <String>]
: The unique identifier of groupLifecyclePolicy[GroupSettingId <String>]
: The unique identifier of groupSetting[GroupSettingTemplateId <String>]
: The unique identifier of groupSettingTemplate[HorizontalSectionColumnId <String>]
: The unique identifier of horizontalSectionColumn[HorizontalSectionId <String>]
: The unique identifier of horizontalSection[IncludePersonalNotebooks <Boolean?>]
: Usage: includePersonalNotebooks={includePersonalNotebooks}[Interval <String>]
: Usage: interval='{interval}'[ListId <String>]
: The unique identifier of list[ListItemId <String>]
: The unique identifier of listItem[ListItemVersionId <String>]
: The unique identifier of listItemVersion[NotebookId <String>]
: The unique identifier of notebook[OnenotePageId <String>]
: The unique identifier of onenotePage[OnenoteSectionId <String>]
: The unique identifier of onenoteSection[Path <String>]
: Usage: path='{path}'[PermissionId <String>]
: The unique identifier of permission[PostId <String>]
: The unique identifier of post[ProfilePhotoId <String>]
: The unique identifier of profilePhoto[Q <String>]
: Usage: q='{q}'[ResourceSpecificPermissionGrantId <String>]
: The unique identifier of resourceSpecificPermissionGrant[SiteId <String>]
: The unique identifier of site[StartDateTime <String>]
: Usage: startDateTime='{startDateTime}'[SubscriptionId <String>]
: The unique identifier of subscription[Token <String>]
: Usage: token='{token}'[UniqueName <String>]
: Alternate key of group[User <String>]
: Usage: User='{User}'[WebPartId <String>]
: The unique identifier of webPart