Installing Windows PowerShell for Azure Rights Management

Applies to: Azure Information Protection, Office 365

Use the following information to help you install the Windows PowerShell module for the Azure Rights Management service from Azure Information Protection.

You can use this PowerShell module to administer the Azure Rights Management service from the command line by using any computer that has an Internet connection and that meets the prerequisites listed in the next section. Windows PowerShell for Azure Rights Management supports scripting for automation or might be necessary for advanced configuration scenarios. For more information about the administration tasks and configurations that the module supports, see Administering Azure Rights Management by Using Windows PowerShell.

Prerequisites

This table lists the prerequisites to install and use Windows PowerShell for Azure Rights Management.

Requirement More information
A version of Windows that supports the Rights Management administration module Check the list of supported operating systems in the System Requirements section of the download page for the Azure Rights Management Administration Tool.
Minimum version of Windows PowerShell: 2.0

By default, most Windows operating systems install with at least version 2.0 of Windows PowerShell. If you need to install this minimum supported version, see Install Windows PowerShell 2.0.

Tip: You can confirm the version of Windows PowerShell that you are running by typing $PSVersionTable in a PowerShell session.

If you have this minimum version, you will need to manually load the module in your PowerShell session by running Import-Module AADRM before you can use any cmdlet from the Rights Management administration module. When you have Windows PowerShell v3 and later, the module loads automatically and you do not need this extra command.
Minimum version of the Microsoft .NET Framework: 4.5

Note: This version of the Microsoft .NET Framework is included with the later operating systems, so you should need to manually install it only if your client operating system is less than Windows 8.0 or your server operating system is less than Windows Server 2012.
If the minimum version of the Microsoft .NET Framework is not already installed, you can download Microsoft .NET Framework 4.5.

This minimum version of the Microsoft .NET Framework is required for some of the classes that the Rights Management administration module uses.
Note

Starting with version 2.5.0.0 of the Rights Management administration module, the Microsoft Online Services Sign-In Assistant is no longer required.

If you had a previous version of the Rights Management administration module installed, use Programs and Features to uninstall Windows Azure AD Rights Management Administration before you install the latest version.

How to install the Rights Management administration module

  1. Go to the Microsoft Download Center and download the Azure Rights Management Administration Tool, which contains the Azure Rights Management administration module for Windows PowerShell.

  2. From the local folder where you downloaded and saved the Rights Management installer file, double-click the executable file that you downloaded for your platform (WindowsAzureADRightsManagementAdministration_x64 or WindowsAzureADRightsManagementAdministration_x86.exe) to start the Azure AD Rights Management Administration Setup Wizard.

  3. Complete the wizard.

Windows PowerShell for Azure Rights Management is now installed.

Next steps

Start a Windows PowerShell session and confirm the version of the installed module. This check is particularly important if you upgraded from an older version:

(Get-Module AADRM –ListAvailable).Version

Note: If this command fails, first run Import-Module AADRM.

To see which cmdlets are available, type the following:

Get-Command -Module AADRM

Use the Get-Help <cmdlet_name> command to see the Help for a specific cmdlet, and use the -online parameter to see the latest help on the Microsoft documentation site. For example:

Get-Help Connect-AadrmService -online

For more information:

Before you can run any commands that configure the Azure Rights Management service, you must connect to the service by using the Connect-AadrmService cmdlet.

When you have finished running your configuration commands, as a best practice, disconnect from the service by using the Disconnect-AadrmService cmdlet. If you do not disconnect, the connection is automatically disconnected after a period of inactivity. Because of the automatic disconnection behavior, you might find that you need to occasionally reconnect in a PowerShell session.

Note

If the Azure Rights Management service is not yet activated, you can do this after you have connected to the service, by using the Enable-Aadrm cmdlet.

Comments

Before commenting, we ask that you review our House rules.