Get-SweepRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Get-SweepRule cmdlet to view Sweep rules in mailboxes. Sweep rules run a regular intervals to help keep your Inbox clean. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Get-SweepRule
   [[-Identity] <SweepRuleIdParameter>]
   [-BypassScopeCheck]
   [-DomainController <Fqdn>]
   [-Mailbox <MailboxIdParameter>]
   [-Provider <String>]
   [<CommonParameters>]

Description

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).

Examples

-------------------------- Example 1 --------------------------

Get-SweepRule

This example returns a summary list of all Sweep rules.

-------------------------- Example 2 --------------------------

Get-SweepRule -Mailbox julia@contoso.com

This example returns a summary list of all Sweep rules in the specified mailbox.

-------------------------- Example 3 --------------------------

Get-SweepRule -Identity "x2hlsdpGmUifjFgxxGIOJw=="

This example returns detailed information for the Sweep rule with the specified RuleId property value.

Optional Parameters

-BypassScopeCheck

The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Online, Exchange Online Protection
-DomainController

This parameter is available only in on-premises Exchange.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016
-Identity

The Identity parameter specifies the Sweep rule that you want to view. You can use any value that uniquely identifies the rule. For example:

  • RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==).

  • Exchange Online: <mailbox alias>\<RuleId> (for example, rzaher\x2hlsdpGmUifjFgxxGIOJw==.

  • On-premises Exchange: <mailbox canonical name>\<RuleId> (for example, contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==.

Type:SweepRuleIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Online, Exchange Online Protection
-Mailbox

The Mailbox parameter filters the results by the specified mailbox. You can use any value that uniquely identifies the mailbox.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

Type:MailboxIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Online, Exchange Online Protection
-Provider

The Provider parameter filters the results by the specified provider.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Online, Exchange Online Protection

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.