AzureInformationProtection

The following lists links to documentation for the Microsoft Azure Information Protection (AIP) cmdlets. These cmdlets are installed with both the Azure Information Protection classic client and the Azure Information Protection unified labeling client. Not sure of the differences between these two clients?

Client cmdlet descriptions
Classic client cmdlets Classic client cmdlets enable you to 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 classic client and are supported for:

- Azure Information Protection
The Azure Rights Management service for Azure Information Protection
- Active Directory Rights Management Services (AD RMS)

For release details, see the classic client version release history.
Unified labeling cmdlets Unified labeling cmdlets enable you to label files and get information about files that labeled.
These cmdlets are installed with the Azure Information Protection unified labeling client and are supported for Azure Information Protection only.

For release details, see the unified client version release history.

Tip

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

For more information, see:

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

AzureInformationProtection

Add-AIPScannerRepository

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

Add-AIPScannerScannedFileTypes

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

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-MIPNetworkDiscoveryConfiguration

Gets configuration settings for the Network Discovery service.

Get-MIPNetworkDiscoveryJobs

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

Get-MIPNetworkDiscoveryStatus

Gets the current status of the Network Discovery service.

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.

Import-AIPScannerConfiguration

Imports local configuration for the Azure Information Protection scanner.

Import-MIPNetworkDiscoveryConfiguration

Imports a local configuration for Network Discovery network scan jobs.

Install-AIPScanner

Installs the Azure Information Protection scanner.

Install-MIPNetworkDiscovery

Installs the Network Discovery service.

New-AIPCustomPermissions

Creates an ad-hoc protection policy for custom permissions.

New-RMSProtectionLicense

Creates an ad-hoc rights policy for RMS protection.

Protect-RMSFile

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

Remove-AIPScannerRepository

Removes a data repository for the Azure Information Protection scanner.

Remove-AIPScannerScannedFileTypes

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

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

Set-AIPScannerScannedFileTypes

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

Set-MIPNetworkDiscoveryConfiguration

Sets optional configurations for the Network Discovery service.

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.

Start-AIPScannerDiagnostics

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

Start-MIPNetworkDiscovery

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

Stop-AIPScan

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

Uninstall-AIPScanner

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

Uninstall-MIPNetworkDiscovery

Uninstalls the Network Discovery Windows server service.

Unprotect-RMSFile

Unprotects a file that is currently protected by RMS.

Update-AIPScanner

Updates the database schema for the Azure Information Protection scanner.