Set-AIPFileLabel

  • リファレンス
モジュール:
AzureInformationProtection

ファイルの Azure Information Protection ラベルを設定または削除し、ラベルの構成またはカスタムアクセス許可に従って保護を設定または削除します。

構文

Set-AIPFileLabel
   -LabelId <Guid>
   [-JustificationMessage <String>]
   [-Owner <String>]
   [-PreserveFileDetails]
   [-EnableTracking]
   [-Path] <String[]>
   [<CommonParameters>]
Set-AIPFileLabel
   -LabelId <Guid>
   [-JustificationMessage <String>]
   -CustomPermissions <AIPCustomPermissions>
   [-Owner <String>]
   [-PreserveFileDetails]
   [-Path] <String[]>
   [<CommonParameters>]
Set-AIPFileLabel
   [-JustificationMessage <String>]
   [-RemoveLabel]
   [-PreserveFileDetails]
   [-Path] <String[]>
   [<CommonParameters>]
Set-AIPFileLabel
   [-JustificationMessage <String>]
   [-RemoveLabel]
   [-RemoveProtection]
   [-PreserveFileDetails]
   [-Path] <String[]>
   [<CommonParameters>]
Set-AIPFileLabel
   [-JustificationMessage <String>]
   [-RemoveProtection]
   [-PreserveFileDetails]
   [-Path] <String[]>
   [<CommonParameters>]
Set-AIPFileLabel
   -CustomPermissions <AIPCustomPermissions>
   [-Owner <String>]
   [-PreserveFileDetails]
   [-Path] <String[]>
   [<CommonParameters>]

説明

AIP 統合ラベル付けクライアントの場合、 Set-AIPFileLabel コマンドレットは 1 つ以上のファイルの秘密度ラベルを設定または削除します。 このアクションは、ラベルが暗号化を適用するように構成されている場合に、自動的に保護を適用できます。

さらに、このコマンドレットを使用して、 New-AIPCustomPermissions コマンドレットを使用してアドホック保護ポリシー オブジェクトとして作成するときにカスタム アクセス許可を適用できます。

コマンドが正常に実行されると、既存のラベルまたは保護を置き換えることができます。

このコマンドレットは非対話形式で実行できます。 詳細については、統合ラベル付けクライアント管理者ガイドを参照してください。

注意

ループで Set-AIPFileLabel コマンドレットを実行する場合は、コマンドレットの後に [GC]::Collect() という 2 行を追加します。
[GC]::WaitForPendingFinalizers()

例

例 1: "全般" ラベルを、現在ラベルを持たないすべてのファイルに適用する

PS C:\> Get-AIPFileStatus -Path \\Finance\Projects\ | where {$_.IsLabeled -eq $False} | Set-AIPFileLabel -LabelId d9f23ae3-4321-4321-4321-f515f824c57b
FileName                              Status Comment
--------                              ------ ------------
\\Finance\Projects\Image.jpg          Success
\\Finance\Projects\Pricelist.pdf      Success
\\Finance\Projects\Announcement.docx  Success
\\Finance\Projects\Analysis.xlsx      Success

このコマンドは、 まず Get-AIPFileStatus コマンドレットを使用してラベル付けされていないすべてのファイルを識別します。 次に、これらのファイルの ID で "全般" ラベルを指定することで、これらのファイルにラベルが付けられます。

例 2: ラベルが付かない .docx ファイルに "全般" ラベルを適用する

PS C:\> Get-ChildItem C:\Projects\*.docx -File -Recurse | Get-AIPFileStatus | where {$_.IsLabeled -eq $False} | Set-AIPFileLabel -LabelId d9f23ae3-1234-1234-1234-f515f824c57b
FileName                   Status  Comment
--------                   ------  ------------
C:\Projects\Analysis.docx  Success
C:\Projects\Projects.docx  Success

このコマンドは、最初に Get-Child-Item を使用して C:\Projects フォルダー (およびそのサブフォルダー) 内のすべての .docx ファイルを識別し、Get-AIPFileStatus コマンドレットを使用してラベル付けされていないファイルを検索します。 結果のファイルには、ID で "全般" ラベルを指定してラベルが付けられます。

注意

このコマンドは、Get-AIPFileStatus で Get-Child-Item を使用できるように、FullName の Path エイリアスを使用します。

例 3: (統合ラベル付けクライアントのみ) フォルダーとそのサブフォルダー内のすべてのファイルに "全般" ラベルを適用する

PS C:\> Set-AIPFileLabel -Path C:\Projects\ -LabelId d9f23ae3-1324-1234-1234-f515f824c57b
FileName                    Status      Comment
--------                    ------      ------------
C:\Projects\Project1.docx   Success
C:\Projects\Datasheet.pdf   Success
C:\Projects\Image.jpg       Success
C:\Projects\Analysis.xlsx   Skipped    No label to apply
C:\Projects\Dashboard.xlsx  Success

