Set-RetentionPolicyTag
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。
保持タグのプロパティを変更するには、Set-RetentionPolicyTag コマンドレットを使用します。
保持タグの詳細については、「Exchange Serverのアイテム保持タグとアイテム保持ポリシー」を参照してください。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Set-RetentionPolicyTag
[-Identity] <RetentionPolicyTagIdParameter>
[-AddressForJournaling <RecipientIdParameter>]
[-AgeLimitForRetention <EnhancedTimeSpan>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-JournalingEnabled <Boolean>]
[-LabelForJournaling <String>]
[-LegacyManagedFolder <ELCFolderIdParameter>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MessageClass <String>]
[-MessageFormatForJournaling <JournalingFormat>]
[-MustDisplayCommentEnabled <Boolean>]
[-Name <String>]
[-RetentionAction <RetentionAction>]
[-RetentionEnabled <Boolean>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-WhatIf]
[<CommonParameters>] Set-RetentionPolicyTag
-Mailbox <MailboxIdParameter>
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-LegacyManagedFolder <ELCFolderIdParameter>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MustDisplayCommentEnabled <Boolean>]
[-Name <String>]
[-OptionalInMailbox <RetentionPolicyTagIdParameter[]>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-WhatIf]
[<CommonParameters>] 説明
アイテム保持タグは、フォルダーおよびメールボックス内のアイテムにメッセージ保持設定を適用するために使用します。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Set-RetentionPolicyTag "AllUsers-DeletedItems" -Comment "Items in the Deleted Items folder will be automatically deleted in 120 days"この例では、AllUsers-DeletedItems アイテム保持ポリシー タグのコメントを変更します。
例 2
Set-RetentionPolicyTag -Mailbox "Terry Adams" -OptionalInMailbox "ProjectA","ProjectB"この例では、Mailbox と OptionalInMailbox パラメーターを使用してユーザー Terry Adams がオプションの保持タグを使用できるようにします。
パラメーター
-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 |
-Force
[強制] スイッチは、警告メッセージまたは確認メッセージを非表示にします。 このスイッチで値を指定する必要はありません。
RetentionId パラメーターを使用するときに確認プロンプトを非表示にするには、このスイッチを使用します。
| 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 |
-Identity
Identity パラメーターは、変更するアイテム保持ポリシー タグの名前、識別名 (DN)、または GUID を指定します。
| Type: | RetentionPolicyTagIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, 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 |
-LegacyManagedFolder
LegacyManagedFolder パラメーターは、管理フォルダーの名前を指定します。 保持タグは管理フォルダーおよびその管理コンテンツ設定からの保存期間の設定を使用して作成されます。 このパラメーターを使用して既存の管理フォルダーに基づく保持タグを作成し、ユーザーを管理フォルダー メールボックス ポリシーから保持ポリシーに移行できます。
| 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, Exchange Online |
-LocalizedComment
LocalizedComment パラメーターは、アイテム保持ポリシー タグのローカライズされたコメントと言語を指定します。 このコメントは、ユーザーのロケールMicrosoft基づいて Outlook に表示されます。
| 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 に表示されます。
| 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 |
-Mailbox
Mailbox パラメーターは、オプトイン タグの割り当て用のメールボックスを指定します。 メールボックスを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- Domain\Username
- 電子メール アドレス
- GUID
- LegacyExchangeDN
- SamAccountName
- ユーザー ID またはユーザー プリンシパル名 (UPN)
このパラメーターは、OptionalInMailbox パラメーターと併用する必要があります。
| Type: | MailboxIdParameter |
| Position: | Named |
| 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 |
-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: | 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 パラメーターと共に使用して、メールボックスに個人用タグを割り当てます。 このパラメーターを使用すると、指定したメールボックスに適用されるアイテム保持ポリシーに割り当てられない個人用タグをユーザーに提供できます。 複数の個人用タグをコンマで区切って指定できます。
| Type: | RetentionPolicyTagIdParameter[] |
| 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 |
-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 パラメーターは、1 つの Exchange 組織でタグ付けされたメールボックス アイテムで見つかった保持タグが、メールボックスが別の Exchange 組織に移動されたときにタグと一致するように代替タグ ID を指定します (たとえば、フォレスト間展開やクロスプレミス展開で、メールボックスがオンプレミスの Exchange サーバーからクラウドに移動されたときなど) またはクラウドベースのメールボックスがオンプレミスの Exchange サーバーに移動されます)。
通常、保持タグの RetentionId パラメーターを指定または変更する必要はありません。 このパラメーターは、フォレスト間またはクロスプレミスデプロイで保持タグをインポートするときに自動的に設定されます。
| 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 |
-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
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示