ConfigurationManager object

The ConfigurationManager object is the top-level object in the AD RMS scripting API. It can be used to initiate a connection with the AD RMS server and to retrieve the following objects:

Members

The ConfigurationManager object has these types of members:

Methods

The ConfigurationManager object has these methods.

Method Description
Initialize Initializes the administration environment, connects to the AD RMS server, and retrieves the appropriate role.
IsInRoles Retrieves a Boolean value that specifies whether a role is permitted.

Properties

The ConfigurationManager object has these properties.

Property Description
AuditReport
Retrieves an AuditReport object that can be used to obtain the number of federated and domain user accounts.
ClusterInformation
Retrieves a ClusterInformation object that contains cluster configuration information.
Constants
Retrieves a Constants object that contains common constant values supported by the AD RMS service.
Enterprise
Retrieves an Enterprise object that can be used for enterprise administration.
IsServerOnLocalMachine
Retrieves a Boolean value that specifies whether the client and server are on the same computer.
RightsTemplatePolicy
Retrieves a RightsTemplatePolicy object that can be used to manage AD RMS rights templates.
Roles
Retrieves a value that identifies the role.
ServiceIdentity
Retrieves a ServiceIdentity object that can be used to manage an AD RMS service account.

Examples

DIM config_manager
DIM admin_role

' *******************************************************************
' Create and initialize a ConfigurationManager object.

SUB InitObject()

  CALL WScript.Echo( "Create ConfigurationManager object...")
  SET config_manager = CreateObject _
    ("Microsoft.RightsManagementServices.Admin.ConfigurationManager")      
  CheckError()
    
  CALL WScript.Echo( "Initialize...")
  admin_role=config_manager.Initialize(false,"localhost",80,"","","")
  CheckError()

END SUB

' *******************************************************************
' Error checking function.

FUNCTION CheckError()
  CheckError = Err.number
  IF Err.number <> 0 THEN
    CALL WScript.Echo( vbTab & "*****Error Number: " _
                       & Err.number _
                       & " Desc:" _
                       & Err.Description _
                       & "*****")
    WScript.StdErr.Write(Err.Description)
    WScript.Quit( Err.number )
  END IF
END FUNCTION

' *******************************************************************
' Generate a runtime error.

SUB RaiseError(errId, desc)
  CALL Err.Raise( errId, "", desc )
  CheckError()
END SUB

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2008
Assembly
Microsoft.RightsManagementServices.Admin.dll

See also

Active Directory Rights Management Services Scripting API Reference