Set-​RM​SServer​Authentication

Sets the service principal authentication credentials for Azure RMS.

Syntax

Set-RMSServerAuthentication
   -AppPrincipalId <String>
   -BposTenantId <String>
   -Key <String>
   [<CommonParameters>]

Description

The Set-RMSServerAuthentication cmdlet specifies identifiers for a service principal to authenticate with Azure RMS, so that you can then protect or unprotect files by using Azure RMS. Use a service principal when you need to protect or unprotect files without interaction, for example, a script that automatically protects files on a file server. You need run this command just one time for your Windows PowerShell session.

This cmdlet is for Azure RMS only and is not used for AD RMS. This cmdlet also does not apply if you are authenticating to Azure RMS by using your user account. For more information about this cmdlet and how to get the identifiers that it requires, see about_RMSProtection_AzureRMS.

Examples

Example 1: Set the service principal authentication credentials for Azure RMS

PS C:\>Set-RMSServerAuthentication -BposTenantId "23976bc6-dcd4-4173-9d96-dad1f48efd42" -Key "zIeMu8zNJ6U377CLtppkhkbl4gjodmYSXUVwAO5ycgA=" -AppPrincipalId "b5e3f76a-b5c2-4c96-a594-a0807f65bba4"
The RmsServerAuthentication is set to ON

This command sets the service principle authentication credentials for Azure RMS, by specifying the required three identifiers for a previously created service principal.

Required Parameters

-AppPrincipalId

Specifies the AppPrincipalId value of the service principal.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-BposTenantId

Specifies the BposTenantId value (the tenant ID) to which the service principal belongs.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Key

Specifies the symmetric key value for the service principal.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False