Edit

Share via

Invoke-ComplianceSecurityFilterAction

  • Reference
Module:
ExchangePowerShell
Applies to:
Security & Compliance

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Invoke-ComplianceSecurityFilterAction cmdlet to view and set compliance boundaries for Microsoft OneDrive sites in cloud-based organizations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Invoke-ComplianceSecurityFilterAction
      [-Action] <String>
      [[-EmailAddress] <String>]
      [-PropertyName] <String>
      [[-PropertyValue] <String>]
      [-SiteUrl] <String>
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

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.

To use this cmdlet in Security & Compliance PowerShell, you need to be a member of the Compliance Administrator role group. For more information, see Permissions in the Microsoft Purview compliance portal.

Examples

Example 1

PS C:\> Invoke-ComplianceSecurityFilterAction -Action GetStatus -PropertyName CustomAttribute1 -SiteUrl https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx

SiteUrlOrEmailAddress : https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx
BoundaryType          : UserMailbox
BoundaryInstruction   : Set via Set-Mailbox
BoundaryObjectId      : SPO_f82ace6e-817e-4752-8917-67164dabde98@SPO_775ea11f-a2af-7821-b04c-9848e903ce47
BoundaryStatus        : Success
BoundaryProperty      : CustomAttribute1
BoundaryPropertyValue :

This example returns the status of a OneDrive site to indicate it's associated to a user mailbox and the CustomAttribute1 property isn't currently set.

Example 2

PS C:\> Invoke-ComplianceSecurityFi1terAction Action GetStatus -PropertyName "CustomAttribute3" -EmailAddress "[email protected]"

SiteUrlOrEmailAddress : [email protected]
BoundaryType          : UserMailbox
BoundaryInstruction   : Set via Set-Mailbox
BoundaryObjectId      : [email protected]
BoundaryStatus        : Success
BoundaryProperty      : CustomAttribute3
BoundaryPropertyVa1ue :

This example returns the status of a mailbox to indicate the mailbox is inactive, and the CustomAttribute3 property isn't currently set.

Example 3

PS C:\> Invoke-ComplianceSecurityFi1terAction -Action GetStatus -PropertyName "CustomAttribute3" -EmailAddress "[email protected]"

SiteUrlOrEmailAddress : [email protected]
BoundaryType          : InactiveMailbox
BoundaryInstruction   : Set via Invoke-ComplianceSecurityFiIterAction -Set
BoundaryObjectId      : [email protected]
BoundaryStatus        : Success
BoundaryProperty      : CustomAttribute3
BoundaryPropertyVa1ue : test33

This example returns the status of a mailbox to indicate the mailbox is inactive, and the CustomAttribute3 property is currently set to test33.

Example 4

Invoke-ComplianceSecurityFilterAction -Action Set -PropertyName CustomAttribute1 -PropertyValue "Research and Development" -SiteUrl https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx

This example sets the boundary of the specified OneDrive site for a user who left the company.

Example 5

PS C:\> Invoke-ComplianceSecurityFiIterAction -Action Set -PropertyName "CustomAttribute3" -PropertyValue "ProjectX" -EmailAddress "[email protected]"

Set action succeeded, please use GetStatus to check the result.

PS C:\> Invoke-ComplianceSecurityFiIterAction -Action GetStatus -PropertyName "CustomAttribute3" -EmailAddress "[email protected]"

SiteUrlOrEmailAddress : [email protected]
BoundaryType          : InactiveMailbox
BoundaryInstruction   : Set via Invoke-ComplianceSecurityFiIterAction -Set
BoundaryObjectId      : [email protected]
BoundaryStatus        : Success
BoundaryProperty      : CustomAttribute3
BoundaryPropertyVa1ue : ProjectX

This example sets the boundary of the specified OneDrive site to the specified CustomAttribute3 property value, and runs another command to review the result.

Parameters

-Action

The Action parameter specifies the action for the command. Valid values are:

  • GetStatus
  • Set
Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Confirm

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.

  • 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.
  • 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.
Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-EmailAddress

The EmailAddress parameter specifies the the affected user mailbox. You can use the following values to uniquely identify the mailbox:

  • Name
  • Email address
  • Alias
  • ExchangeGUID

If the value contains spaces, enclose the value in quotation marks.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-PropertyName

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:

  • CustomAttribute1 to CustomAttribute15

Use the PropertyValue parameter to set the compliance boundary.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-PropertyValue

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 (").

Type:String
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-SiteUrl

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.

Type:String
Position:5
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-WhatIf

The WhatIf switch doesn't work in Security & Compliance PowerShell.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance