Set-RetentionPolicy
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターと設定は、1 つの環境または他の環境に限定される場合があります。
Set-RetentionPolicy コマンドレットを使用して、既存のアイテム保持ポリシーのプロパティを変更します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Default (既定)
Set-RetentionPolicy
[-Identity] <MailboxPolicyIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-IsDefault]
[-IsDefaultArbitrationMailbox]
[-Name <String>]
[-RetentionId <Guid>]
[-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>]
[-WhatIf]
[<CommonParameters>]
説明
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Set-RetentionPolicy "MyPolicy" -RetentionPolicyTagLinks "MyRetentionPolicyTag"
この例は、MyPolicy というポリシーを変更し、そのポリシーにアイテム保持ポリシー タグ MyRetentionPolicyTag をリンクします。
Identity パラメーターは位置パラメーターです。 位置パラメーターはラベル (Identity) なしで使用できます。 位置指定パラメーターの詳細については、「パラメーター について」を参照してください。
パラメーター
-Confirm
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DomainController
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
パラメーターのプロパティ
| 型: | Fqdn |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online
[強制] スイッチは、警告メッセージまたは確認メッセージを非表示にします。 このスイッチで値を指定する必要はありません。
RetentionId パラメーターを使用するときに確認プロンプトを非表示にするには、このスイッチを使用します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection
Identity パラメーターは、アイテム保持ポリシーの名前、識別名 (DN)、または GUID を指定します。
パラメーターのプロパティ
| 型: | MailboxPolicyIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-IsDefault
適用対象: Exchange Online
このパラメーターは、クラウドベースのサービスでのみ使用できます。
IsDefault スイッチは、このアイテム保持ポリシーが既定のアイテム保持ポリシーであることを指定します。 このスイッチで値を指定する必要はありません。
このスイッチを使用すると、現在の既定のアイテム保持ポリシー (IsDefault プロパティ値が現在 True のポリシー) が既定のアイテム保持ポリシーに置き換えられるという警告が表示されます。 既定では、既定のアイテム保持ポリシーの名前は既定の MRM ポリシーです。
注: 既定のアイテム保持ポリシーを変更すると、すべてのメールボックス プランの RetentionPolicy パラメーターの値に基づいて、新しいメールボックスと既存のメールボックスに影響を与える場合と影響しない場合があります。
- $null (空白): 保持ポリシーが既定値である変更は、新規および既存のメールボックスに継続的に反映されます。
- アイテム保持ポリシーが指定されている: すべてのメールボックス プランの RetentionPolicy パラメーターの値は、$null (空白) であるか、organizationの既定のポリシーとして構成されている Exchange アイテム保持ポリシーと一致する必要があります。 そうしないと、新しいメールボックスの作成、無効なメールボックスの有効化、ライセンスの変更時にエクスペリエンスに一貫性がない可能性があります。 詳細については、「Exchange Onlineのメールボックス プラン」を参照してください。
メールボックスに既定のポリシーではない Exchange アイテム保持ポリシーが割り当てられている場合、ライセンスの変更時にメールボックスの RetentionPolicy 値が上書きされます。 RetentionPolicy を元の値に手動でリセットする必要があります。
既存のメールボックスに影響を与える既定のアイテム保持ポリシーを変更すると、更新が必要なメールボックスが数百または数千ある場合、ネットワークが飽和する可能性があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IsDefaultArbitrationMailbox
適用対象: Exchange Online
このパラメーターは、クラウドベースのサービスでのみ使用できます。
IsDefaultArbitrationMailbox スイッチは、このポリシーを、Exchange Online organization内の調停メールボックスの既定のアイテム保持ポリシーとして構成します。 このスイッチで値を指定する必要はありません。
このパラメーターは社内展開には使用できません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online
Name パラメーターは、アイテム保持ポリシーの一意の名前を指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RetentionId
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online
RetentionId パラメーターは、2 つの Exchange 組織間で移動されたメールボックスが引き続き同じアイテム保持ポリシーが適用されるように、アイテム保持ポリシーの ID を指定します。 たとえば、フォレスト間展開やクロスプレミス展開では、メールボックスをオンプレミスの Exchange サーバーからクラウドに移動したり、クラウドベースのメールボックスをオンプレミスの Exchange サーバーに移動したりすると、このパラメーターを使用して、同じアイテム保持ポリシーがメールボックスに適用されるようにします。
通常は、保持タグの RetentionId パラメーターを指定または変更する必要はありません。 このパラメーターは、Import-RetentionTags.ps1 スクリプトを使用して保持タグをインポートする際に自動的に設定されます。
パラメーターのプロパティ
| 型: | Guid |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RetentionPolicyTagLinks
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online
RetentionPolicyTagLinks パラメーターは、アイテム保持ポリシーに関連付けるアイテム保持ポリシー タグの ID を指定します。 アイテム保持ポリシーが適用されたメールボックスでは、そのアイテム保持ポリシーにアイテム保持タグがリンクされています。
パラメーターのプロパティ
| 型: | RetentionPolicyTagIdParameter[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。