このコマンドは、 Projects フォルダーとそのサブフォルダー内のすべてのファイルに "General" という名前のラベルを設定します。

[全般] ラベルが暗号化を適用するように構成されている場合、このコマンドで正常にラベル付けされたファイルも暗号化されます。 この場合、PowerShell コマンドを実行したユーザーが、これらのファイルに対する Rights Management の (Rights Management のフル コントロール アクセス許可を付与された) 所有者となります。

この例では、理由が必要なため、1 つのファイルにラベルが付けられなかった (スキップされました)。 これは、より高い分類ラベルまたは保護を持つファイルが誤って低い分類ラベルで上書きされたり、保護が削除されたりしないようにするための意図した結果である可能性があります。

このセーフガードを有効にするには、ラベルを削除したり分類を下げたりするための正当な理由を要求するように、Office 365分類ラベル ポリシーを構成する必要があります。 JustificationMessage パラメーターを指定せずにこのコマンドを実行し、ラベルによって理由がトリガーされると、ファイルは "適用するラベルなし" というコメントでスキップされます。

例 4: (統合ラベル付けクライアントのみ) "General" ラベルを 1 つのファイルに適用します。これには正当な理由が必要です

PS C:\> Set-AIPFileLabel -Path \\Finance\Projects\Analysis.xlsx -LabelId d9f23ae3-1324-1234-1234-f515f824c57b -JustificationMessage 'The previous label no longer applies'
FileName                          Status      Comment
--------                          ------      ------------
\\finance\projects\analysis.xlsx  Success

このコマンドは、より高い分類ラベルで既にラベル付けされているファイルの "全般" ラベルを設定します。 Office 365分類ラベル ポリシーは、ラベルを削除したり分類を下げたりするための正当な理由を必要とするように構成されています。 コマンドに理由メッセージが含まれているため、新しいラベルが正常に適用されます。

例 5: (統合ラベル付けクライアントのみ) ファイルからラベルを削除する

PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -RemoveLabel -JustificationMessage 'The previous label no longer applies'

FileName                   Status Comment
--------                   ------ ------------
C:\Projects\Analysis.docx  Success

このコマンドは、 C:\Projects\Analysis.docxという名前のファイルから既存のラベルを削除し、必須の理由メッセージを指定します。

関連するOffice 365分類ラベル ポリシー設定でラベルを削除したり分類を下げたりするための正当な理由が必要になるため、この理由付け方法が必要です。

注意

削除するラベルがテンプレートを使用してファイルを保護していた場合、このコマンドはラベルと保護の両方を削除します。

削除するラベルがカスタムアクセス許可を使用してファイルを保護していた場合、このコマンドはラベルのみを削除します。

例 6: (統合ラベル付けクライアントのみ) カスタム アクセス許可でファイルを保護する

PS C:\> $permissions = New-AIPCustomPermissions -Users user1@contoso.com, user2@vanarsdel.com -Permissions Reviewer -ExpirationDate (Get-Date -Month 1 -Day 1 -Year 2020)
PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -CustomPermissions $permissions

FileName                   Status Comment
--------                   ------ ------------
C:\Projects\Analysis.docx  Success

最初のコマンドは、レビュー担当者のアクセス許可からさまざまな組織の使用権限をユーザーに付与し、有効期限も適用するアドホック保護ポリシー オブジェクトを作成します。

2 番目のコマンドは、格納されているアドホック保護ポリシー オブジェクトのカスタム アクセス許可を使用して 、Analysis.docx という名前の 1 つのファイルを保護します。

例 7: (統合ラベル付けクライアントのみ) ファイルにラベルとカスタム アクセス許可を適用する

PS C:\> $permissions = New-AIPCustomPermissions -Users a@a.com, b@b.com -Permissions Reviewer 
PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -LabelId d9f23ae3-1324-1234-1234-f515f824c57b -CustomPermissions $permissions

FileName                   Status Comment
--------                   ------ ------------
C:\Projects\Analysis.docx  Success

最初のコマンドは、レビュー担当者のアクセス許可からさまざまな組織の使用権限をユーザーに付与し、有効期限も適用するアドホック保護ポリシー オブジェクトを作成します。

2 番目のコマンドは、 Analysis.docx という名前の 1 つのファイルにラベルを適用し、保存されているアドホック保護ポリシー オブジェクトのカスタム アクセス許可を使用してファイルを保護します。 ラベルが保護設定用に構成されている場合は、カスタムアクセス許可に置き換えられます。

