次の方法で共有

Set-AppRetentionCompliancePolicy

  • リファレンス
モジュール:
ExchangePowerShell
適用対象:
Security & Compliance

このコマンドレットは、セキュリティ/コンプライアンス PowerShell でのみ使用できます。 詳細については、「セキュリティ/コンプライアンス PowerShell」を参照してください。

Set-AppRetentionCompliancePolicy を使用して、アプリの保持コンプライアンス ポリシーを変更します。

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

構文

Set-AppRetentionCompliancePolicy
   [-Identity] <PolicyIdParameter>
   [-AddExchangeLocation <MultiValuedProperty>]
   [-AddExchangeLocationException <MultiValuedProperty>]
   [-AddModernGroupLocation <MultiValuedProperty>]
   [-AddModernGroupLocationException <MultiValuedProperty>]
   [-Applications <String[]>]
   [-Comment <String>]
   [-Confirm]
   [-DeletedResources <String>]
   [-Enabled <Boolean>]
   [-Force]
   [-PolicyRBACScopes <MultiValuedProperty>]
   [-RemoveExchangeLocation <MultiValuedProperty>]
   [-RemoveExchangeLocationException <MultiValuedProperty>]
   [-RemoveModernGroupLocation <MultiValuedProperty>]
   [-RemoveModernGroupLocationException <MultiValuedProperty>]
   [-RestrictiveRetention <Boolean>]
   [-WhatIf]
   [<CommonParameters>]
Set-AppRetentionCompliancePolicy
   [-Identity] <PolicyIdParameter>
   [-AddAdaptiveScopeLocation <MultiValuedProperty>]
   [-Applications <String[]>]
   [-Comment <String>]
   [-Confirm]
   [-DeletedResources <String>]
   [-Enabled <Boolean>]
   [-Force]
   [-RemoveAdaptiveScopeLocation <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]
Set-AppRetentionCompliancePolicy
   [-Identity] <PolicyIdParameter>
   [-Confirm]
   [-DeletedResources <String>]
   [-WhatIf]
   [<CommonParameters>]
Set-AppRetentionCompliancePolicy
   [-Identity] <PolicyIdParameter>
   [-Confirm]
   [-DeletedResources <String>]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]
Set-AppRetentionCompliancePolicy
   [-Identity] <PolicyIdParameter>
   [-Confirm]
   [-DeletedResources <String>]
   [-WhatIf]
   [<CommonParameters>]
Set-AppRetentionCompliancePolicy
   [-Identity] <PolicyIdParameter>
   [-Confirm]
   [-RetryDistribution]
   [-WhatIf]
   [<CommonParameters>]
Set-AppRetentionCompliancePolicy
   [-Identity] <PolicyIdParameter>
   [-Comment <String>]
   [-Confirm]
   [-DeletedResources <String>]
   [-Enabled <Boolean>]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

説明

セキュリティ/コンプライアンス PowerShell でこのコマンドレットを使用するには、アクセス許可が割り当てられている必要があります。 詳細については、「Microsoft Purview コンプライアンス センターのアクセス許可」 を参照してください。

例

例 1

Set-AppRetentionCompliancePolicy -Identity "Regulation 563 Marketing" -Applications "User:MicrosoftTeams","Group:MicrosoftTeams,VivaEngage" -AddExchangeLocation "Scott Smith" -Comment "Added new counsel, 9/9/21"

この例では、Teams プライベート チャネル メッセージ用に設定されている規制 563 Marketing という名前の既存の静的スコープ保持ポリシーに新しいユーザーを追加します。

例 2

$stringJson = @"
[{
     'EmailAddress': 'SalesUser@contoso.onmicrosoft.com'
}]
"@
Set-AppRetentionCompliancePolicy -Identity "Teams Private Channel Retention Policy" -AddExchangeLocationException "SalesUser@contoso.onmicrosoft.com" -DeletedResources $stringJson

次の使用例は、指定した論理的に削除されたメールボックスまたはメール ユーザーを、Teams プライベート チャネル メッセージ用に構成されたアイテム保持ポリシーから除外します。 削除されたリソースは、メールボックスまたはメール ユーザーのメール アドレスを使用して識別できます。

重要: このコマンドを実行する前に、重複する SMTP アドレスに関する DeletedResources パラメーター の注意情報を必ず読んでください。

