Set-PnPListInformationRightsManagement
SYNOPSIS
Enables Information Rights Management (IRM) on the list.
SYNTAX
Set-PnPListInformationRightsManagement -List <ListPipeBind> [-Enable <Boolean>] [-EnableExpiration <Boolean>]
[-EnableRejection <Boolean>] [-AllowPrint <Boolean>] [-AllowScript <Boolean>] [-AllowWriteCopy <Boolean>]
[-DisableDocumentBrowserView <Boolean>] [-DocumentAccessExpireDays <Int32>]
[-DocumentLibraryProtectionExpireDate <DateTime>] [-EnableDocumentAccessExpire <Boolean>]
[-EnableDocumentBrowserPublishingView <Boolean>] [-EnableGroupProtection <Boolean>]
[-EnableLicenseCacheExpire <Boolean>] [-LicenseCacheExpireDays <Int32>] [-GroupName <String>]
[-PolicyDescription <String>] [-PolicyTitle <String>] [-TemplateId <String>]
[-Connection <PnPConnection>]
DESCRIPTION
This cmdlet enables Information Rights Management (IRM) on the list and updates the IRM settings.
EXAMPLES
EXAMPLE 1
Set-PnPListInformationRightsManagement -List "Documents" -Enable $true
Enables Information Rights Management (IRM) on the list.
EXAMPLE 2
Set-PnPListInformationRightsManagement -List "Documents" -Enable $true -EnableDocumentAccessExpire $true -DocumentAccessExpireDays 14
This example enables Information Rights Management (IRM) on the list and sets the document access to expire 14 days after the file has been downloaded.
PARAMETERS
-AllowPrint
Sets a value indicating whether the viewer can print the downloaded document.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AllowScript
Sets a value indicating whether the viewer can run a script on the downloaded document.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AllowWriteCopy
Sets a value indicating whether the viewer can write on a copy of the downloaded document.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisableDocumentBrowserView
Sets a value indicating whether to block Office Web Application Companion applications (WACs) from showing this document.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DocumentAccessExpireDays
Sets the number of days after which the downloaded document will expire.
Type: Int32
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DocumentLibraryProtectionExpireDate
Sets the date after which the Information Rights Management (IRM) protection of this document library will stop.
Type: DateTime
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Enable
Specifies whether Information Rights Management (IRM) is enabled for the list.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableDocumentAccessExpire
Sets a value indicating whether the downloaded document will expire.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableDocumentBrowserPublishingView
Sets a value indicating whether to enable Office Web Application Companion applications (WACs) to publishing view.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableExpiration
Specifies whether Information Rights Management (IRM) expiration is enabled for the list.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableGroupProtection
Sets a value indicating whether the permission of the downloaded document is applicable to a group.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableLicenseCacheExpire
Sets whether a user must verify their credentials after some interval.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableRejection
Specifies whether Information Rights Management (IRM) rejection is enabled for the list.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GroupName
Sets the group name (email address) that the permission is also applicable to.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LicenseCacheExpireDays
Sets the number of days that the application that opens the document caches the IRM license. When these elapse, the application will connect to the IRM server to validate the license.
Type: Int32
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-List
The list to set Information Rights Management (IRM) settings for.
Type: ListPipeBind
Parameter Sets: (All)
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PolicyDescription
Sets the permission policy description.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PolicyTitle
Sets the permission policy title.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TemplateId
Specifies the predefined IRM (Information Rights Management) template.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False