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 Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットに与える影響は、コマンドレットが続行する前に確認を必要とするかどうかによって異なります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値を指定せずに Confirm スイッチを指定すると、一時停止が発生し、続行する前にコマンドの確認を強制されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | Cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DomainController
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
このパラメーターは、オンプレミスの 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 Server SE、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 Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス
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 Server SE、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 Server SE、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 Server SE、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 Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス
[WhatIf] スイッチは、何も変更を加えずにコマンドが実行する内容を表示します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | wi |
パラメーター セット
(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
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。