ポリシーの除外は、保持ポリシーのサポートされている制限内に残る必要があります。 詳細については、「 Microsoft 365 アイテム保持ポリシーとアイテム保持ラベル ポリシーの制限」を参照してください。

例 3

$stringJson = @"
[{
     'EmailAddress': 'SalesUser1@contoso.onmicrosoft.com'
},
{
     'EmailAddress': 'SalesUser2@contoso.onmicrosoft.com'
}]
"@
Set-AppRetentionCompliancePolicy -Identity "Teams Private Chat Retention Policy" -AddExchangeLocationException "SalesUser1@contoso.onmicrosoft.com", "SalesUser2@contoso.onmicrosoft.com" -DeletedResources $stringJson

この例は例 2 と似ていますが、複数の削除されたリソースが指定されている場合を除きます。

重要: このコマンドを実行する前に、重複する SMTP アドレスに関する DeletedResources パラメーター の注意情報を必ず読んでください。

パラメーター

-AddAdaptiveScopeLocation

AddAdaptiveScopeLocation パラメーターは、ポリシーに追加するアダプティブ スコープの場所を指定します。 アダプティブ スコープは、New-AdaptiveScope コマンドレットを使用して作成します。 アダプティブ スコープを一意に識別する任意の値を使用できます。 例:

  • 名前
  • 識別名 (DN)
  • GUID

Update 値にスペースを含める、または引用符を必要とする場合は、次の構文を使用します: "Value1","Value2",..."ValueN"。

型:MultiValuedProperty
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-AddExchangeLocation

AddExchangeLocation パラメーターは、ExchangeLocation パラメーターの値 All を使用していない場合に含まれるメールボックスの一覧に追加するメールボックスを指定します。 有効な値は次のとおりです。

  • ExchangeLocation パラメーターは、ポリシーに含めるメールボックスを指定します。有効な値は次のとおりです。
  • メールボックス。

すべてのメールボックスに対する値 All。 この値のみ、それ自体で使用できます。

  • 名前
  • 名前
  • 識別名 (DN)
  • GUID

Update 値にスペースを含める、または引用符を必要とする場合は、次の構文を使用します: "Value1","Value2",..."ValueN"。

型:MultiValuedProperty
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-AddExchangeLocationException

AddExchangeLocationException パラメーターは、ExchangeLocation パラメーターの値 All を使用している場合に除外されたメールボックスの一覧に追加するメールボックスを指定します。 有効な値は次のとおりです。

  • このパラメーターは、ExchangeLocation パラメーターに値 All を使用するときに、除外する一覧から削除するメールボックスを指定します。有効な値は次のとおりです。
  • メールボックス。

すべてのメールボックスに対する値 All。 この値のみ、それ自体で使用できます。

  • 名前
  • 名前
  • 識別名 (DN)
  • GUID

Update 値にスペースを含める、または引用符を必要とする場合は、次の構文を使用します: "Value1","Value2",..."ValueN"。

型:MultiValuedProperty
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-AddModernGroupLocation

AddModernGroupLocation パラメーターは、ModernGroupLocation パラメーターの値 All を使用していない場合に含まれるMicrosoft 365 グループの一覧に追加するMicrosoft 365 グループを指定します。

Microsoft 365 グループを一意に識別する任意の値を使用できます。 例:

  • 名前
  • 名前
  • 識別名 (DN)
  • GUID

Update 値にスペースを含める、または引用符を必要とする場合は、次の構文を使用します: "Value1","Value2",..."ValueN"。

型:MultiValuedProperty
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-AddModernGroupLocationException

AddModernGroupLocationException パラメーターは、ModernGroupLocation パラメーターの値 All を使用しているときに、除外されたMicrosoft 365 グループの一覧に追加するMicrosoft 365 グループを指定します。

Microsoft 365 グループを一意に識別する任意の値を使用できます。 例:

  • 名前
  • 名前
  • 識別名 (DN)
  • GUID

Update 値にスペースを含める、または引用符を必要とする場合は、次の構文を使用します: "Value1","Value2",..."ValueN"。

型:MultiValuedProperty
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-Applications

Applications パラメーターは、含めるアプリケーションを指定し、次の場所パラメーターにのみ関連します。

  • ExchangeLocation
  • ModernGroupLocation
  • AdaptiveScopeLocation

