次の方法で共有

New-RetentionPolicyTag

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

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

保持タグを作成するには、 New-RetentionPolicyTag コマンドレットを使用します。

保持タグの詳細については、「Exchange Serverのアイテム保持タグとアイテム保持ポリシー」を参照してください。

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

構文

New-RetentionPolicyTag
   [-Name] <String>
   [-AddressForJournaling <RecipientIdParameter>]
   [-AgeLimitForRetention <EnhancedTimeSpan>]
   [-Comment <String>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-IsDefaultAutoGroupPolicyTag]
   [-IsDefaultModeratedRecipientsPolicyTag]
   [-JournalingEnabled <Boolean>]
   [-LabelForJournaling <String>]
   [-LocalizedComment <MultiValuedProperty>]
   [-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
   [-MessageClass <String>]
   [-MessageFormatForJournaling <JournalingFormat>]
   [-MustDisplayCommentEnabled <Boolean>]
   [-RetentionAction <RetentionAction>]
   [-RetentionEnabled <Boolean>]
   [-RetentionId <Guid>]
   [-SystemTag <Boolean>]
   [-Type <ElcFolderType>]
   [-WhatIf]
   [<CommonParameters>]
New-RetentionPolicyTag
   [-Name] <String>
   [-ManagedFolderToUpgrade <ELCFolderIdParameter>]
   [-Comment <String>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-IsDefaultAutoGroupPolicyTag]
   [-IsDefaultModeratedRecipientsPolicyTag]
   [-LocalizedComment <MultiValuedProperty>]
   [-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
   [-MustDisplayCommentEnabled <Boolean>]
   [-SystemTag <Boolean>]
   [-Type <ElcFolderType>]
   [-WhatIf]
   [<CommonParameters>]

説明

アイテム保持タグは、フォルダーおよびメールボックス内のアイテムにメッセージ保持設定を適用するために使用します。

保持タグは、ローカライズ言語でのタグ名およびコメント (オプション) の表示に対応しています。 その目的には、CultureInfo クラスの言語のカルチャ コードが使用されます。

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

例

例 1

New-RetentionPolicyTag "Finance-DeletedItems" -Type DeletedItems -RetentionEnabled $true -AgeLimitForRetention 30 -RetentionAction PermanentlyDelete

この例では、既定フォルダーの [削除済みアイテム] に対して Finance-DeletedItems というアイテム保持ポリシー タグを作成します。 そのタグがアイテム保持ポリシーの一部としてメールボックスに適用されると、[削除済みアイテム] フォルダー内のすべての種類のアイテムが 30 日で完全に削除されます。

例 2

New-RetentionPolicyTag "Finance-Default" -Type All -RetentionEnabled $true -AgeLimitForRetention 365 -RetentionAction PermanentlyDelete

この例では、Finance-Default という既定のポリシー タグを作成します。 そのタグがアイテム保持ポリシーの一部としてメールボックスに適用されると、保持タグが付いていないすべてのアイテムが 365 日以内に完全に削除されます。 ボイス メールなどの特定のメッセージ クラスのアイテムについては、既定のタグ (種類が All の保持タグ) が存在しており、影響を受けません。

例 3

New-RetentionPolicyTag "Business Critical" -Type Personal -Comment "Use this tag for all business critical mail" -RetentionEnabled $true -AgeLimitForRetention 2556 -RetentionAction PermanentlyDelete

この例では、種類が Personal の保持タグ Business Critical を作成します。 アイテム保持ポリシーの一部としてメールボックス アイテムに適用されると、アイテムは約 7 年で完全に削除されます。

パラメーター

-AddressForJournaling

このパラメーターは Exchange Server 2010 でのみ使用できます。

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

Type:RecipientIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010

-AgeLimitForRetention

AgeLimitForRetention パラメーターは、アイテムに適用する保存期間を指定します。 保存期間はアイテムが配信された日付からの日数、または配信されなかった場合は作成された日付からの日数です。 このパラメーターが存在せず、RetentionEnabled パラメーターが $true に設定されている場合は、エラーが返されます。

Type:EnhancedTimeSpan
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

-Comment

Comment パラメーターは、タグのコメントを指定します。

Type:String
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

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

-IsDefaultAutoGroupPolicyTag

このパラメーターは、クラウドベースのサービスでのみ使用できます。

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-IsDefaultModeratedRecipientsPolicyTag

このパラメーターは、クラウドベースのサービスでのみ使用できます。

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-JournalingEnabled

このパラメーターは Exchange Server 2010 でのみ使用できます。

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

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010

-LabelForJournaling

このパラメーターは Exchange Server 2010 でのみ使用できます。

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010

-LocalizedComment

LocalizedComment パラメーターは、ローカライズされたコメントとその言語を指定します。 ユーザーの言語設定がこのパラメーターに指定された言語と一致する場合は、Outlook をMicrosoftし、対応するローカライズされたコメントを表示Outlook on the web。 コメントは ISO Language Code:Comment の形式 (たとえば、LocalizedComment EN-US:"This is a localized comment in U.S. English") で指定されます。

Type:MultiValuedProperty
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

-LocalizedRetentionPolicyTagName

LocalizedRetentionPolicyTagName パラメーターは、ローカライズされたタグ名とその言語を指定します。 ユーザーの言語設定がこのパラメーターに指定された言語と一致すると、Outlook と Outlook on the webは対応するローカライズされたタグ名を表示します。 コメントは ISO Language Code:Name の形式 (たとえば、LocalizedRetentionPolicyTagName EN-US:"Business Critical") で指定されます。

Type:MultiValuedProperty
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

-ManagedFolderToUpgrade

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

ManagedFolderToUpgrade パラメーターは、保持タグのテンプレートとして使用する管理フォルダーの名前を指定します。

Type:ELCFolderIdParameter
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

-MessageClass

MessageClass パラメーターには、タグを適用するメッセージの種類を指定します。 指定のない場合、既定の値は * に設定されます。

ボイスメールの既定のポリシー タグ (DPT) を除き、Exchange では、さまざまなメッセージの種類の保持タグはサポートされていません。 MessageClass が * のタグのみサポートされ、それがすべてのメッセージの種類に適用されます。

ボイス メール メッセージの DPT を作成するには、MessageClass パラメーターを「voicemail」に設定し、Type パラメーターを「All」に設定します。

ボイス メール メッセージの DPT は、Microsoft Exchange ユニファイド メッセージング ボイス メール メッセージ (PR_MESSAGE_CLASS MAPI プロパティ値 IPM.Note.Microsoft.Voicemail* で特定) にのみ適用されます。

Type:String
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

-MessageFormatForJournaling

このパラメーターは Exchange Server 2010 でのみ使用できます。

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

Type:JournalingFormat
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010

-MustDisplayCommentEnabled

MustDisplayCommentEnabled パラメーターは、コメントを非表示化できるかどうかを指定します。 既定値は $true です。

Type:Boolean
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

-Name

Name パラメーターは、タグの名前を指定します。

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

-RetentionAction

RetentionAction パラメーターは、アイテム保持ポリシーのアクションを指定します。 有効な値は次のとおりです。

  • DeleteAndAllowRecovery: メッセージを削除し、[回復可能なアイテム] フォルダーからの回復を許可します。
  • DeleteAndAllowRecovery: メッセージを削除し、回復可能なアイテム フォルダーからの回復を許可します。
  • MoveToArchive: メッセージをユーザーのアーカイブ メールボックスに移動します。 このアクションは、All、Personal、RecoverableItems 型の保持タグに使用できます。
  • PermanentlyDelete: メッセージを完全に削除します。 完全に削除されたメッセージは、[回復可能なアイテム] フォルダーを使用して回復できません。 完全に削除されたメッセージは、メールボックスに対して訴訟ホールドが有効になっていない限り、探索検索では返されません。

MoveToDeletedItems と MoveToFolder アクションを使用できますが、動作しません。 これらのアクションは、メッセージング レコード管理 (MRM) 1.0 (管理対象のフォルダー) から MRM 2.0 (アイテム保持ポリシー) へのアップグレードに使用できます。 MRM 2.0 は、Exchange 2010 Service Pack 1 (SP1) で導入されました。

このパラメーターが存在せず、RetentionEnabled パラメーターが $true に設定されている場合は、エラーが返されます。

Type:RetentionAction
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

-RetentionEnabled

RetentionEnabled パラメーターは、タグを有効にするかどうかを指定します。 $false に設定するとタグは無効になり、適用されたタグを持つメッセージに対する保存期間用のアクションは実行されません。

無効なタグを持つメッセージはタグ付けされたと見なされるため、ユーザーのアイテム保持ポリシーの無効なタグと同じ種類のタグは、そのようなメッセージには適用されません。

RetentionEnabled パラメーターを $false に設定すると、タグの保存期間は [なし] と表示されます。 このタグを適用して、削除やアーカイブへ移動してはいけないアイテムを示すことができます。 タグを後で有効にすると、アイテムを意図せず削除したりアーカイブしてしまう可能性があります。 この状況を回避するために、アイテム保持ポリシーが一時的に無効になっている場合は、そのタグの名前を変更して、 などの DISABLED_<Original Name>ユーザーが使用しないことをお勧めします。

Type:Boolean
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

-RetentionId

RetentionId パラメーターは、代替タグ ID を指定して、オンプレミス展開でタグ付けされたメールボックスアイテムで見つかった保持タグが、メールボックスがクラウドに移動されたときにタグと一致するか、クラウドでタグ付けされたメールボックスアイテムが、メールボックスがオンプレミスの Exchange サーバーに移動されたときにタグと一致することを確認します。 パラメーターは、クロスプレミス展開で使用されます。 オンプレミスのみの展開では、このパラメーターを指定する必要はありません。

Type:Guid
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

-SystemTag

SystemTag パラメーターは、内部 Exchange 機能用にタグが作成されることを指定します。

Type:Boolean
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

-Type

Type パラメーターは、作成する保持タグの種類を指定します。 有効な値は次のとおりです。

  • すべて
  • アーカイブ
  • 予定表
  • 低優先: Exchange Onlineでのみ使用できます。
  • 連絡先
  • ConversationHistory
  • DeletedItems
  • 下書き
  • 受信トレイ
  • ジャーナル
  • JunkEmail
  • LegacyArchiveJournals
  • ManagedCustomFolder
  • メモ
  • 送信トレイ
  • Personal
  • RecoverableItems
  • RssSubscriptions
  • SentItems
  • SyncIssues
  • タスク

既定のポリシー タグ (DPT) を作成するには、「すべて」と入力します。 RecoverableItems 型のタグの場合、有効な保持アクションは MoveToArchive のみです。

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

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

入力

Input types

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

出力

Output types

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