AzureInformationProtection

The following list contains links to the help for the Microsoft Azure Information Protection (AIP) cmdlets, which are installed with the Azure Information Protection client (classic) and the Azure Information Protection unified labeling client. Not sure of the differences between these two clients?

  • For the Azure Information Protection client (classic): The cmdlets let you protect and unprotect files, label files, and get information about files that are protected and labeled. These cmdlets are installed with the Azure Information Protection client and can be used with Azure Information Protection, the protection service (Azure Rights Management) for Azure Information Protection, and Active Directory Rights Management Services (AD RMS).

    The current general availability version of the AzureInformationProtection module for this client is 1.54.33.0. You might have a later version if you have installed a preview version. For release details, see the client version release history.

  • For the Azure Information Protection unified labeling client: The cmdlets let you label files and get information about files that are labeled. These cmdlets are installed with the Azure Information Protection unified labeling client and can be used with Azure Information Protection only.

    The current general availability version of the AzureInformationProtection module for this client is 2.5.33.0. You might have a later version if you have installed a preview version. For release details, see the unified client version release history.

To check the version that you have installed, run the following command: (Get-Module AzureInformationProtection -ListAvailable).Version.

For instructions to use these cmdlets, any current limitations, prerequisites, and scenario examples, see the following documentation from the administrator guides:

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

AzureInformationProtection

Add-AIPScannerRepository

Deprecated: Adds a data repository to be scanned by the Azure Information Protection scanner.

Add-AIPScannerScannedFileTypes

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

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

Clear-RMSAuthentication

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

Export-AIPLogs

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

Get-AIPFileStatus

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

Get-AIPScannerConfiguration

Gets the configuration settings for the Azure Information Protection scanner.

Get-AIPScannerRepository

Deprecated: Gets a list of data repositories that the Azure Information Protection scanner is configured to scan.

Get-AIPScannerStatus

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

Get-RMSFileStatus

Gets the RMS protection status of a specified file.

Get-RMSServer

Gets a list of RMS servers that can issue templates.

Get-RMSServerAuthentication

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

Get-RMSTemplate

Gets a list of RMS templates.

Install-AIPScanner

Installs the Azure Information Protection scanner.

New-AIPCustomPermissions

Creates an ad-hoc protection policy for custom permissions.

New-RMSProtectionLicense

Creates an ad-hoc protection policy for RMS protection.

Protect-RMSFile

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

Remove-AIPScannerRepository

Deprecated: Removes a data repository for the Azure Information Protection scanner.

Remove-AIPScannerScannedFileTypes

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

Sets the authentication credentials for the Azure Information Protection client.

Set-AIPFileClassification

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

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

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

Set-AIPScannerConfiguration

Sets optional configuration for the Azure Information Protection scanner.

Set-AIPScannerRepository

Deprecated: Updates a profile of configuration settings for a data repository to be scanned by the Azure Information Protection scanner.

Set-AIPScannerScannedFileTypes

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

Set-RMSServerAuthentication

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

Start-AIPScan

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

Uninstall-AIPScanner

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

Unprotect-RMSFile

Unprotects a file that is currently protected by RMS.

Update-AIPScanner

Updates the database schema for the Azure Information Protection scanner.