New-ComplianceTag
このコマンドレットは、セキュリティ & コンプライアンス PowerShell でのみ使用できます。 詳細については、「 セキュリティ & コンプライアンス PowerShell」を参照してください。
New-ComplianceTag コマンドレットを使用して、Microsoft Purview コンプライアンス ポータルに保持ラベルを作成します。 保持ラベルは、コンテンツに保持設定を適用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
New-ComplianceTag
[-Name] <String>
[-Comment <String>]
[-ComplianceTagForNextStage <String>]
[-Confirm]
[-EventType <ComplianceRuleIdParameter>]
[-FilePlanProperty <String>]
[-FlowId <System.Guid>]
[-Force]
[-IsRecordLabel <Boolean>]
[-IsRecordUnlockedAsDefault <Boolean>]
[-MultiStageReviewProperty <String>]
[-Notes <String>]
[-Regulatory <Boolean>]
[-RetentionAction <String>]
[-RetentionDuration <Unlimited>]
[-RetentionType <String>]
[-ReviewerEmail <SmtpAddress[]>]
[-WhatIf]
[<CommonParameters>]
説明
セキュリティ & コンプライアンス PowerShell でこのコマンドレットを使用するには、アクセス許可を割り当てる必要があります。 詳細については、「Microsoft Purview コンプライアンス センターのアクセス許可」 を参照してください。
例
例 1
New-ComplianceTag -Name "HR Content" -RetentionAction Keep -RetentionDuration 1825 -RetentionType ModificationAgeInDays
この例では、次の設定を使用して HR Content という新しいラベルを作成します。
- アクション: 保持します。
- 期間: 5 年 (1825 日)
- 型: 変更の有効期間 (日数)。
パラメーター
-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="Referen
ceA"},@{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
注: このパラメーターは現在プレビュー段階であり、すべての組織で使用できるわけではありません。変更される可能性があります。
FlowId パラメーターは、保持期間の終了時に実行する Power Automate フローを指定します。 このパラメーターの有効な値は、フローの GUID 値です。
フローの GUID 値は、次のいずれかの方法を使用して確認できます。
- Power Automate ポータルからフローに移動します。 フローの GUID 値は URL にあります。
- "管理者としてフローを一覧表示する" という名前の Power Automate アクションを使用します。
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 |
-IsRecordLabel
IsRecordLabel パラメーターは、ラベルがレコード ラベルであるかどうかを指定します。 有効な値は次のとおりです。
- $true: ラベルはレコード ラベルです。 ラベルがコンテンツに適用されると、ラベルを削除できません。
- $false: ラベルはレコード ラベルではありません。 これは既定の値です。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-IsRecordUnlockedAsDefault
{{ Fill IsRecordUnlockedAsDefault Description }}
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
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 |
-Name
Name パラメーターは、ラベルの一意の名前を指定します。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
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 |
-Regulatory
{{ Fill Regulatory Description }}
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RetentionAction
RetentionAction パラメーターは、ラベルのアクションを指定します。 有効な値は次のとおりです。
- Delete
- 保持
- KeepAndDelete
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 |
-RetentionType
RetentionType パラメーターは、コンテンツの作成日、タグ付けされた日付、または最終変更日から保持期間を計算するかどうかを指定します。 有効な値は次のとおりです。
- CreationAgeInDays
- EventAgeInDays
- ModificationAgeInDays
- TaggedAgeInDays
Type: | String |
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 |