Get-RetentionPolicy

  • リファレンス
モジュール:
ExchangePowerShell
適用対象:
Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

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

アイテム保持ポリシーの設定を取得するには、Get-RetentionPolicy コマンドレットを使用します。

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

構文

Get-RetentionPolicy
   [[-Identity] <MailboxPolicyIdParameter>]
   [-DomainController <Fqdn>]
   [<CommonParameters>]

説明

アイテム保持ポリシーは、メールボックス内のアイテムに保存期間の設定を指定するアイテム保持ポリシー タグのグループに関連付けられています。 ポリシーには、アイテムをアーカイブ メールボックスに移動するための既定のポリシー タグが 1 つ、すべてのアイテムを削除するための既定のポリシー タグが 1 つ、ボイスメール アイテムを削除するための既定のポリシー タグが 1 つ、アイテムを移動または削除するための複数の個人用タグが含まれている場合があります。 メールボックスには、適用されるアイテム保持ポリシーが 1 つしかないこともあります。 Get-RetentionPolicy コマンドレットは、指定したポリシーに関連するすべてのポリシー設定を表示します。

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

例

例 1

Get-RetentionPolicy -Identity "RP Finance" | Format-List

この例は、アイテム保持ポリシー RP Finance のすべてのプロパティを返します。 出力を Format-List コマンドレットにパイプ処理して、プロパティ一覧として結果を書式設定します。

パラメーター

-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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Identity

Identity パラメーターは、ポリシー名を指定します。

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

入力

Input types

このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。

出力

Output types

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。