Skip to content

Commit 6849585

Browse files
author
cabailey
committed
initial draft
1 parent 8c436f3 commit 6849585

File tree

1 file changed

+159
-0
lines changed

1 file changed

+159
-0
lines changed

‎exchange/docs-conceptual/client-advanced-settings.md

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
---
2+
title: PowerShell advanced settings for Microsoft Purview Information Protection client
3+
ms.author: cabailey
4+
author: cabailey
5+
manager: aashishr
6+
ms.date: 04/15/2024
7+
ms.audience: Admin
8+
audience: Admin
9+
ms.topic: article
10+
ms.service: exchange-online
11+
ms.reviewer:
12+
ms.localizationpriority: high
13+
ms.collection:
14+
ms.custom:
15+
search.appverid:
16+
description: "Security & Compliance PowerShell advanced settings for Microsoft Purview Information Protection client."
17+
---
18+
19+
# Advanced settings for Microsoft Purview Information Protection client
20+
21+
This article contains the [Security & Compliance PowerShell](/powershell/exchange/office-365-scc/office-365-scc-powershell) advanced settings that are supported by [Microsoft Purview Information Protection client](/purview/information-protection-client) when you use the following cmdlets:
22+
23+
- [New-Label](/powershell/module/exchange/new-label) or [Set-Label](/powershell/module/exchange/set-label)
24+
- [New-LabelPolicy](/powershell/module/exchange/new-labelpolicy) or [Set-LabelPolicy](/powershell/module/exchange/set-labelpolicy).
25+
26+
The advanced settings that are supported by sensitivity labels that are built into Microsoft 365 apps and services are included with the cmdlet page itself.
27+
28+
You might also useful [PowerShell tips for specifying the advanced settings](/purview/create-sensitivity-labels#powershell-tips-for-specifying-the-advanced-settings).
29+
30+
**Advanced settings for sensitivity labels:**
31+
32+
Use the *AdvancedSettings* parameter with [New-Label](/powershell/module/exchange/policy-and-compliance/new-label) and [Set-Label](/powershell/module/exchange/policy-and-compliance/set-label).
33+
34+
|Setting|Scenario and instructions|
35+
|----------------|---------------|
36+
|**color**|[Specify a color for the label](#specify-a-color-for-the-label)|
37+
|**DefaultSubLabelId**|[Specify a default sublabel for a parent label](#specify-a-default-sublabel-for-a-parent-label)
38+
39+
**Advanced settings for sensitivity label policies:**
40+
41+
Use the *AdvancedSettings* parameter with [New-LabelPolicy](/powershell/module/exchange/policy-and-compliance/new-labelpolicy) and [Set-LabelPolicy](/powershell/module/exchange/policy-and-compliance/set-labelpolicy).
42+
43+
|Setting|Scenario and instructions|
44+
|----------------|---------------|
45+
|**AdditionalPPrefixExtensions**|[Support for changing \<EXT>.PFILE to P\<EXT>](#additionalpprefixextensions)
46+
|**EnableAudit**|[Prevent audit data from being sent to Microsoft Purview](#prevent-audit-data-from-being-sent-to-aip-and-microsoft-365-analytics)|
47+
|**EnableContainerSupport**|[Enable removal of encryption from PST, rar, 7zip, and MSG files](#enable-removal-of-protection-from-compressed-files)
48+
|**EnableCustomPermissions**|[Turn off custom permissions in File Explorer](#turn-off-custom-permissions-in-file-explorer)|
49+
|**EnableCustomPermissionsForCustomProtectedFiles**|[For files encrypted with custom permissions, always display custom permissions to users in File Explorer](#for-files-protected-with-custom-permissions-always-display-custom-permissions-to-users-in-file-explorer) |
50+
|**EnableGlobalization** |[Turn on classification globalization features](#turn-on-classification-globalization-features-public-preview) |
51+
|**EnableOutlookDistributionListExpansion** |[Expand Outlook distribution lists when searching for email recipients](#expand-outlook-distribution-lists-when-searching-for-email-recipients) |
52+
|**JustificationTextForUserText** | [Customize justification prompt texts for modified labels](#customize-justification-prompt-texts-for-modified-labels) |
53+
|??**LogMatchedContent**|[Send information type matches to Azure Information Protection analytics](#send-information-type-matches-to-azure-information-protection-analytics)|
54+
|**PFileSupportedExtensions**|[Change which file types to protect](#change-which-file-types-to-protect)|
55+
|**ReportAnIssueLink**|[Add "Report an Issue" for users](#add-report-an-issue-for-users)|
56+
|**ScannerMaxCPU** |[Limit CPU consumption](#limit-cpu-consumption) |
57+
|**ScannerMinCPU** |[Limit CPU consumption](#limit-cpu-consumption) |
58+
|**ScannerConcurrencyLevel**|[Limit the number of threads used by the scanner](#limit-the-number-of-threads-used-by-the-scanner)|
59+
|**ScannerFSAttributesToSkip** |[Skip or ignore files during scans depending on file attributes](#skip-or-ignore-files-during-scans-depending-on-file-attributes)
60+
|**SharepointWebRequestTimeout**|[Configure SharePoint timeouts](#configure-sharepoint-timeouts)|
61+
|**SharepointFileWebRequestTimeout**|[Configure SharePoint timeouts](#configure-sharepoint-timeouts)|
62+
|**UseCopyAndPreserveNTFSOwner** |[Preserve NTFS owners during labeling](#preserve-ntfs-owners-during-labeling-public-preview)
63+
64+
65+
## Color
66+
67+
Use this advanced setting to set a color for a label. To specify the color, enter a hex triplet code for the red, green, and blue (RGB) components of the color. For example, #40e0d0 is the RGB hex value for turquoise.
68+
69+
If you need a reference for these codes, you'll find a helpful table from the [\<color>](https://developer.mozilla.org/docs/Web/CSS/color_value) page from the MSDN web docs. You also find these codes in many applications that let you edit pictures. For example, Microsoft Paint lets you choose a custom color from a palette and the RGB values are automatically displayed, which you can then copy.
70+
71+
To configure the advanced setting for a label's color, enter the following strings for the selected label:
72+
73+
- Key: **color**
74+
75+
- Value: **\<RGB hex value>**
76+
77+
Example PowerShell command, where your label is named "Public":
78+
79+
```PowerShell
80+
Set-Label -Identity Public -AdvancedSettings @{color="#40e0d0"}
81+
```
82+
83+
## DefaultSubLabelId
84+
85+
When you add a sublabel to a label, users can no longer apply the parent label to a document or email. By default, users select the parent label to see the sublabels that they can apply, and then select one of those sublabels. If you configure this advanced setting, when users select the parent label, a sublabel is automatically selected and applied for them:
86+
87+
- Key: **DefaultSubLabelId**
88+
89+
- Value: **\<sublabel GUID>**
90+
91+
Example PowerShell command, where your parent label is named "Confidential" and the "All Employees" sublabel has a GUID of 8faca7b8-8d20-48a3-8ea2-0f96310a848e:
92+
93+
```PowerShell
94+
Set-Label -Identity "Confidential" -AdvancedSettings @{DefaultSubLabelId="8faca7b8-8d20-48a3-8ea2-0f96310a848e"}
95+
```
96+
97+
-----
98+
99+
## AdditionalPPrefixExtensions
100+
101+
This advanced property to change \<EXT>.PFILE to P\<EXT> is supported by File Explorer, PowerShell, and by the scanner. All apps have similar behavior.
102+
103+
- Key: **AdditionalPPrefixExtensions**
104+
105+
- Value: **\<string value>**
106+
107+
Use the following table to identify the string value to specify:
108+
109+
| String value| Client and Scanner|
110+
|-------------|---------------|
111+
|\*|All PFile extensions become P\<EXT>|
112+
|\<null value>| Default value behaves like the default protection value.|
113+
|ConvertTo-Json(".dwg", ".zip")|In addition to the previous list, ".dwg" and ".zip" become P\<EXT>|
114+
115+
With this setting, the following extensions always become **P\<EXT>**: ".txt", ".xml", ".bmp", ".jt", ".jpg", ".jpeg", ".jpe", ".jif", ".jfif", ".jfi", ".png", ".tif", ".tiff", ".gif"). Notable exclusion is that "ptxt" does not become "txt.pfile".
116+
117+
**AdditionalPPrefixExtensions** only works if protection of PFiles with the advanced property - [**PFileSupportedExtension**](#pfilesupportedextension) is enabled.
118+
119+
**Example 1**: PowerShell command to behave like the default behavior where Protect ".dwg" becomes ".dwg.pfile":
120+
121+
```PowerShell
122+
Set-LabelPolicy -AdvancedSettings @{ AdditionalPPrefixExtensions =""}
123+
```
124+
125+
**Example 2**: PowerShell command to change all PFile extensions from generic encryption (dwg.pfile) to native encryption (.pdwg) when the files are protected:
126+
127+
```PowerShell
128+
Set-LabelPolicy -AdvancedSettings @{ AdditionalPPrefixExtensions ="*"}
129+
```
130+
131+
**Example 3**: PowerShell command to change ".dwg" to ".pdwg" when using this service protect this file:
132+
133+
```PowerShell
134+
Set-LabelPolicy -AdvancedSettings @{ AdditionalPPrefixExtensions =ConvertTo-Json(".dwg")}
135+
```
136+
137+
## EnableAudit
138+
139+
By default, the information protection clients sends audit data to Microsoft Purview where you can view this data in [activity explorer](/purview/data-classification-activity-explorer).
140+
141+
To change this behavior, use the following advanced setting:
142+
143+
- Key: **EnableAudit**
144+
145+
- Value: **False**
146+
147+
For example, if your label policy is named "Global":
148+
149+
```PowerShell
150+
Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableAudit="False"}
151+
```
152+
153+
Then on local computers that run the information protection client, delete the following folder: **%localappdata%\Microsoft\MSIP\mip**
154+
155+
To enable the client to send audit log data again, change the advanced setting value to **True**. You do not need to manually create the **%localappdata%\Microsoft\MSIP\mip** folder again on your client computers.
156+
157+
158+
159+

0 commit comments

Comments
 (0)