User Documentation
  • Product Information
    • Overview
    • Architecture
    • Security
    • Key Features
    • Supported Systems
    • Comparison
  • Installation
    • Download VirtualMetric
    • Install a VirtualMetric Server
    • Activate Product
    • Update From Previous Versions
    • Uninstall VirtualMetric
  • Releases
    • Version 8.0.3
  • Server Pre-Configuration
    • Windows
    • VMware
    • Linux
    • Bare Metal Hardware
  • Settings
    • Users
      • User Operations
        • Add New User
        • Edit User
        • Device Permissions
        • Login as Other User
        • Remove User
      • User Group Operations
        • Add New User Group
        • Assign Member
        • Device Permission
        • Edit User Group
        • Remove User Group
      • API Users Operations
        • Add New API User
        • Edit API User
        • Device Permission
        • Remove API User
      • Organization Operations
        • Add New Organization
        • Edit Organization
        • Device Permission
        • Login as Other Organization
        • Remove Organization
      • Credential Store
        • Add New Credential Store
        • Edit Credential Store
        • Remove Credential Store
      • Group Based AD Authentication
    • Devices
      • Server Operations
        • Add New Server
        • Assign Module
        • Edit Server
        • Remove Server
        • Restore Server
        • Connectivity Issues
        • Bulk Update
      • Cluster Operations
        • Add New Cluster
        • Assign Module
        • Sync a Cluster
        • Edit Cluster
        • Remove Cluster
        • Connectivity Issues
        • Bulk Update
      • Workstation Operations
        • Add New Workstation
        • Edit Workstation
        • Remove Workstation
      • Manager Operations
        • Add New Manager
        • Assign Module
        • Sync Manager
        • Edit Manager
        • Remove Manager
        • Connectivity Issues
        • Bulk Update
      • Network Devices Operations
        • Add Network Device
        • Edit Network Device
        • Remove Network Device
        • Connectivity Issues
        • Bulk Update
      • Trigger Operations
        • Add New Trigger
        • Assign Server
        • Edit Trigger
        • Change API User
        • Change Service User
        • Remove Trigger
        • Enable Debug
      • Device Group Operations
        • Add New Device Group
        • Assign Member
        • Edit Device Group
        • Remove Device Group
      • Datacenter Operations
        • Add New Datacenter
        • Assign Member
        • Edit Datacenter
        • Remove Datacenter
      • Permission Operations
        • Add/Remove Permission
    • Listeners
      • Listener Operations
        • Add a New Listener
          • Add a Syslog Listener
          • Add a Flow Endpoints
          • Add a eStreamer
          • Add a TFTP Listener
          • Add a TCP Listener
          • Add a UDP Listener
          • Add a HTTP Listener
          • Add a SMTP Listener
          • Add a SNMP Trap Listener
          • Add a Redis Consumer
          • Add a Kafka Consumer
          • Add a RabbitMQ Consumer
          • Add a NATS Consumer
        • Edit Listener
        • Remove Listener
    • Services
      • Location Operations
        • Add new Location
        • Edit Location
        • Remove Location
      • Web Sites Operations
        • Add new Website
        • Assign Location
        • Edit Web Sites
        • Remove Web Sites
      • DNS Operations
        • Add new DNS
        • Edit DNS
        • Remove DNS
      • ICMP Operations
        • Add new ICMP
        • Edit ICMP
        • Remove ICMP
      • IPAM Operations
        • Add new IPAM
        • Edit IPAM
        • Remove IPAM
      • TCP Operations
        • Add new TCP
        • Edit TCP
        • Remove TCP
      • Database Operations
        • Add new Database
        • Edit Database
        • Remove Database
    • Notifications
      • Rules Operations
        • Add new Rules
        • Edit Rule
        • Adding Dependency
        • Filtering Rules
        • Assign Action
        • Remove Rule
      • Knowledge Base Operations
        • Add new Knowledge Base
        • Edit Knowledge Base
        • Remove Knowledge Base
      • Action Operations
        • Add new Action
        • Testing Action
        • Edit Action
        • Remove Action
      • Scheduled Report Operation
        • Edit Scheduled Report
        • Remove Scheduled Report
      • STMP Settings
      • SMS Settings
    • Collectors
      • Definitions Operations
      • Module Defaults Operations
      • Device Bindings Operations
    • Logs
      • Definitions Operations
        • Understand Definition Fields
        • Edit Definition
        • Bulk Update
        • Reset Definition
      • Custom Definition Operations
        • Add Custom Definition
        • Edit Custom Definition
        • Remove Custom Definition
      • Module Defaults
        • Assign Definition
        • Reset Module Defaults
      • Device Bindings
        • Assign Definition
        • Reset Device Bindings
    • Statistics
      • Logging Types
        • Understanding Logging Types
        • Edit Logging Type
        • Reset Logging Type
      • System Counters
        • Understanding System Counter
        • Edit System Counter
        • Reset System Counter
      • Custom Counters
        • Understanding Custom Counter
        • Edit Custom Counter
        • Reset Custom Counter
    • Systems
      • System Logs
      • System Health
      • Advanced Settings
    • Azure Active Directory Integration
  • Dashboard
    • Main Page
    • Login
    • Layout and Common Functions
    • Calculation of Recommendations
    • Add New Widget
    • Edit Widget
    • Charts
    • White Labeling
  • Devices
    • Layout and Common Functions
  • Analytics
    • Layout and Common Functions
  • Modules and Audit
    • VirtualMetric Modules
      • Bare Metal
      • Microsoft Hyper-V
      • VMware
      • Microsoft IIS
      • Microsoft SQL
      • Microsoft Storage Spaces
      • Active Directory User Permissions
    • Audit Configuration
