AADRM

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

Add-AadrmRoleBasedAdministrator

Grants administrative rights to Rights Management.

Add-AadrmSuperUser

Adds a super user to Rights Management.

Add-AadrmTemplate

Creates a Rights Management template.

Clear-AadrmDoNotTrackUserGroup

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

Clear-AadrmSuperUserGroup

Removes the super user group for your organization.

Connect-AadrmService

Connects to Rights Management.

Convert-AadrmKeyToKeyVault

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

Disables Rights Management support for device platforms.

Disable-AadrmDocumentTrackingFeature

Disables document tracking for Rights Management.

Disable-AadrmIPCv3Service

Disables the MSIPC v3 platform for Rights Management.

Disable-AadrmSuperUserFeature

Disables the super user feature.

Disable-AadrmUsageLogFeature

Disables the usage log for Rights Management.

Disconnect-AadrmService

Disconnects from Rights Management.

Enable-Aadrm

Activates Rights Management for your organization.

Enable-AadrmDevicePlatform

Enables Rights Management support for device platforms.

Enable-AadrmDocumentTrackingFeature

Enables document tracking for Rights Management.

Enable-AadrmIPCv3Service

Enables the MSIPC v3 platform for Rights Management.

Enable-AadrmSuperUserFeature

Enables the super user feature for Rights Management.

Enable-AadrmUsageLogFeature

Enables usage logging for Rights Management.

Export-AadrmTemplate

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

Get-Aadrm

Gets the activation status of Rights Management for your organization.

Get-AadrmAdminLog

Generates logs for all Rights Management administrative commands.

Get-AadrmConfiguration

Gets the Rights Management configuration of your tenant.

Get-AadrmDevicePlatform

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

Get-AadrmDoNotTrackUserGroup

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

Get-AadrmDocumentTrackingFeature

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

Get-AadrmIPCv3Service

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

Get-AadrmKeys

Lists all tenant keys associated with your Rights Management tenant.

Get-AadrmMaxUseLicenseValidityTime

Gets the maximum validity time for Rights Management use licenses.

Get-AadrmMigrationUrl

Gets the migration URL for Rights Management.

Get-AadrmOnboardingControlPolicy

Gets user on-boarding control policy for Rights Management.

Get-AadrmRoleBasedAdministrator

Gets the role-based administrators for Rights Management.

Get-AadrmSuperUser

Gets the super users for Rights Management.

Get-AadrmSuperUserFeature

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

Get-AadrmSuperUserGroup

Gets the super user group for Rights Management.

Get-AadrmTemplate

Gets a list of Rights Management templates.

Get-AadrmTemplateProperty

Gets the properties of a Rights Management template.

Get-AadrmUsageLog

Downloads Rights Management logs to local storage.

Get-AadrmUsageLogFeature

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

Get-AadrmUsageLogLastCounterValue

Gets the last counter value for the usage log.

Get-AadrmUsageLogStorageAccount

Gets the location for usage logs.

Get-AadrmUserLog

Downloads Rights Management user logs to local storage.

Import-AadrmTemplate

Creates a custom Rights Management policy template.

Import-AadrmTpd

Imports a TPD from AD RMS for Rights Management.

New-AadrmRightsDefinition

Creates a Rights Definition object for Rights Management.

Remove-AadrmRoleBasedAdministrator

Removes administrative rights from Rights Management.

Remove-AadrmSuperUser

Removes a super user from Rights Management.

Remove-AadrmTemplate

Deletes a Rights Management rights policy template.

Set-AadrmDoNotTrackUserGroup

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

Set-AadrmKeyProperties

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

Set-AadrmMaxUseLicenseValidityTime

Sets the maximum validity time for Rights Management use licenses.

Set-AadrmMigrationUrl

Sets the migration URL for Rights Management.

Set-AadrmOnboardingControlPolicy

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

Set-AadrmSuperUserGroup

Sets the super user group for Rights Management.

Set-AadrmTemplateProperty

Updates a property or properties of a Rights Management template.

Set-AadrmUsageLogStorageAccount

Sets the location for Rights Management usage logs.

Use-AadrmKeyVaultKey

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