Get-FileStatus
指定したファイルのMicrosoft Purview 情報保護ラベルと保護情報を取得します。
構文
Get-FileStatus
[-Path] <String[]>
[<CommonParameters>]
説明
Get-FileStatus コマンドレットは、指定したファイルまたは指定したパス内のすべてのファイルの状態を返します。 この状態には、ファイルにラベルがあるかどうか、ラベル名、適用者、適用方法、およびタイミングが含まれます。
ファイルが SharePoint Online に格納されている場合は、代わりに SharePointOnlinePowerShell モジュールから Get-FileSensitivityLabelInfo コマンドレットを使用します。
Get-FileStatus コマンドレットで返される状態には、ファイルが Rights Management によって保護されているかどうか、および保護に使用された Rights Management テンプレートも含まれます。 テンプレートではなくカスタムアクセス許可 (アドホック権限ポリシー) でファイルが保護されている場合は、テンプレート名の代わりに "制限付きアクセス" が表示されます。 さらに、 Rights Management の所有者と Rights Management の発行者 が表示され、ファイルがいつ保護されたかが表示されます。
このコマンドレットは、独自のテナントからのみラベル情報を返します。
パスワードで保護されたファイルは常に保護状態の False を返します。
このコマンドレットは非対話形式で実行できます。
例
例 1: 1 つのファイルのラベルと保護の状態を取得する
PS C:\> Get-FileStatus -Path \\Finance\Projects\Project.docx
FileName : \\Finance\Projects\Project.docx
IsLabeled : True
MainLabelId : 074e257c-1234-1234-1234-34a182080e71
MainLabelName : Confidential
SubLabelId : d9f23ae3-1234-1234-1234-f515f824c57b
SubLabelName : Finance group
LabelingMethod : Privileged
LabelDate : 12/12/2016 12:24:36 PM
IsRMSProtected : True
RMSTemplateId : e6ee2481-1234-1234-1234-f744eacd53b0
RMSTemplateName : Contoso - Confidential Finance
RMSOwner : John@Contoso.com
RMSIssuer : John@Contoso.com
ContentId : 4ca757d2-83bf-4ec3-b93b-c7fe9433bf33
このコマンドは、"Confidential \ Finance group" というラベルが付いたファイルに関する情報を提供します。これは、テナント用に構成されたラベルです。 このファイルは John によって手動でラベル付けされ、Rights Management テンプレート "Contoso - Confidential Finance" を使用して保護されています。
例 2: フォルダー内のすべてのファイルのラベルと保護の状態を取得し、結果を CSV ファイルにエクスポートする
PS C:\> Get-FileStatus -Path \\Finance\Projects\ | Export-Csv C:\Reports\Report.csv
このコマンドは、Finance サーバー上のすべてのファイル、Projects フォルダー、およびそのサブフォルダーのラベルと保護情報を取得します。 結果は Report.csv という名前のファイルにエクスポートされるため、検索と並べ替えが簡単になります。 前のレポートが C:\Reports\Report.csvに存在する場合は、上書きされます。
例 3: "Confidential" というラベルの付いたファイルを一覧表示し、結果を CSV ファイルにエクスポートする
PS C:\> Get-FileStatus -Path \\Finance\Projects\ | Where-Object {$_.MainLabelName -eq 'Confidential'} | Export-Csv C:\Reports\Report.csv
このコマンドは、Finance サーバー上の "Confidential" (サブラベルに関係なく) ラベル付けされたファイルのラベルと保護情報を Projects フォルダーとそのサブフォルダーのいずれかに取得します。 結果は Report.csv という名前のファイルにエクスポートされるため、検索と並べ替えが簡単になります。 前のレポートが C:\Reports\Report.csvに存在する場合は、上書きされます。
例 4: "Confidential" ラベルを持つファイルの数
PS C:\> (Get-FileStatus -Path C:\Projects\ | Where-Object {$_.MainLabelName -eq 'Confidential'}).Count
5
このコマンドは、 C:\Projects フォルダーとそのサブフォルダーのいずれかに含まれる "Confidential" ラベルを持つファイルの数を提供します。 この例では、5 つのファイルが見つかります。
パラメーター
-Path
ラベルと保護情報を取得するファイルへのローカル パス、ネットワーク パス、または SharePoint Server URL を指定します。 ワイルドカードはサポートされていません。
SharePoint パスの場合は、次がサポートされています。
- SharePoint Server 2019
- SharePoint Server 2016
- SharePoint Server 2013
例:
- C:\Folder\
- C:\Folder\Filename
- \\Server\Folder
- http://sharepoint.contoso.com/Shared%20Documents/Folder
パス値を引用符で囲む場合、パスにはスペースを含めることができます。
型: | String[] |
Aliases: | FullName, FileName |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
System.String[]
出力
Microsoft.InformationProtection.Powershell.AIP.Results.GetAIPFileStatusResult