例 8: (統合ラベル付けクライアントのみ) ファイルから保護を削除する

PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -RemoveProtection

FileName                   Status Comment
--------                   ------ ------------
C:\Projects\Analysis.docx  Success

このコマンドは、 という名前の 1 つのファイルから保護 Analysis.docx削除します。

例 9: (統合ラベル付けクライアントのみ) ファイルから保護とラベルを削除する

PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -RemoveProtection -RemoveLabel -JustificationMessage 'The previous label no longer applies'

FileName                   Status Comment
--------                   ------ ------------
C:\Projects\Analysis.docx  Success

このコマンドは、 という名前の 1 つのファイルからラベルとカスタム保護 Analysis.docx削除します。 ポリシーはラベルを削除するために正当な理由を要求するように構成されているため、理由をユーザーに求めずにコマンドを完了できるように、理由理由も指定されます。

パラメーター

-CustomPermissions

New-AIPCustomPermissions コマンドレットを使用して作成されたアドホック保護ポリシーを格納する変数名を指定します。 アドホック保護ポリシーは、カスタムアクセス許可を持つファイルまたはファイルを保護するために使用されます。

Type:AIPCustomPermissions
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-EnableTracking

保護されたドキュメントをドキュメント追跡ポータルに登録するには、このパラメーターを指定します。

このコマンドレットを実行しているユーザーとグローバル管理者は、保護されたドキュメントを追跡し、必要に応じて取り消すことができます。 ドキュメント追跡サイトの詳細については、管理者ガイドの「Azure Information Protectionのドキュメント追跡の構成と使用」を参照してください。

ラベルが保護を適用しない場合、このパラメーターは無視されます。

Type:SwitchParameter
Position:named
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JustificationMessage

Azure Information Protection ポリシーで、分類ラベルの引き下げやラベルの削除、保護の解除に対する正当な理由を指定することがユーザーに求められている場合に使用します。 ラベルを設定すると理由がトリガーされ、この理由が指定されていない場合、ラベルは適用されません。 この場合、"スキップ" というステータスが "正当な理由が必要です" というコメントと共に返されます。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LabelId

適用するラベルの ID (ID) を指定します。 ラベルにサブラベルがある場合、親ラベルではなく、サブラベルの ID だけを常に指定してください。

ラベル ID を見つけるには:

ラベル ID の値は、Microsoft 365 コンプライアンス センターには表示されません。 ただし、次のOffice 365 Security & Compliance Center PowerShell コマンドを使用して、この値を見つけることができます。Get-Label | Format-Table -Property DisplayName, Name, Guid

ラベルが適用されているファイルの場合は、 Get-AIPFileStatus コマンドレットを実行してラベル ID (MainLabelId または SubLabelId) を識別することもできます。

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Path

ラベルと保護情報を取得するファイルへのローカル パス、ネットワーク パス、または SharePoint Server URL を指定します。

ワイルドカードはサポートされていません。また、WebDav の場所はサポートされていません。

SharePoint パスの場合は、次がサポートされています。

  • SharePoint Server 2019
  • SharePoint Server 2016
  • SharePoint Server 2013

例:

パス値を引用符で囲む場合、パスにはスペースを含めることができます。

Type:String[]
Aliases:FullName, FileName
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PreserveFileDetails

ラベルを付けるドキュメントの変更日 (Windows および SharePoint) と変更日 (SharePoint) の値を変更しない場合は、このパラメーターを指定します。

  • ローカル ファイルまたはネットワーク ファイルの場合、 変更日 の値は変更されません。

  • SharePoint ファイルの場合、[ 変更日 ] と [ 変更日] の値は変更されません。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveLabel

ファイルに適用されているラベルを削除します。

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RemoveProtection

関連する対象: 統合ラベル付けクライアントのみ

ファイルから保護を削除します。 ファイルにラベルが付いた場合、ラベルは削除されません。

ファイルから保護を削除するには、十分な使用権限を持っているか、organizationのスーパー ユーザーである必要があります。 詳細については、「 Azure Rights Management および探索サービスまたはデータ復旧のためのスーパー ユーザーの構成」を参照してください。

Set-AIPFileLabel PowerShell コマンドレットを使用して、コンテナー ファイル (zip、 .rar、.7z、.pst) からの保護の削除を有効にします。

注意

  • この保護機能は既定で無効になっており、 Set-LabelPolicy コマンドレットを使用して最初に有効にする必要があります。

  • .pst ファイルの場合、このコマンドレットでサポートされる最大ファイル サイズは 5 GB です。

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

入力

System.String[]

出力

Microsoft.InformationProtection.Powershell.AIP.Results.SetAIPFileResult