Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-MgGroupLifecyclePolicy
- Module:
- Microsoft.Graph.Groups Module
Creates a new groupLifecyclePolicy. Only one policy exists in the tenant.
Note
To view the beta release of this cmdlet, view New-MgBetaGroupLifecyclePolicy
Syntax
CreateExpanded (Default)
New-MgGroupLifecyclePolicy
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-AlternateNotificationEmails <string>]
[-GroupLifetimeInDays <int>]
[-Id <string>]
[-ManagedGroupTypes <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateExpanded1
New-MgGroupLifecyclePolicy
-GroupId <string>
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-AlternateNotificationEmails <string>]
[-GroupLifetimeInDays <int>]
[-Id <string>]
[-ManagedGroupTypes <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Create1
New-MgGroupLifecyclePolicy
-GroupId <string>
-BodyParameter <IMicrosoftGraphGroupLifecyclePolicy>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentityExpanded
New-MgGroupLifecyclePolicy
-InputObject <IGroupsIdentity>
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-AlternateNotificationEmails <string>]
[-GroupLifetimeInDays <int>]
[-Id <string>]
[-ManagedGroupTypes <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentity
New-MgGroupLifecyclePolicy
-InputObject <IGroupsIdentity>
-BodyParameter <IMicrosoftGraphGroupLifecyclePolicy>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Create
New-MgGroupLifecyclePolicy
-BodyParameter <IMicrosoftGraphGroupLifecyclePolicy>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Creates a new groupLifecyclePolicy. Only one policy exists in the tenant.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | Directory.ReadWrite.All, |
| Delegated (personal Microsoft account) | Not supported |
| Application | Directory.ReadWrite.All, |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Groups
$params = @{
groupLifetimeInDays = 100
managedGroupTypes = "Selected"
alternateNotificationEmails = "admin@contoso.com"
}
New-MgGroupLifecyclePolicy -BodyParameter $params
This example shows how to use the New-MgGroupLifecyclePolicy Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
| Type: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BodyParameter
groupLifecyclePolicy To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphGroupLifecyclePolicy |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Break
Wait for .NET debugger to attach
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-GroupId
The unique identifier of group
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | System.Int32 |
| Default value: | 0 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | System.Collections.IDictionary |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelineAppend
SendAsync Pipeline Steps to be appended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelinePrepend
SendAsync Pipeline Steps to be prepended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Id
The unique identifier for an entity. Read-only.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IGroupsIdentity |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ManagedGroupTypes
The group type for which the expiration policy applies. Possible values are All, Selected or None.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Proxy
The URI for the proxy server to use
Parameter properties
| Type: | System.Uri |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyCredential
Credentials for a proxy server to use for the remote call
Parameter properties
| Type: | System.Management.Automation.PSCredential |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyUseDefaultCredentials
Use the default credentials for the proxy
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
Parameter sets
-WhatIf
Runs the command in a mode that only reports what would happen without performing the actions.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Graph.PowerShell.Models.IGroupsIdentity
{{ Fill in the Description }}
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphGroupLifecyclePolicy
{{ Fill in the Description }}
System.Collections.IDictionary
{{ Fill in the Description }}
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphGroupLifecyclePolicy
{{ Fill in the Description }}
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
[ConversationId <String>]: The unique identifier of conversation
[ConversationThreadId <String>]: The unique identifier of conversationThread
[DirectoryObjectId <String>]: The unique identifier of directoryObject
[EndDateTime <String>]: Usage: endDateTime='{endDateTime}'
[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
[Interval <String>]: Usage: interval='{interval}'
[ListId <String>]: Usage: listId='{listId}'
[Path <String>]: Usage: path='{path}'
[PostId <String>]: The unique identifier of post
[ProfilePhotoId <String>]: The unique identifier of profilePhoto
[ResourceSpecificPermissionGrantId <String>]: The unique identifier of resourceSpecificPermissionGrant
[SiteId <String>]: The unique identifier of site
[StartDateTime <String>]: Usage: startDateTime='{startDateTime}'
[UniqueName <String>]: Alternate key of group