AzureInformationProtection

The following lists links to documentation for the Microsoft Azure Information Protection (AIP) cmdlets.

  • Installation: The AzureInformationProtection module is installed with either the Azure Information Protection unified labeling or classic client.

    To check the version you have installed, run: (Get-Module AIPService -ListAvailable).Version If this command or any cmdlet from this module fails to run, first run Import-Module AIPService.

  • .dll file: The .dll file for this module is AIP.dll.

For more information, see:

Client References
Unified labeling client - AIP unified labeling client
- Unified client version release history
- Using PowerShell with the AIP unified labeling client
Classic client - AIP classic client
- Classic client version release history
- Using PowerShell with the AIP classic client

Tip

This docset indicates whenever information is relevant for only one of the clients. If no client is specified, the cmdlet or parameter is relevant for both clients.

Not sure of the differences between these two clients? See this FAQ.

Check the version that you have installed by running the following command: (Get-Module AzureInformationProtection -ListAvailable).Version.

Note

To provide a unified and streamlined customer experience, the Azure Information Protection classic client and Label Management in the Azure Portal are deprecated as of March 31, 2021. While the classic client continues to work as configured, no further support is provided, and maintenance versions will no longer be released for the classic client.

We recommend that you migrate to unified labeling and upgrade to the unified labeling client. Learn more in our recent deprecation blog.

AzureInformationProtection

Add-AIPScannerRepository

Relevant for: AIP unified labeling client. Deprecated for the classic client.

Adds a repository to an Azure Information Protection content scan job.

Add-AIPScannerScannedFileTypes

Relevant for: AIP classic client only, and deprecated.

Adds new file types to a configured list of file types to scan or exclude from scanning by the Azure Information Protection scanner.

Clear-AIPAuthentication

Relevant for: AIP unified labeling and classic clients

Clears the user settings and RMS templates for the current user.

Clear-RMSAuthentication

Relevant for: AIP classic client only

Clears credentials for a user who is authenticated to the Azure RMS service.

Export-AIPLogs

Relevant for: AIP unified labeling client only

Gathers and exports Azure Information Protection client and scanner log files to a compressed file.

Get-AIPFileStatus

Relevant for: AIP unified labeling and classic clients

Gets the Azure Information Protection label and protection information for a specified file or files.

Get-AIPScannerConfiguration

Relevant for: AIP unified labeling and classic clients

Gets the configuration settings for the Azure Information Protection scanner.

Get-AIPScannerContentScanJob

Gets details about an Azure Information Protection content scan job.

Get-AIPScannerRepository

Relevant for: AIP unified labeling client. Deprecated for the classic client.

Gets repository data for an Azure Information Protection content scan job.

Get-AIPScannerStatus

Relevant for: AIP unified labeling and classic clients

Gets the current status of the service for the Azure Information Protection scanner.

Get-MIPNetworkDiscoveryConfiguration

Relevant for: AIP unified labeling client only

Gets configuration settings for the Network Discovery service.

Get-MIPNetworkDiscoveryJobs

Relevant for: AIP unified labeling client only

Gets a list of Azure Information Protection network scan jobs configured in your tenant.

Get-MIPNetworkDiscoveryStatus

Relevant for: AIP unified labeling client only

Gets the current status of the Network Discovery service.

Get-RMSFileStatus

Relevant for: AIP unified labeling and classic clients

Gets the RMS protection status of a specified file.

Get-RMSServer

Relevant for: AIP classic client only

Gets a list of RMS servers that can issue templates.

Get-RMSServerAuthentication

Relevant for: AIP classic client only

Gets the server mode status that is used for authentication to RMS.

Get-RMSTemplate

Relevant for: AIP classic client only

Gets a list of RMS templates.

Import-AIPScannerConfiguration

Relevant for: AIP unified labeling and classic clients

Imports local configuration for the Azure Information Protection scanner.

Import-MIPNetworkDiscoveryConfiguration

Relevant for: AIP unified labeling client only

Imports a local configuration for Network Discovery network scan jobs.

Install-AIPScanner

Relevant for: AIP unified labeling and classic clients

Installs the Azure Information Protection scanner.

Install-MIPNetworkDiscovery

Installs the Network Discovery service.

New-AIPCustomPermissions

Relevant for: AIP unified labeling client only

Creates an ad-hoc protection policy for custom permissions.

New-RMSProtectionLicense

Relevant for: AIP classic client only

Creates an ad-hoc rights policy for RMS protection.

Protect-RMSFile

Relevant for: AIP classic client only

Protects a specified file or the files in a specified folder by using RMS.

Remove-AIPScannerContentScanJob

Delete a content scan job.

Remove-AIPScannerRepository

Relevant for: Unified labeling client only. Deprecated for the classic client.

Removes a repository from an Azure Information Protection content scan job.

Remove-AIPScannerScannedFileTypes

Relevant for: AIP classic client only, and deprecated.

Removes file types from a configured list of file types to scan or exclude from scanning by the Azure Information Protection scanner.

Set-AIPAuthentication

Relevant for: AIP unified labeling and classic clients

Sets the authentication credentials for the Azure Information Protection client.

Set-AIPFileClassification

Relevant for: AIP unified labeling and classic clients

Scans a file to automatically set an Azure Information Protection label for a file, according to conditions that are configured in the policy.

Set-AIPFileLabel

Relevant for: AIP unified labeling and classic clients

Sets or removes an Azure Information Protection label for a file, and sets or removes the protection according to the label configuration or custom permissions.

Set-AIPScanner

Relevant for: AIP unified labeling and classic clients

Sets the service account and database for the Azure Information Protection scanner.

Set-AIPScannerConfiguration

Relevant for: AIP unified labeling and classic clients

Sets optional configuration for the Azure Information Protection scanner.

Set-AIPScannerContentScanJob

Defines settings for an Azure Information Protection content scan job.

Set-AIPScannerRepository

Relevant for: Unified labeling client only. Deprecated for the classic client.

Updates an existing repository in an Azure Information Protection content scan job.

Set-AIPScannerScannedFileTypes

Relevant for: Classic client only, and deprecated.

Sets a list of file types to scan or exclude from scanning by the Azure Information Protection scanner.

Set-MIPNetworkDiscovery

Updates the installation settings for the Network Discovery service.

Set-MIPNetworkDiscoveryConfiguration

Relevant for: AIP unified labeling client only

Sets optional configurations for the Network Discovery service.

Set-RMSServerAuthentication

Relevant for: AIP classic client only

Sets the server mode, which is required for non-interactive sessions.

Start-AIPScan

Relevant for: Unified labeling client only

Instructs the Azure Information Protection scanner to start a one-time scan cycle.

Start-AIPScannerDiagnostics

Relevant for: Unified labeling client only

Starts a series of health checks for a locally installed AIP scanner service.

Start-MIPNetworkDiscovery

Relevant for: AIP unified labeling client only

Instructs the Azure Information Protection scanner to start a network scan job.

Stop-AIPScan

Relevant for: Unified labeling client only

Instructs the Azure Information Protection scanner to stop the currently running scan cycle.

Uninstall-AIPScanner

Relevant for: AIP unified labeling and classic clients

Uninstalls the Windows Server service for the Azure Information Protection scanner.

Uninstall-MIPNetworkDiscovery

Relevant for: AIP unified labeling client only

Uninstalls the Network Discovery Windows server service.

Unprotect-RMSFile

Relevant for: AIP classic client only

Unprotects a file that is currently protected by RMS.

Update-AIPScanner

Updates the database schema for the Azure Information Protection scanner.

Relevant for: AIP unified labeling and classic clients