Get-RetentionPolicyTag

リファレンス

モジュール:: ExchangePowerShell

適用対象:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

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

保持タグの設定を取得するには、Get-RetentionPolicyTag コマンドレットを使用します。

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

構文

Get-RetentionPolicyTag
   [[-Identity] <RetentionPolicyTagIdParameter>]
   [-DomainController <Fqdn>]
   [-IncludeSystemTags]
   [-Types <ElcFolderType[]>]
   [<CommonParameters>]

Get-RetentionPolicyTag
   [-Mailbox <MailboxIdParameter>]
   [-OptionalInMailbox]
   [-DomainController <Fqdn>]
   [-IncludeSystemTags]
   [-Types <ElcFolderType[]>]
   [<CommonParameters>]

説明

保持タグは、メッセージまたはフォルダーにメッセージ保持設定を適用するために使用します。保持タグには次の 3 種類があります。

保持ポリシータグ
既定ポリシータグ
個人タグ

保持ポリシータグは、受信トレイおよび削除済みアイテムなどの既定フォルダーに適用されます。個人タグは、ユーザーがアイテムおよびフォルダーにタグを設定できます。既定ポリシータグは、ユーザーによってタグが適用されないか、アイテムが存在するフォルダーから継承されないすべてのアイテムに適用されます。 Get-RetentionPolicyTag コマンドレットにより、指定タグのすべての設定が表示されます。

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

例

例 1

Get-RetentionPolicyTag

この例では、すべての保持タグを返します。

例 2

Get-RetentionPolicyTag -IncludeSystemTags

この例は、個人タグと既定タグに加えてシステムタグを返します。

例 3

Get-RetentionPolicyTag "Consolidated Messenger"

この例は、タグ Consolidated Messenger の設定を返します。

例 4

Get-RetentionPolicyTag -Types Inbox,All | Format-Table Name,Type,RetentionEnabled,AgeLimitForRetention,RetentionAction -AutoSize

次の使用例は、受信トレイのすべての保持タグとすべての型を返し、結果を Format-Table コマンドにパイプして、Name、Type、RetentionEnabled、AgeLimitForRetention、RetentionAction の各プロパティを表示します。

パラメーター

-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:	RetentionPolicyTagIdParameter
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

-IncludeSystemTags

IncludeSystemTags スイッチは、システムタグを返すかどうかを指定します。このスイッチで値を指定する必要はありません。

Type:	SwitchParameter
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, Exchange Online

-Mailbox

Mailbox パラメーターは、指定したメールボックスに適用されるアイテム保持ポリシーに割り当てられている保持タグを返します。メールボックスを一意に識別する任意の値を使用できます。次に例を示します。

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

このパラメーターは、既定のポリシータグ (DBT) と個人用タグのみを返します。アイテム保持ポリシータグは返されません。

Type:	MailboxIdParameter
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, Exchange Online

-OptionalInMailbox

OptionalInMailbox パラメーターは、指定されたメールボックスに割り当てられているオプトイン保持タグを返すために、Mailbox パラメーターと共に使用されます。このスイッチで値を指定する必要はありません。

オプトイン保持タグは、Set-RetentionPolicyTag -Mailbox -OptionalInMailbox コマンドを使用してメールボックスに明示的に割り当てられた個人用タグです。

Type:	SwitchParameter
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, Exchange Online

-Types

Types パラメーターには、返される保持タグの種類を指定します。有効な値は次のとおりです。

予定表
連絡先
DeletedItems
下書き
受信トレイ
JunkEmail
ジャーナル
メモ
送信トレイ
SentItems
タスク
すべて
RssSubscriptions
ConversationHistory
Personal

パラメーターには、コンマで区切られた複数の値を指定できます。

Type:	ElcFolderType[]
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, Exchange Online

入力

Input types

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

出力

Output types

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