Administering Azure Rights Management by Using Windows PowerShell

Carol Bailey
Contributors

Applies to: Azure Rights Management, Office 365

Although you can activate Microsoft Azure Rights Management (Azure RMS) by using the Office 365 admin center or the Azure classic portal, you can also use the Windows PowerShell module for Azure Rights Management (AADRM) to do this.

After you have activated Rights Management, further administration for the service might not be required. However, some advanced configuration scenarios might require you to use the Windows PowerShell module for Azure Rights Management. The following table lists some of the advanced configuration scenarios that use Windows PowerShell. For a complete list of the available cmdlets with more information about each one, see Azure Rights Management Cmdlets.

Note

If you need to install the Windows PowerShell module for Rights Management, see Installing Windows PowerShell for Azure Rights Management.

There is also a supplemental Windows PowerShell module, RMSProtection, which supports both Azure RMS and AD RMS. This module supports protecting and removing protection from multiple files so that, for example, you can bulk-protect all files in a folder. For more information, see the Scripting options for super users section in the Configuring super users for Azure Rights Management and discovery services or data recovery article.

If you need to… …use the following cmdlets
Migrate from on-premises Rights Management (AD RMS or Windows RMS) to Rights Management. Import-AadrmTpd
Connect to or disconnect from the Rights Management service for your organization. Connect-AadrmService

Disconnect-AadrmService
Generate and manage your own tenant key – the bring your own key (BYOK) scenario. Use-AadrmKeyVaultKey

Get-AadrmKeys
Activate or deactivate the Rights Management service for your organization. Enable-Aadrm

Disable-Aadrm
Disable or enable the document tracking site for Azure Rights Management. Disable-AadrmDocumentTrackingFeature

Enable-AadrmDocumentTrackingFeature

Get-AadrmDocumentTrackingFeature
Configure onboarding controls for a phased deployment of Azure Rights Management. Get-AadrmOnboardingControlPolicy

Set-AadrmOnboardingControlPolicy
Create and manage rights policy templates for your organization. Add-AadrmTemplate

Export-AadrmTemplate

Get-AadrmTemplate

Get-AadrmTemplateProperty

Import-AadrmTemplate

New-AadrmRightsDefinition

Remove-AadrmTemplate

Set-AadrmTemplateProperty
Configure the maximum number of days that content that your organization protects can be accessed without an Internet connection (the use license validity period). Get-AadrmMaxUseLicenseValidityTime

Set-AadrmMaxUseLicenseValidityTime
Manage the super user feature of Rights Management for your organization. Enable-AadrmSuperUserFeature

Disable-AadrmSuperUserFeature

Add-AadrmSuperUser

Get-AadrmSuperUser

Remove-AadrmSuperUser

Set-AadrmSuperUserGroup

Get-AadrmSuperUserGroup

Clear-AadrmSuperUserGroup
Manage users and groups who are authorized to administer the Rights Management service for your organization. Add-AadrmRoleBasedAdministrator

Get-AadrmRoleBasedAdministrator

Remove-AadrmRoleBasedAdministrator
Get a log of Rights Management administrative tasks for your organization. Get-AadrmAdminLog
Log and analyze usage logging for Rights Management. Get-AadrmUserLog
Display the current Rights Management service configuration for your organization. Get-AadrmConfiguration
Migrate your organization from Azure Rights Management to an on-premises AD RMS deployment. Set-AadrmMigrationUrl

Get-AadrmMigrationUrl