New-ComplianceRetentionEvent
このコマンドレットは、セキュリティ/コンプライアンス PowerShell でのみ使用できます。 詳細については、「セキュリティ/コンプライアンス PowerShell」を参照してください。
New-ComplianceRetentionEvent コマンドレットを使用して、組織内のコンプライアンス保持イベントを作成します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
New-ComplianceRetentionEvent
-Name <String>
[-AssetId <String>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-EventDateTime <DateTime>]
[-EventTags <MultiValuedProperty>]
[-EventType <ComplianceRuleIdParameter>]
[-ExchangeAssetIdQuery <String>]
[-PreviewOnly]
[-SharePointAssetIdQuery <String>]
[-WhatIf]
[<CommonParameters>]
説明
セキュリティ/コンプライアンス PowerShell でこのコマンドレットを使用するには、アクセス許可が割り当てられている必要があります。 詳細については、「Microsoft Purview コンプライアンス センターのアクセス許可」 を参照してください。
例
例 1
New-ComplianceRetentionEvent -Name "Research Project Employees" -EventTag 80e0d620-13ea-4ed9-b6a6-aa883278bcca -EventType e823b782-9a07-4e30-8091-034fc01f9347 -SharePointAssetIDQuery "EmployeeNumber:123456 EmployeeNumber:456789"
この例では、次の設定を使用して、Research Project Employees という名前のコンプライアンス保持イベントを作成します。
- EventTag: 80e0d620-13ea-4ed9-b6a6-aa883278bcca
- EventTpe: e823b782-9a07-4e30-8091-034fc01f9347
- SharePointAssetIDQuery: EmployeeNumber:123456 EmployeeNumber:456789
パラメーター
-AssetId
AssetId パラメーターは、保持に使用される SharePoint ドキュメントまたは OneDrive ドキュメントのプロパティで見つかった Property:Value ペアを指定します。 例:
- 特定の製品のみのコンテンツ保持に使用する製品コード。
- 特定の製品のみのコンテンツ保持に使用するプロジェクト コード。
- 特定の製品のみのコンテンツ保持に使用する従業員 ID。
型: | 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 |
-DomainController
このパラメーターは、Microsoft の内部使用のために予約されています。
型: | Fqdn |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | Security & Compliance |
-EventDateTime
EventDateTime パラメーターは、イベントの日時を指定します。
コマンドを実行するコンピューターの [地域のオプション] 設定で定義されている短い日付形式を使用します。 たとえば、コンピューターが短い日付形式 MM/dd/yyyy を使用するように構成されている場合は、「2018 年 9 月 1 日」と入力して、2018 年 9 月 1 日を指定します。 日付のみを入力したり、日付と時刻を入力することもできます。 日付と時刻を入力する場合は、値を引用符 (”) で囲む必要があります (例: "09/01/2018 5:00 PM")。
型: | DateTime |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | Security & Compliance |
-EventTags
EventTags パラメーターは、コンプライアンス保持イベントに関連付けられているラベルの GUID 値を指定します。 次のコマンドを実行して、使用可能な GUID 値を確認します: Get-ComplianceTag | Format-Table Name,GUID
。
複数の値をコンマで区切って指定できます。
型: | MultiValuedProperty |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | Security & Compliance |
-EventType
EventType パラメーターは、このイベントの種類を使用するラベルの保持期間を開始するイベントの GUID 値を指定します。 次のコマンドを実行して、使用可能な GUID 値を確認します: Get-ComplianceRetentionEventType | Format-Table Name,GUID
。
型: | ComplianceRuleIdParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | Security & Compliance |
-ExchangeAssetIdQuery
ExchangeAssetIdQuery パラメーターは、コンプライアンス保持イベントの Exchange コンテンツのスコープを設定するために使用されるキーワードを指定します。 詳細については、「 コンテンツ検索のキーワード クエリと検索条件」を参照してください。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | Security & Compliance |
-Name
Name パラメーターは、コンプライアンス保持イベントの一意の名前を指定します。 最大の長さは 64 文字です。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。
型: | String |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | Security & Compliance |
-PreviewOnly
{{ Fill PreviewOnly Description }}
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | Security & Compliance |
-SharePointAssetIdQuery
SharePointAssetIdQuery パラメーターは、コンプライアンス保持イベントのスコープを設定するために、SharePoint ドキュメントと OneDrive ドキュメントのプロパティ (列とも呼ばれます) で指定した 1 つ以上の Property:Value ペアを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | Security & Compliance |
-WhatIf
WhatIf スイッチは、セキュリティ/コンプライアンス PowerShell では機能しません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | Security & Compliance |