Skip to content

Commit 3e3ccc9

Browse files
chrisdachrisda
committed
Invoke-ComplianceSecurityFilterAction
1 parent b8b70db commit 3e3ccc9

File tree

3 files changed

+176
-0
lines changed

3 files changed

+176
-0
lines changed

‎exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
---
2+
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3+
online version: https://learn.microsoft.com/powershell/module/exchange/invoke-compliancesecurityfilteraction
4+
applicable: Security & Compliance
5+
title: Invoke-ComplianceSecurityFilterAction
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Invoke-ComplianceSecurityFilterAction
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell).
16+
17+
Use the Invoke-ComplianceSecurityFilterAction cmdlet to view and set compliance boundaries for Microsoft OneDrive sites in cloud-based organizations.
18+
19+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
20+
21+
## SYNTAX
22+
23+
```
24+
Invoke-ComplianceSecurityFilterAction [-Action] <String> [-PropertyName] <String> [[-PropertyValue] <String>] [-SiteUrl] <String>
25+
[-Confirm]
26+
[-WhatIf]
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
This cmdlet is useful in scenarios where the OneDrive site has fallen out of the compliance boundary due to a departed user and a corresponding inactive mailbox.
32+
33+
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](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions).
34+
35+
## EXAMPLES
36+
37+
### Example 1
38+
```powershell
39+
Invoke-ComplianceSecurityFilterAction -Action GetStatus -PropertyName Department -SiteUrl https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx
40+
```
41+
42+
This example returns the status of a OneDrive site that's bound by the Department property on the user's mailbox.
43+
44+
### Example 2
45+
```powershell
46+
Invoke-ComplianceSecurityFilterAction -Action Set -PropertyName Department -PropertyValue "Research and Development" -SiteUrl https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx
47+
```
48+
49+
This example sets the boundary of the specified OneDrive site for a user who left the company.
50+
51+
## PARAMETERS
52+
53+
### -Action
54+
The Action parameter specifies the action for the command. Valid values are:
55+
56+
- GetStatus
57+
- Set
58+
59+
```yaml
60+
Type: String
61+
Parameter Sets: (All)
62+
Aliases:
63+
Applicable: Security & Compliance
64+
65+
Required: True
66+
Position: 1
67+
Default value: None
68+
Accept pipeline input: False
69+
Accept wildcard characters: False
70+
```
71+
72+
### -PropertyName
73+
The PropertyName parameter specifies the name of the property of the compliance boundary for the OneDrive site that you want to view or modify. Valid values are:
74+
75+
- Alias
76+
- Company
77+
- CountryOrRegion
78+
- CustomAttribute1 to CustomAttribute15
79+
- Department
80+
- PostalCode
81+
82+
Use the PropertyValue parameter to set the compliance boundary.
83+
84+
```yaml
85+
Type: String
86+
Parameter Sets: (All)
87+
Aliases:
88+
Applicable: Security & Compliance
89+
90+
Required: True
91+
Position: 2
92+
Default value: None
93+
Accept pipeline input: False
94+
Accept wildcard characters: False
95+
```
96+
97+
### -PropertyValue
98+
The PropertyValue parameter specifies the value of the PropertyName value when you use the Action parameter value Set to set the compliance boundary of a OneDrive site. If the value contains spaces, enclose the value in quotation marks (").
99+
100+
```yaml
101+
Type: String
102+
Parameter Sets: (All)
103+
Aliases:
104+
Applicable: Security & Compliance
105+
106+
Required: False
107+
Position: 3
108+
Default value: None
109+
Accept pipeline input: False
110+
Accept wildcard characters: False
111+
```
112+
113+
### -SiteUrl
114+
The SiteUrl parameter specifies the OneDrive site that you want to view or modify. This parameter uses the syntax `https://<domain>-my.sharepoint.com/personal/<user>_<domain>_onmicrosoft_com/_layouts/15/onedrive.aspx`. For example: `https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx`.
115+
116+
```yaml
117+
Type: String
118+
Parameter Sets: (All)
119+
Aliases:
120+
Applicable: Security & Compliance
121+
122+
Required: True
123+
Position: 4
124+
Default value: None
125+
Accept pipeline input: False
126+
Accept wildcard characters: False
127+
```
128+
129+
### -Confirm
130+
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.
131+
132+
- 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`.
133+
- 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.
134+
135+
```yaml
136+
Type: SwitchParameter
137+
Parameter Sets: (All)
138+
Aliases: cf
139+
Applicable: Security & Compliance
140+
141+
Required: False
142+
Position: Named
143+
Default value: None
144+
Accept pipeline input: False
145+
Accept wildcard characters: False
146+
```
147+
148+
### -WhatIf
149+
The WhatIf switch doesn't work in Security & Compliance PowerShell.
150+
151+
```yaml
152+
Type: SwitchParameter
153+
Parameter Sets: (All)
154+
Aliases: wi
155+
Applicable: Security & Compliance
156+
157+
Required: False
158+
Position: Named
159+
Default value: None
160+
Accept pipeline input: False
161+
Accept wildcard characters: False
162+
```
163+
164+
### CommonParameters
165+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
166+
167+
## INPUTS
168+
169+
## OUTPUTS
170+
171+
## NOTES
172+
173+
## RELATED LINKS

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1777,6 +1777,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow
17771777

17781778
### [Install-UnifiedCompliancePrerequisite](Install-UnifiedCompliancePrerequisite.md)
17791779

1780+
### [Invoke-ComplianceSecurityFilterAction](Invoke-ComplianceSecurityFilterAction.md)
1781+
17801782
### [New-ActivityAlert](New-ActivityAlert.md)
17811783

17821784
### [New-AutoSensitivityLabelPolicy](New-AutoSensitivityLabelPolicy.md)

‎exchange/mapping/serviceMapping.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -871,6 +871,7 @@
871871
"Import-JournalRuleCollection": "policy-and-compliance",
872872
"Import-TransportRuleCollection": "policy-and-compliance",
873873
"Install-UnifiedCompliancePrerequisite": "policy-and-compliance",
874+
"Invoke-ComplianceSecurityFilterAction": "policy-and-compliance",
874875
"New-ActivityAlert": "policy-and-compliance",
875876
"New-AutoSensitivityLabelPolicy": "policy-and-compliance",
876877
"New-AutoSensitivityLabelRule": "policy-and-compliance",

0 commit comments

Comments
 (0)