Set-SweepRule

モジュール:

ExchangePowerShell

適用対象:

Exchange Server 2016, Exchange Server 2019, Exchange Online

このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。

Set-SweepRule コマンドレットを使用して、メールボックスのスイープ ルールを変更します。

以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

Set-SweepRule
   [-Identity] <SweepRuleIdParameter>
   [-Confirm]
   [-DestinationFolder <MailboxFolderIdParameter>]
   [-DomainController <Fqdn>]
   [-Enabled <Boolean>]
   [-ExceptIfFlagged <Boolean>]
   [-ExceptIfPinned <Boolean>]
   [-KeepForDays <Int32>]
   [-KeepLatest <Int32>]
   [-Mailbox <MailboxIdParameter>]
   [-Name <String>]
   [-Provider <String>]
   [-Sender <RecipientIdParameter>]
   [-SourceFolder <MailboxFolderIdParameter>]
   [-SystemCategory <SystemCategoryType>]
   [-WhatIf]
   [<CommonParameters>]

説明

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。

例

例 1

Set-SweepRule -Identity x2hlsdpGmUifjFgxxGIOJw== -KeepForDays 15 -ExceptIfPinned $true

次の使用例は、ルール ID 値 x2hlsdpGmUifjFgxxGIOJw== を指定した値で持つ既存のルールを変更します。

パラメーター

-Confirm

Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。

• 破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文-Confirm:$falseを使用して、確認プロンプトを省略できます。
• 他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, Exchange Online

-DestinationFolder

DestinationFolder パラメーターは、指定したフォルダーにメッセージを移動するスイープ ルールのアクションを指定します。 構文は MailboxID:\ParentFolder[\SubFolder] です。

の MailboxID値には、メールボックスを一意に識別する任意の値を使用できます。 例:

• 名前
• Alias
• 識別名 (DN)
• 正規 DN
• Domain\Username
• 電子メール アドレス
• GUID
• LegacyExchangeDN
• SamAccountName
• ユーザー ID またはユーザー プリンシパル名 (UPN)

このパラメーターの値の例は、 john@contoso.com:\Unimportant または です John:\Inbox\Misc。 既定値は MailboxID:\Deleted Items です。

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

-DomainController

このパラメーターは、オンプレミスの Exchange でのみ使用できます。

DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-Enabled

このパラメーターは、Microsoft の内部使用のために予約されています。

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

-ExceptIfFlagged

ExceptIfFlagged パラメーターは、メッセージ フラグが適用されたメッセージを検索するスイープ ルールの例外を指定します。 有効な値は次のとおりです。

• $true: ルール アクションは、メッセージ フラグが適用されたメッセージには適用されません。
• $false: 例外は使用されません。

一般的なメッセージ フラグの値は次のとおりです。

• 任意
• コール
• DoNotForward
• フォロー アップ
• ForYourInformation
• 転送
• NoResponseNecessary
• 読み取り
• 返信
• ReplyToAll
• レビュー

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

-ExceptIfPinned

PinMessage パラメーターは、ピン留めされたメッセージを検索するスイープ ルールの例外を指定します。 有効な値は次のとおりです。

• $true: ルール アクションは、受信トレイの上部にピン留めされたメッセージには適用されません。
• $false: 例外は使用されません。

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

-Identity

Identity パラメーターは、変更するスイープ ルールを指定します。 ルールを一意に識別する任意の値を使用できます。 次に例を示します。

• RuleId プロパティ (例: x2hlsdpGmUifjFgxxGIOJw==)。
• Exchange Online: MailboxAlias\RuleID (例: rzaher\2hlsdpGmUifjFgxxGIOJw==)。
• オンプレミス Exchange: MailboxCanonicalName\RuleID (例: contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==)。

Get-SweepRule コマンドレットを使用して、これらの ID 値を取得することができます。

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

-KeepForDays

KeepForDays パラメーターは、ルールの条件に一致するメッセージを保持する日数を指定するスイープ ルールのアクションを指定します。 その日数が経過した後、メッセージは DestinationFolder パラメーターで指定されている場所 (既定では削除済みアイテム フォルダー) に移動されます。

このパラメーターを KeepLatest パラメーターと共に使用することはできません。また、スイープ ルールは、KeepForDays または KeepLatest パラメーター値を含んでいる必要があります。

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

-KeepLatest

KeepLatest パラメーターは、ルールの条件に一致するメッセージの数を指定するスイープ ルールのアクションを指定します。 メッセージがその数を超えたとき、最も古いメッセージは DestinationFolder パラメーターで指定されている場所 (既定では削除済みアイテム フォルダー) に移動されます。

このパラメーターを KeepForDays パラメーターと共に使用することはできません。また、スイープ ルールは、KeepForDays または KeepLatest パラメーター値を含んでいる必要があります。

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

-Mailbox

Mailbox パラメーターは、変更するルールを含むメールボックスを指定します。 メールボックスを一意に識別する任意の値を使用できます。 次に例を示します。

• 名前
• Alias
• 識別名 (DN)
• 正規 DN
• Domain\Username
• 電子メール アドレス
• GUID
• LegacyExchangeDN
• SamAccountName
• ユーザー ID またはユーザー プリンシパル名 (UPN)

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

-Name

Name パラメーターは、スイープ ルールの名前を指定します。 値にスペースが含まれている場合は、値を引用符で囲んでください。

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

-Provider

Provider パラメーターは、スイープ ルールのプロバイダーを指定します。 値にスペースが含まれている場合は、値を引用符で囲んでください。

Outlook on the webで作成するスイープ ルールの場合、既定値は Exchange16 です。

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

-Sender

Sender パラメーターは、メッセージで指定された送信者を検索するスイープ ルールの条件を指定します。 内部送信者の場合、その送信者を一意に識別する任意の値を使用できます。 例:

• 名前
• Alias
• 識別名 (DN)
• 正規 DN
• 電子メール アドレス
• GUID

外部送信者の場合は、各自のメール アドレスを使用します。

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

-SourceFolder

SourceFolder パラメーターは、指定したフォルダー内のメッセージを検索するスイープ ルールの条件を指定します。 構文は MailboxID:\ParentFolder[\SubFolder] です。

の MailboxID値には、メールボックスを一意に識別する任意の値を使用できます。 例:

• 名前
• Alias
• 識別名 (DN)
• 正規 DN
• Domain\Username
• 電子メール アドレス
• GUID
• LegacyExchangeDN
• SamAccountName
• ユーザー ID またはユーザー プリンシパル名 (UPN)

このパラメーターの値の例は、 john@contoso.com:\Marketing または です John:\Inbox\Reports。 既定値は MailboxID:\Inbox です。

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

-SystemCategory

SystemCategory パラメーターは、指定されたシステム カテゴリを持つメッセージを検索するスイープ ルールの条件を指定します。 システム カテゴリは、組織内のすべてのメールボックスで使用できます。 有効な値は次のとおりです。

• NotDefined
• 法案
• ドキュメント
• DocumentPlus
• イベント
• ファミリー
• File
• 飛行
• FromContact
• 重要
• ライブビュー
• 宿泊
• MailingList
• ニュースレター
• Photo
• 購入
• RentalCar
• RestaurantReservation
• RetiredPromotion
• ShippingNotification
• ショッピング
• SocialUpdate
• 旅行
• ビデオ

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

-WhatIf

WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, Exchange Online