Set-ComplianceTag

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

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

Set-ComplianceTag コマンドレットを使用して、Microsoft Purview コンプライアンス ポータルの保持ラベルを変更します。 保持ラベルは、コンテンツに保持設定を適用します。

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

構文

Set-ComplianceTag
   [-Identity] <ComplianceRuleIdParameter>
   [-Comment <String>]
   [-ComplianceTagForNextStage <String>]
   [-Confirm]
   [-EventType <ComplianceRuleIdParameter>]
   [-FilePlanProperty <String>]
   [-FlowId <System.Guid>]
   [-Force]
   [-MultiStageReviewProperty <String>]
   [-Notes <String>]
   [-RetentionDuration <Unlimited>]
   [-ReviewerEmail <SmtpAddress[]>]
   [-WhatIf]
   [<CommonParameters>]

説明

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

例

例 1

Set-ComplianceTag -Identity "HR Content" -RetentionDuration 2555 -Comment "Retain HR content for 7 years"

この例では、保持期間の変更とコメントの追加を行い、HR Content という名前の既存のラベルを変更します。

パラメーター

-Comment

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ComplianceTagForNextStage

{{ Fill ComplianceTagForNextStage Description }}

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-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:Security & Compliance

-EventType

EventType は、ラベルに関連付けられている保持ルールを指定します。 ルールを一意に識別する任意の値を使用できます。 次に例を示します。

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

使用可能な保持規則を確認するには、Get-RetentionComplianceRule コマンドレットを使用します。

Type:ComplianceRuleIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-FilePlanProperty

FilePlanProperty パラメーターは、ラベルに含めるファイル プランのプロパティを指定します。 このパラメーターで使用する必要があるファイル プラン のプロパティ名を表示するには、次のコマンドを実行します。

  • Get-FilePlanPropertyAuthority | Format-List Name
  • Get-FilePlanPropertyCategory | Format-List Name
  • Get-FilePlanPropertyCitation | Format-List Name
  • Get-FilePlanPropertyDepartment | Format-List Name
  • Get-FilePlanPropertyReferenceId | Format-List Name
  • Get-FilePlanPropertySubCategory | Format-List Name

このパラメーターの有効な値には、次の 2 つの手順が含まれます。

  • 次の構文を使用して、ファイル プランのプロパティを PSCustomObject として格納する変数。

    $Variable1=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Name"},@{Key="FilePlanPropertyCategory";Value="Name"},@{Key="FilePlanPropertySubcategory";Value="Name"},@{Key="FilePlanPropertyCitation";Value="Name"},@{Key="FilePlanPropertyReferenceId";Value="Name"},@{Key="FilePlanPropertyAuthority";Value="Name"})}

    例:

    $retentionLabelAction=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Legal"},@{Key="FilePlanPropertyCategory";Value="Tax"},@{Key="FilePlanPropertySubcategory";Value="US_Tax"},@{Key="FilePlanPropertyCitation";Value="LegalCitation"},@{Key="FilePlanPropertyReferenceId";Value="ReferenceA"},@{Key="FilePlanPropertyAuthority";Value="Auth1"})}

  • 次の構文を使用して PSCustomObject を JSON オブジェクトに変換する 2 番目の変数。

    $Variable2 = ConvertTo-Json $Variable1

    例:

    $fpStr = ConvertTo-Json $retentionLabelAction

このパラメーターの値として 2 番目の変数を使用します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-FlowId

{{ Fill FlowId Description }}

Type:System.Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Force

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

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Identity

Identity パラメーターは、変更するラベルを指定します。 タグを一意に識別する任意の値を使用できます。 次に例を示します。

  • 名前
  • 識別名 (DN)
  • GUID
Type:ComplianceRuleIdParameter
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Security & Compliance

-MultiStageReviewProperty

MultiStageReviewProperty パラメーターは、ラベルに含めるマルチステージ レビュー プロパティを指定します。 このパラメーターには、次の構文を使用します。

'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'

例:

'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[jie@contoso.onmicrosoft.com]},{"StageName":"Stage2","Reviewers":[bharath@contoso.onmicrosoft.com,helen@contoso.onmicrosoft.com]},]}'

この構文は、各レビュー ステージ ID、レビュー ステージ名、レビュー担当者の一覧を定義する JSON オブジェクトです。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Notes

Notes パラメーターは、省略可能なメモを指定します。 スペースを含む値を指定する場合は、値を引用符 (") で囲みます (例: "これはユーザーノートです")。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-RetentionDuration

RetentionDuration パラメーターは、コンテンツを保持する日数を指定します。 有効な値は次のとおりです。

  • 正の整数。
  • 値 unlimited。
Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ReviewerEmail

ReviewerEmail パラメーターは、Delete および KeepAndDelete の保存期間用アクションのレビュー担当者の電子メール アドレスを指定します。 複数のメール アドレスをコンマで区切って指定できます。

Type:SmtpAddress[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance