Skip to content

Commit e176cef

Browse files
garycentricgarycentric
authored
Merge branch 'main' into docs-editor/Get-TenantPrivateChannelMigrat-1776889306
2 parents 3223d0b + e86a849 commit e176cef

3 files changed

Lines changed: 191 additions & 0 deletions

File tree

‎exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1784,6 +1784,8 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line
17841784

17851785
### [Export-JournalRuleCollection](Export-JournalRuleCollection.md)
17861786

1787+
### [Export-PurviewConfig](Export-PurviewConfig.md)
1788+
17871789
### [Export-TransportRuleCollection](Export-TransportRuleCollection.md)
17881790

17891791
### [Get-AdministrativeUnit](Get-AdministrativeUnit.md)

‎exchange/exchange-ps/ExchangePowerShell/Export-PurviewConfig.md‎

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
---
2+
applicable: Security & Compliance
3+
external help file: Microsoft.Exchange.RemoteConnections-Help.xml
4+
Locale: en-US
5+
Module Name: ExchangePowerShell
6+
online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-purviewconfig
7+
schema: 2.0.0
8+
title: Export-PurviewConfig
9+
---
10+
11+
# Export-PurviewConfig
12+
13+
## SYNOPSIS
14+
This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell).
15+
16+
Use the Export-PurviewConfig cmdlet to export Microsoft Purview diagnostic configuration data for your organization. The exported data is returned as a compressed ZIP file (byte array) containing component-specific diagnostic information.
17+
18+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
19+
20+
## SYNTAX
21+
22+
```
23+
Export-PurviewConfig -Components <MultiValuedProperty>
24+
[-Confirm]
25+
[[-DomainController] <Fqdn>]
26+
[[-PolicyName <String>]]
27+
[[-UserPrincipalName <SmtpAddress>]]
28+
[-WhatIf]
29+
[<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
This cmdlet exports Purview diagnostic data for specified components in your organization. The data is returned as a ZIP archive (binary-encoded byte array) for each component. Each file contains the diagnostic configuration data for the component in a structured format.
34+
35+
The exported data is useful for troubleshooting and diagnostics of Purview configuration issues across DLP, MIP Labels, Classification, and Data Lifecycle Management.
36+
37+
You need to be assigned permissions in the Security & Compliance before you can use this cmdlet. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions).
38+
39+
## EXAMPLES
40+
41+
### Example 1
42+
```powershell
43+
Export-PurviewConfig -Components DLP
44+
```
45+
46+
This example exports diagnostic configuration data for the DLP component.
47+
48+
### Example 2
49+
```powershell
50+
$result = Export-PurviewConfig -Components DLP,MIPLabels
51+
52+
[IO.File]::WriteAllBytes("C:\DiagnosticExport.zip", $result)
53+
```
54+
55+
This example exports diagnostic data for the DLP and MIPLabels components and saves the resulting ZIP file to disk.
56+
57+
## PARAMETERS
58+
59+
### -Components
60+
61+
> Applicable: Security & Compliance
62+
63+
The Components parameter specifies which Purview components to export diagnostic data for. Valid values are:
64+
65+
- ClassificationAndTextExtraction
66+
- DLM
67+
- DLP
68+
- MIPLabels
69+
70+
You can specify multiple values separated by commas.
71+
72+
**Note**: If you specify an unsupported component value, a warning is logged and the component is skipped.
73+
74+
```yaml
75+
Type: MultiValuedProperty
76+
Parameter Sets: (All)
77+
Aliases:
78+
79+
Required: True
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### -Confirm
87+
88+
> Applicable: Security & Compliance
89+
90+
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
91+
92+
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
93+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
94+
95+
```yaml
96+
Type: SwitchParameter
97+
Parameter Sets: (All)
98+
Aliases: cf
99+
100+
Required: False
101+
Position: Named
102+
Default value: None
103+
Accept pipeline input: False
104+
Accept wildcard characters: False
105+
```
106+
107+
### -DomainController
108+
109+
> Applicable: Security & Compliance
110+
111+
This parameter is reserved for internal Microsoft use.
112+
113+
```yaml
114+
Type: Fqdn
115+
Parameter Sets: (All)
116+
Aliases:
117+
118+
Required: False
119+
Position: 1
120+
Default value: None
121+
Accept pipeline input: False
122+
Accept wildcard characters: False
123+
```
124+
125+
### -PolicyName
126+
127+
> Applicable: Security & Compliance
128+
129+
The PolicyName parameter specifies the name of the policy to scope the export to.
130+
131+
```yaml
132+
Type: String
133+
Parameter Sets: (All)
134+
Aliases:
135+
136+
Required: False
137+
Position: 2
138+
Default value: None
139+
Accept pipeline input: False
140+
Accept wildcard characters: False
141+
```
142+
143+
### -UserPrincipalName
144+
145+
> Applicable: Security & Compliance
146+
147+
The UserPrincipalName parameter specifies the user principal name (UPN) of the user to scope the export to.
148+
149+
```yaml
150+
Type: SmtpAddress
151+
Parameter Sets: (All)
152+
Aliases:
153+
154+
Required: False
155+
Position: 3
156+
Default value: None
157+
Accept pipeline input: False
158+
Accept wildcard characters: False
159+
```
160+
161+
### -WhatIf
162+
163+
> Applicable: Security & Compliance
164+
165+
The WhatIf switch doesn't work in Security & Compliance PowerShell.
166+
167+
```yaml
168+
Type: SwitchParameter
169+
Parameter Sets: (All)
170+
Aliases: wi
171+
172+
Required: False
173+
Position: Named
174+
Default value: None
175+
Accept pipeline input: False
176+
Accept wildcard characters: False
177+
```
178+
179+
### CommonParameters
180+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/p/?LinkID=113216).
181+
182+
## INPUTS
183+
184+
## OUTPUTS
185+
186+
## NOTES
187+
188+
## RELATED LINKS

‎exchange/mapping/serviceMapping.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -870,6 +870,7 @@
870870
"Enable-TransportRule": "policy-and-compliance",
871871
"Execute-AzureADLabelSync": "policy-and-compliance",
872872
"Export-JournalRuleCollection": "policy-and-compliance",
873+
"Export-PurviewConfig": "policy-and-compliance",
873874
"Export-TransportRuleCollection": "policy-and-compliance",
874875
"Get-AdministrativeUnit": "policy-and-compliance",
875876
"Get-AutoSensitivityLabelPolicy": "policy-and-compliance",

0 commit comments

Comments
 (0)