このパラメーターは、LocationType が User または Group である "LocationtType:App1,LocationType:App2,...LocationType:AppN という構文を使用します。 たとえば、"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint" および "User:MicrosoftTeams","User:VivaEngage" が禁止となります。

型:String[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-Comment

Comment パラメーターで、オプションのコメントを指定します。 スペースを含む値を指定する場合は、次のように値を二重引用符 (") で囲んでください。"これは管理者メモです。"

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-Confirm

Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。

  • データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文-Confirm:$falseを使用して、確認プロンプトを省略できます。
  • 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
型:SwitchParameter
Aliases:cf
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-DeletedResources

DeletedResources パラメーターは、削除されたメールボックスまたはメール ユーザーを指定して、それぞれの場所の一覧に除外として追加します。 このパラメーターは、削除されたメールボックスまたは Teams のみのアイテム保持ポリシーから除外する必要があるメール ユーザーに対して AddTeamsChatLocationException パラメーターと共に使用します。

有効な値は JSON 文字列です。 このパラメーターの構文と使用例については、「例」セクションを参照してください。

非アクティブなメールボックスシナリオの詳細については、「 非アクティブなメールボックスの詳細」を参照してください。

注意: このパラメーターは、削除されたメールボックスまたはメール ユーザーの SMTP アドレスを使用します。これは、他のメールボックスまたはメール ユーザーにも指定される場合があります。 最初に追加の手順を実行せずにこのパラメーターを使用する場合、アイテム保持ポリシーで同じ SMTP アドレスを持つ他のメールボックスとメール ユーザーも除外されます。 同じ SMTP アドレスを持つ追加のメールボックスまたはメール ユーザーをチェックするには、次のコマンドを使用し、user@example.comを SMTP アドレスに置き換えてチェック。Get-Recipient -IncludeSoftDeletedRecipients user@contoso.com |Select-Object DisplayName, EmailAddresses, Description, Alias, RecipientTypeDetails, WhenSoftDeleted

アクティブなメールボックスまたは同じ SMTP アドレスを持つメール ユーザーが除外されないようにするには、DeletedResources パラメーターを使用してコマンドを実行する前に、メールボックスを 訴訟ホールド に入れます。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-Enabled

Enabled パラメーターは、ポリシーを有効または無効にします。 有効な値は次のとおりです。

  • $true: ポリシーを有効にします。 これは既定の値です。
  • $true: ポリシーを有効にします。これが既定値です。
型:Boolean
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-Force

[強制] スイッチは、警告メッセージまたは確認メッセージを非表示にします。 このスイッチで値を指定する必要はありません。

管理者の入力を求めることが不適切な場合に、このスイッチを使用してタスクをプログラムによって実行することができます。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-Identity

Identity パラメーターは、変更するアプリの保持コンプライアンス ポリシーを指定します。 ポリシーを一意に識別する任意の値を使用できます。 次に例を示します。

  • 名前
  • 識別名 (DN)
  • GUID
型:PolicyIdParameter
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-PolicyRBACScopes

注: 管理 ユニットは現在サポートされていないため、このパラメーターは機能しません。 ここで説明する情報は、管理ユニットのサポートがリリースされたときに情報提供を目的とします。

PolicyRBACScopes パラメーターは、ポリシーに割り当てる管理単位を指定します。 有効な値は、管理単位のMicrosoft Entra ObjectID (GUID 値) です。 複数の値をコンマで区切って指定できます。

管理単位は、Microsoft Entra ID P1 または P2 でのみ使用できます。 管理単位は、Microsoft Graph PowerShell で作成および管理します。

型:MultiValuedProperty
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-RemoveAdaptiveScopeLocation

RemoveAdaptiveScopeLocation パラメーターは、ポリシーから削除するアダプティブ スコープの場所を指定します。 アダプティブ スコープは、New-AdaptiveScope コマンドレットを使用して作成します。 アダプティブ スコープを一意に識別する任意の値を使用できます。 例:

  • 名前
  • 識別名 (DN)
  • GUID

Update 値にスペースを含める、または引用符を必要とする場合は、次の構文を使用します: "Value1","Value2",..."ValueN"。

型:MultiValuedProperty
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-RemoveExchangeLocation

RemoveExchangeLocation パラメーターは、ExchangeLocation パラメーターの値 All を使用していない場合に含まれるメールボックスの一覧から削除するメールボックスを指定します。 有効な値は次のとおりです。

  • このパラメーターは、ExchangeLocation パラメーターに値 All を使用するときに、除外する一覧から削除するメールボックスを指定します。有効な値は次のとおりです。
  • メールボックス。

すべてのメールボックスに対する値 All。 この値のみ、それ自体で使用できます。

  • 名前
  • 名前
  • 識別名 (DN)
  • GUID

Update 値にスペースを含める、または引用符を必要とする場合は、次の構文を使用します: "Value1","Value2",..."ValueN"。

型:MultiValuedProperty
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-RemoveExchangeLocationException

RemoveExchangeLocationException パラメーターは、ExchangeLocation パラメーターの値 All を使用するときに、除外されたメールボックスの一覧から削除するメールボックスを指定します。 有効な値は次のとおりです。

  • このパラメーターは、ExchangeLocation パラメーターに値 All を使用するときに、除外する一覧から削除するメールボックスを指定します。有効な値は次のとおりです。
  • メールボックス。

すべてのメールボックスに対する値 All。 この値のみ、それ自体で使用できます。

  • 名前
  • 名前
  • 識別名 (DN)
  • GUID

Update 値にスペースを含める、または引用符を必要とする場合は、次の構文を使用します: "Value1","Value2",..."ValueN"。

型:MultiValuedProperty
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-RemoveModernGroupLocation

RemoveModernGroupLocation パラメーターは、ModernGroupLocation パラメーターの値 All を使用していない場合に含まれるグループの一覧から削除するMicrosoft 365 グループを指定します。

Microsoft 365 グループを一意に識別する任意の値を使用できます。 例:

  • 名前
  • 名前
  • 識別名 (DN)
  • GUID

Update 値にスペースを含める、または引用符を必要とする場合は、次の構文を使用します: "Value1","Value2",..."ValueN"。

型:MultiValuedProperty
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-RemoveModernGroupLocationException

RemoveModernGroupLocationException パラメーターは、ModernGroupLocation パラメーターの値 All を使用しているときに、除外されたグループの一覧から削除するMicrosoft 365 グループを指定します。

Microsoft 365 グループを一意に識別する任意の値を使用できます。 例:

  • 名前
  • 名前
  • 識別名 (DN)
  • GUID

Update 値にスペースを含める、または引用符を必要とする場合は、次の構文を使用します: "Value1","Value2",..."ValueN"。

型:MultiValuedProperty
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-RestrictiveRetention

RestrictiveRetention パラメーターは、ポリシーに対して保持ロックが有効かどうかを指定します。 有効な値は次のとおりです。

  • $true: ポリシーに対して保持ロックが有効になっています。 管理者を含む誰も、ポリシーをオフにしたり、制限を減らしたりすることはできません。
  • $false: ポリシーに対して保持ロックが有効になっていません。 これは既定の値です。

ポリシーがロックされた後、ポリシーをオフまたは無効にしたり、ポリシーからアプリを削除したりすることはできません。 ポリシーを変更できる唯一の方法は、アプリを追加するか、その期間を延長することです。 ロックされたポリシーは増やしたり拡張したりできますが、減らしたり、無効にしたり、オフにしたりすることはできません。

そのため、ポリシーをロックする前に、organizationのコンプライアンス要件を理解し、ポリシーが必要であると確信するまでポリシーをロックしないことを重要にします。

型:Boolean
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-RetryDistribution

RetryDistribution スイッチは、ポリシーをすべての場所に再配布するかどうかを指定します。 このスイッチで値を指定する必要はありません。

初期の配布が成功した場所は、再試行に含まれません。 このスイッチを使用すると、ポリシーの配布エラーが報告されます。

注: 配布を再試行するプロセスは重要な操作であるため、必要な場合にのみ、一度に 1 つのポリシーに対して実行してください。 ポリシーを更新するたびに実行されるわけではありません。 スクリプトを実行して複数のポリシーを更新する場合は、ポリシー配布が成功するまで待ってから、次のポリシーのコマンドをもう一度実行します。

型:SwitchParameter
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance

-WhatIf

WhatIf スイッチは、セキュリティ/コンプライアンス PowerShell では機能しません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False
適用対象:Security & Compliance