Powered by GitBook
On this page
  1. Settings

Azure Active Directory Integration

PreviousAdvanced SettingsNextMain Page

Last updated 6 months ago

VirtualMetric supports Azure Active Directory authentication for user authentications.

You can allow access to your Azure Active Directory users by configuring "App Registration" in your Azure Active Directory, and enabling azureStatus in your web.config file.

1. First, navigate to the ControlPanel directory and open web.config:

C:\Program Files\VirtualMetric\ControlPanel\Web.config

2. Find azureStatus in the appSettings section and change it as true, and restart the VirtualMetric API from IIS Manager:

    <appSettings>
    <add key="primaryApiUrl" value="https://api.virtualmetric.com/API/" />
    <add key="failoverApiUrl" value="" />
    <add key="triggerId" value="3080487f-f3f6-43e2-bd27-7f1886a12816" />
    <add key="apiUser" value="vmapi" />
    <add key="apiPassword" value="727c9b3a51eb3407c7cc21c45d84bb28" />
    <add key="azureStatus" value="true" />
    </appSettings>

3. After enabling azureStatus, you will see the Sign in with Microsoft button on the logon screen:

4. Now you need to register the application in Azure Portal. You can follow the steps below to create an application registration.

5. Click on Microsoft Entra ID

6. Navigate to App Registrations and click the New Registration button.

7. Type your application name and select an account type. You need to type VirtualMetric API's address for Redirect URI. Complete the registration by clicking the Register button.

8. After registering the application, enable Access Token and ID Token grants under the Authentication options.

9. Add an optional email claim under token configuration.

10. Add your role configuration under the appRoles section, and save the manifest file.

The completed configuration should look like this:

"appRoles": [
	{
		"allowedMemberTypes": [
			"User"
		],
		"description": "Users with readonly access",
		"displayName": "VirtualMetricUserRole",
		"id": "18d14569-c3bd-439b-9a66-3a2aee01d14c",
		"isEnabled": true,
		"lang": null,
		"origin": "Application",
		"value": "VirtualMetricUserRole"
	},
	{
		"allowedMemberTypes": [
			"User"
		],
		"description": "Users with admin access",
		"displayName": "VirtualMetricAdminRole",
		"id": "18d14569-c3bd-439b-9a66-3a2aee01d14f",
		"isEnabled": true,
		"lang": null,
		"origin": "Application",
		"value": "VirtualMetricAdminRole"
	},
	{
		"allowedMemberTypes": [
			"User"
		],
		"description": "msiam_access",
		"displayName": "msiam_access",
		"id": "b9632174-c057-4f7e-951b-be3adc52bfe6",
		"isEnabled": true,
		"lang": null,
		"origin": "Application",
		"value": null
	}
],

11. Note the Application (client) ID, Directory (tenant) ID, and RedirectURI parameters. You will update the appropriate fields in Advanced Settings.

12. In Advanced Settings, search for Azure and you will see the Azure Active Directory settings. Set Azure Active Directory Client ID, Azure Active Directory Tenant ID, and Azure Active Directory Redirect Uri variables as per the table below.

Advanced Settings Title
Mapping Title

Azure Active Directory Client ID

Application (client) ID

Azure Active Directory Tenant ID

Directory (tenant) ID

Azure Active Directory Redirect Uri

RedirectURI

Visibility of Azure Active Directory Elements should be Active

After setting the parameters, you should reset IIS with iisreset on the dashboard servers.

13. Create the user groups for VirtualMetric under Microsoft Azure -> User Groups.

14. Add the roles you have written to the manifest file.

15. Now go back to Azure and click on Enterprise Applications.

15. Under All Applications, search for and click on the application related to VirtualMetric.

16. Now you can add a user to the group and test it.

16. Add your user and role, and then click on assign.

17. Now you can navigate to the Logon Screen to test your Azure Active Directory authentication. Click the "Sign in with Microsoft" button to redirect to the Azure Active Directory authentication page.

18. On your first login, you can grant access and start a VirtualMetric session.

19. Under the Microsoft Azure -> User section, you can see the users created with Azure.

Please make sure to enable SSL on VirtualMetric API, and use an HTTPS FQDN in the RedirectURI Parameter. You can check the section to learn how to activate SSL.

When a user wants to authenticate via Azure Active Directory, VirtualMetric looks for their email address. If the AzureAD user and the VirtualMetric user has the same email address, the user will be authenticated automatically. See the section for further details.

Adding New User to VirtualMetric
Setup SSL Certificate on VirtualMetric