Set-RecordReviewNotificationTemplateConfig
This cmdlet is available only in the cloud-based service.
Use the Set-RecordReviewNotificationTemplateConfig cmdlet to set up the customized record review notification and reminder that's sent when an item requires review.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Default (Default)
Set-RecordReviewNotificationTemplateConfig
-IsCustomizedNotificationTemplate <Boolean>
-IsCustomizedReminderTemplate <Boolean>
[-CustomizedNotificationDataString <String>]
[-CustomizedReminderDataString <String>]
[<CommonParameters>]
Description
To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see Permissions in the Microsoft Purview compliance portal.
Examples
Example 1
Set-RecordReviewNotificationTemplateConfig -IsCustomizedNotificationTemplate $true -CustomizedNotificationDataString "This is the Contoso notification" -IsCustomizedReminderTemplate $true -CustomizedReminderDataString "This is the Contoso reminder"
This example configures customized review notification text and review reminder text.
Parameters
-CustomizedNotificationDataString
Applicable: Security & Compliance
The CustomizedNotificationDataString parameter specifies the customized review notification text to use. If the value contains spaces, enclose the value in quotation marks (").
The value of this parameter is meaningful only when the value of the IsCustomizedNotificationTemplate parameter is $true.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CustomizedReminderDataString
Applicable: Security & Compliance
The CustomizedReminderDataString parameter specifies the customized review reminder text to use. If the value contains spaces, enclose the value in quotation marks (").
The value of this parameter is meaningful only when the value of the IsCustomizedReminderTemplate parameter is $true.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IsCustomizedNotificationTemplate
Applicable: Security & Compliance
The IsCustomizedNotificationTemplate switch specifies whether to use a customized review notification instead of the system default notification. Valid values are:
- $true: Use a customized review notification. You specify the notification text using the CustomizedNotificationDataString parameter.
- $false: Use the default system notification. This value is the default.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IsCustomizedReminderTemplate
Applicable: Security & Compliance
The IsCustomizedReminderTemplate switch specifies whether to use a customized review reminder instead of the system default reminder:
- $true: Use a customized review reminder. You specify the reminder text using the CustomizedReminderDataString parameter.
- $false: Use the default system reminder. This value is the default.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
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.