DLMRetentionPackage.PowershellGalleryModule

Author(s)

• FastTrack In-Product Experiences Team

Tags

DLM Retention RecordsManagement

Cmdlets

Initialize-DLMRetentionPackage

Dependencies

• • ExchangeOnlineManagement (= 3.4.0)

Release Notes

## DLM Retention Package Details and Instructions

This utility allows a Microsoft Purview compliance administrator the ability to create custom retention labels and policies. These custom retention labels and policies will be based on your E3 or E5 licensing. Based on licensing the following packages below are available and optionally include the following components:

   E3 licensing provides three custom retention labels and policies to choose from
      E3DLMRetentionConfig.json
   
   E5 licensing provides four custom retention labels and policies to choose from
      E5DLMRetentionConfig.json

1. Open and run PowerShell as an administrator. Make sure you're running a minimum version of PowerShell (5.1) or the latest version of PowerShell (7.0.3 or later). Refer to [latest versions supported]  (https://learn.microsoft.com/en-us/powershell/exchange/exchange-online-powershell-v2?view=exchange-ps#install-and-maintain-the-exchange-online-powershell-module).

2. To install this package into PowerShell.  Copy and paste the following command and hit enter.

   Install-Module -Name DLMRetentionPackage.PowershellGalleryModule -Force

3. Next, copy the following command and hit enter

   Initialize-DLMRetentionPackage

4. You will be prompted for your tenant ID and password.

   If the user does not have the required scope, a permission request window will appear. Kindly provide permission and accept it. Please be aware that in certain situations you might need to obtain an administrator's permission before giving the consent.

5. You will then be asked to select the JSON File for creating DLM Policies.

   Download and Select either the E3 (E3DLMRetentionConfig.json) or E5 (E5DLMRetentionConfig.json) JSON file from the FileList section below.

6. You will then be asked to enter a Prefix for the records or hit enter to use the default. Records will be created with a default prefix of "Org-wide". You have the option to customize this prefix for different target groups, using other prefixes like "Finance sites" or "US users". Once the records are created, the policies and labels cannot be renamed.

7. Once the records have been created, you will be presented with a prompt screen with links to the records just created.  

8. Close the prompt screen to close the PowerShell program. Done.