A​AD​RM

This topic displays help topics for the cmdlets that administer the Azure Rights Management (Azure RMS) service for Azure Information Protection.

These PowerShell cmdlets for Azure RMS let you administer the Azure Rights Management service from the command line. Although this enables automation, it also supports reliable and repeated processes to help reduce administrative overheads. In addition, advanced configurations and some operations require PowerShell.

For more information about when you must use these PowerShell cmdlets and to see groupings of cmdlets by administration tasks, see Administering the Azure Rights Management service by Using Windows PowerShell.

Tip

If you do not see the cmdlet or options that are documented, make sure that you have downloaded the latest version of the module.

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

The .dll file for this module is Microsoft.RightsManagementServices.Online.Admin.PowerShell.dll.

AADRM

Aadrm​Do​Not​Track​User​Group

Gets the group for the users who must not be tracked by Rights Management.

Add-​Aadrm​Role​Based​Administrator

Grants administrative rights to Rights Management.

Add-​Aadrm​Super​User

Adds a super user to Rights Management.

Add-​Aadrm​Template

Creates a Rights Management template.

Clear-​Aadrm​Do​Not​Track​User​Group

Clears the group for the users who must not be tracked by Rights Management.

Clear-​Aadrm​Super​User​Group

Removes the super user group for your organization.

Connect-​Aadrm​Service

Connects to Rights Management.

Convert-​Aadrm​Key​To​Key​Vault

Changes the location of a legacy customer-managed key in Azure Rights Management with the location of a customer-managed key in Azure Key Vault.

Disable-​Aadrm

Deactivates Rights Management.

Disable-​Aadrm​Device​Platform

Disables Rights Management support for device platforms.

Disable-​Aadrm​Document​Tracking​Feature

Disables document tracking for Rights Management.

Disable-​Aadrm​IP​Cv3​Service

Disables the MSIPC v3 platform for Rights Management.

Disable-​Aadrm​Super​User​Feature

Disables the super user feature.

Disable-​Aadrm​Usage​Log​Feature

Disables the usage log for Rights Management.

Disconnect-​Aadrm​Service

Disconnects from Rights Management.

Enable-​Aadrm

Activates Rights Management for your organization.

Enable-​Aadrm​Device​Platform

Enables Rights Management support for device platforms.

Enable-​Aadrm​Document​Tracking​Feature

Enables document tracking for Rights Management.

Enable-​Aadrm​IP​Cv3​Service

Enables the MSIPC v3 platform for Rights Management.

Enable-​Aadrm​Super​User​Feature

Enables the super user feature for Rights Management.

Enable-​Aadrm​Usage​Log​Feature

Enables usage logging for Rights Management.

Export-​Aadrm​Template

Exports the properties of a rights policy template to a file.

Get-​Aadrm

Gets the activation status of Rights Management for your organization.

Get-​Aadrm​Admin​Log

Generates logs for all Rights Management administrative commands.

Get-​Aadrm​Configuration

Gets the Rights Management configuration of your tenant.

Get-​Aadrm​Device​Platform

Gets the device platforms in your organization that support Rights Management.

Get-​Aadrm​Document​Tracking​Feature

Indicates whether document tracking is enabled or disabled for Rights Management.

Get-​Aadrm​IP​Cv3​Service

Displays whether the MSIPC v3 service is enabled or disabled for Rights Management.

Get-​Aadrm​Keys

Lists all tenant keys associated with your Rights Management tenant.

Get-​Aadrm​Max​Use​License​Validity​Time

Gets the maximum validity time for Rights Management use licenses.

Get-​Aadrm​Migration​Url

Gets the migration URL for Rights Management.

Get-​Aadrm​Onboarding​Control​Policy

Gets user on-boarding control policy for Rights Management.

Get-​Aadrm​Role​Based​Administrator

Gets the role-based administrators for Rights Management.

Get-​Aadrm​Super​User

Gets the super users for Rights Management.

Get-​Aadrm​Super​User​Feature

Gets the status of the super user feature for Rights Management.

Get-​Aadrm​Super​User​Group

Gets the super user group for Rights Management.

Get-​Aadrm​Template

Gets a list of Rights Management templates.

Get-​Aadrm​Template​Property

Gets the properties of a Rights Management template.

Get-​Aadrm​Usage​Log

Downloads Rights Management logs to local storage.

Get-​Aadrm​Usage​Log​Feature

Deprecated: Gets the status of legacy usage logging for Rights Management.

Get-​Aadrm​Usage​Log​Last​Counter​Value

Gets the last counter value for the usage log.

Get-​Aadrm​Usage​Log​Storage​Account

Gets the location for usage logs.

Get-​Aadrm​User​Log

Downloads Rights Management user logs to local storage.

Import-​Aadrm​Template

Creates a custom Rights Management policy template.

Import-​Aadrm​Tpd

Imports a TPD from AD RMS for Rights Management.

New-​Aadrm​Rights​Definition

Creates a Rights Definition object for Rights Management.

Remove-​Aadrm​Role​Based​Administrator

Removes administrative rights from Rights Management.

Remove-​Aadrm​Super​User

Removes a super user from Rights Management.

Remove-​Aadrm​Template

Deletes a Rights Management rights policy template.

Set-​Aadrm​Do​Not​Track​User​Group

Sets a group for the users who must not be tracked by Rights Management.

Set-​Aadrm​Key​Properties

Updates the properties of a tenant key object for Rights Management.

Set-​Aadrm​Max​Use​License​Validity​Time

Sets the maximum validity time for Rights Management use licenses.

Set-​Aadrm​Migration​Url

Sets the migration URL for Rights Management.

Set-​Aadrm​Onboarding​Control​Policy

Sets the user on-boarding control policy for Rights Management.

Set-​Aadrm​Super​User​Group

Sets the super user group for Rights Management.

Set-​Aadrm​Template​Property

Updates a property or properties of a Rights Management template.

Set-​Aadrm​Usage​Log​Storage​Account

Sets the location for Rights Management usage logs.

Use-​Aadrm​Key​Vault​Key

Tells Rights Management to use a customer-managed tenant key in Azure Key Vault.