AIPService Module
This page displays help links for the cmdlets that administer the protection service from Azure Information Protection.
Note
This module replaces the older module, AADRM. Support for the AADRM module ended on July 15, 2020. Update to the latest version to ensure that your AIPService module is compliant with upcoming TLS 1.2 enforcement.
These PowerShell cmdlets let you administer Azure Information Protection from the command line. Although this administration method enables automation, it also supports reliable and repeated processes to help reduce administrative overheads. In addition, advanced configurations and some operations require this PowerShell module.
For more information about when you must use PowerShell cmdlets and to see groupings of cmdlets by administration tasks, see Administering the protection service from Azure Information Protection by using PowerShell.
Current version: The current version of this module is 3.0.0.1.
To check the version you have installed, run:
(Get-Module AIPService -ListAvailable).VersionIf 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 AIPService.dll.
Prerequisites: For a list of prerequisites for installing this module, see Installing the AIPService PowerShell module.
Protection templates and the AIP unified labeling client
The Azure Information Protection unified labeling client uses protection templates indirectly. If you have the unified labeling client, we recommend that you use label-based cmdlets instead of modifying your protection templates directly.
For more information, see:
AIPService cmdlets
| Cmdlet | Descrizione |
|---|---|
| Add-AipServiceRoleBasedAdministrator |
Grants administrative rights to Azure Information Protection. |
| Add-AipServiceSuperUser |
Adds a super user to Azure Information Protection. |
| Add-AipServiceTemplate |
Creates a protection template for Azure Information Protection. |
| Clear-AipServiceDocumentRevoked |
Unrevokes a specified, protected document that currently has a revoke status. |
| Clear-AipServiceDoNotTrackUserGroup |
Clears the group for the users who must not be tracked by Azure Information Protection. |
| Clear-AipServiceSuperUserGroup |
Removes the super user group for Azure Information Protection. |
| Connect-AipService |
Connects to Azure Information Protection. |
| Convert-AipServiceKeyToKeyVault |
Changes the location of a legacy customer-managed key in Azure Information Protection with the location of a customer-managed key in Azure Key Vault. |
| Disable-AipService |
Deactivates the protection service from Azure Information Protection. |
| Disable-AipServiceDevicePlatform |
Disables protection support from Azure Information Protection for device platforms. |
| Disable-AipServiceDocumentTrackingFeature |
Turns off document tracking for Azure Information Protection. |
| Disable-AipServiceIPCv3 |
Disables the MSIPC v3 platform for Azure Information Protection. |
| Disable-AipServiceSuperUserFeature |
Disables the super user feature for Azure Information Protection. |
| Disconnect-AipService |
Disconnects from Azure Information Protection. |
| Enable-AipService |
Activates the protection service for Azure Information Protection. |
| Enable-AipServiceDevicePlatform |
Enables protection support from Azure Information Protection for device platforms. |
| Enable-AipServiceDocumentTrackingFeature |
Turns on document track and revoke features for Azure Information Protection. |
| Enable-AipServiceIPCv3 |
Enables the MSIPC v3 platform for Azure Information Protection. |
| Enable-AipServiceSuperUserFeature |
Enables the super user feature for Azure Information Protection. |
| Export-AipServiceTemplate |
Exports the properties of a protection template from Azure Information Protection to a file. |
| Get-AipService |
Gets the activation status of the protection service from Azure Information Protection. |
| Get-AipServiceAdminLog |
Generates logs for all protection commands for Azure Information Protection. |
| Get-AipServiceConfiguration |
Gets the Azure Information Protection configuration of your tenant. |
| Get-AipServiceDevicePlatform |
Gets the device platforms in your organization that support the protection service from Azure Information Protection. |
| Get-AipServiceDocumentLog |
Gets protection information about documents that are tracked by Azure Information Protection. This cmdlet is supported by both the Azure Information Protection classic and unified labeling clients, with different usage, as described below. |
| Get-AipServiceDocumentTrackingFeature |
Indicates whether document tracking is enabled or disabled for Azure Information Protection. |
| Get-AipServiceDoNotTrackUserGroup |
Gets the group for the users who must not be tracked by Azure Information Protection. |
| Get-AipServiceIPCv3 |
Displays whether the MSIPC v3 service is enabled or disabled for Azure Information Protection. |
| Get-AipServiceKeys |
Lists all Azure Information Protection tenant keys associated with your tenant. |
| Get-AipServiceMaxUseLicenseValidityTime |
Gets the maximum validity time for Rights Management use licenses from Azure Information Protection. |
| Get-AipServiceMigrationUrl |
Gets the migration URL for Azure Information Protection. |
| Get-AipServiceOnboardingControlPolicy |
Gets the user on-boarding control policy for Azure Information Protection. |
| Get-AipServiceRoleBasedAdministrator |
Gets the role-based administrators for Azure Information Protection. |
| Get-AipServiceSuperUser |
Gets the super users for Azure Information Protection. |
| Get-AipServiceSuperUserFeature |
Gets the status of the super user feature for Azure Information Protection. |
| Get-AipServiceSuperUserGroup |
Gets the super user group for Azure Information Protection. |
| Get-AipServiceTemplate |
Gets a list of protection templates for Azure Information Protection. |
| Get-AipServiceTemplateProperty |
Gets the properties of a protection template for Azure Information Protection. |
| Get-AipServiceTrackingLog |
Gets tracking information for documents protected by Azure Information Protection. This cmdlet is supported by both the Azure Information Protection classic and unified labeling clients, with different usage, as described below. |
| Get-AipServiceUserLog |
Downloads protection user logs from Azure Information Protection to local storage. |
| Import-AipServiceTemplate |
Creates a custom protection template for Azure Information Protection. |
| Import-AipServiceTpd |
Imports a TPD from AD RMS for Azure Information Protection. |
| New-AipServiceRightsDefinition |
Creates a rights definition object for a protection template for Azure Information Protection. |
| Remove-AipServiceRoleBasedAdministrator |
Removes administrative rights from Azure Information Protection. |
| Remove-AipServiceSuperUser |
Removes a super user from Azure Information Protection. |
| Remove-AipServiceTemplate |
Deletes a protection template for Azure Information Protection. |
| Set-AipServiceDocumentRevoked |
Revokes access for specified users, to a specified tracked and protected document. |
| Set-AipServiceDoNotTrackUserGroup |
Sets a group for the users who must not be tracked by Azure Information Protection. |
| Set-AipServiceKeyProperties |
Updates the properties of a tenant key object for Azure Information Protection. |
| Set-AipServiceMaxUseLicenseValidityTime |
Sets the maximum validity time for Rights Management use licenses for Azure Information Protection. |
| Set-AipServiceMigrationUrl |
Sets a migration URL for Azure Information Protection. |
| Set-AipServiceOnboardingControlPolicy |
Sets the user on-boarding control policy for Azure Information Protection. |
| Set-AipServiceSuperUserGroup |
Sets the super user group for Azure Information Protection. |
| Set-AipServiceTemplateProperty |
Updates a property or properties of a protection template for Azure Information Protection. |
| Use-AipServiceKeyVaultKey |
Tells Azure Information Protection to use a customer-managed tenant key in Azure Key Vault. |