[Index]

Model: relation/MicrosoftTenant

Microsoft Authentication and Authorization Setup

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Overview

To allow VOSS Automate to manage and provision Microsoft applications, VOSS Automate must be able to authenticate with Azure Active Directory, PowerShell proxy servers (one or more) Microsoft Teams, and Microsoft Exchange Online.

"Network Communications External to the Cluster" in the VOSS Automate Installation Guide or Platform Guide.

Authentication and Authorization Setup Workflow

The flowchart provides a high-level overview of the process to set up VOSS Automate authentication and authorization for managing Microsoft applications.

To access the flowcharts, view the topic via Documentation and Resources at: https://voss.portalshape.com

The table describes the devices configured for authentication and authorization:

Microsoft Graph API

VOSS Automate uses the Microsoft Graph API (if available) to manage cloud-based applications, such as Azure Active Directory.

Windows PowerShell and PowerShell Proxy Servers

If the Microsoft Graph API is not available, and for on-premise applications, VOSS Automate uses Windows PowerShell, along with PowerShell management modules provided by Microsoft. In this case, VOSS Automate requires access to at least one Windows computer to use as the PowerShell proxy server.

VOSS Automate manages Microsoft Teams and Microsoft Exchange Online using the PowerShell proxy servers running Windows PowerShell. The PowerShell proxy servers execute remote PowerShell cmdlets.

The table describes how PowerShell Proxies may be used to manage on-premise or cloud-based applications:

Authentication and authorization may be enforced in two places:

• On the PowerShell proxy
• In the Microsoft 365 tenant

When using Windows PowerShell for Microsoft apps management, VOSS Automate creates separate PowerShell sessions via the PowerShell proxy servers for each Microsoft application being managed for a specific customer tenant or domain.

All PowerShell sessions for a particular customer may be hosted by the same PowerShell proxy server, or you can configure a separate PowerShell proxy server for each PowerShell session. Optionally, the PowerShell proxy servers hosting the PowerShell sessions may be dedicated for this purpose exclusively.

WinRM and WSMan

Windows Server includes the "Windows Remote Management" (WinRM) service, which implements the "Web Services-Management" protocol (WSMan):

• VOSS Automate connects to the WinRM service on the PowerShell proxy and provides credentials for an elevated local service account on that server
• The WinRM service executes commands from the set provided by the Microsoft Teams and Microsoft Exchange PowerShell modules.

Once connected, VOSS Automate pushes PowerShell scripts (which it generates "on the fly") to the PowerShell proxy, and instructs WinRM to execute the scripts and return the results. The Microsoft Teams and Exchange Online Management PowerShell modules (provided by Microsoft) then connect to the Microsoft 365 tenant.

PowerShell Proxy Setup

This procedure configures the PowerShell proxy servers and installs the Microsoft Teams PowerShell module.

You will need to perform the following tasks:

1. Configure Local Hosts File
2. Configure the Outbound Internet Proxy
3. Configure WinRM
4. Install Software Management Components on a PowerShell Proxy
5. Test Tenant Connection

Configure PowerShell Proxy for Redundancy

This procedure adds a Fully Qualified Domain Name (FQDN) to the local hosts file on each PowerShell Proxy server you're deploying. Each PowerShell Proxy server must be able to address itself with the FQDN corresponding to the load balancer's virtual IP address.

Perform these steps:

1. On each of the PowerShell Proxy servers, open an elevated PowerShell window, and issue the following command:

PS C:\WINDOWS\system32> notepad C:\Windows\System32\drivers\etc\hosts

2. In the Notepad window uncomment the 127.0.0.1 line (delete the hash) and append the FQDN of the load balancer virtual IP:

# Copyright (c) 1993-2009 Microsoft Corp.
#
# This is a sample HOSTS file used by Microsoft TCP/IP for Windows.
#
# This file contains the mappings of IP addresses to host names. Each
# entry should be kept on an individual line. The IP address should
# be placed in the first column followed by the corresponding host name.
# The IP address and the host name should be separated by at least one
# space.
#
# Additionally, comments (such as these) may be inserted on individual
# lines or following the machine name denoted by a '#' symbol.
#
# For example:
#
# 102.54.94.97 rhino.acme.com # source server
# 38.25.63.10 x.acme.com # x client host
# localhost name resolution is handled within DNS itself.
127.0.0.1 localhost psproxy.domain.com
# ::1 localhost

Configure the Outbound Internet Proxy

This procedure configures a PowerShell Proxy server to use an outbound Internet proxy.

Prerequisites:

• If the outbound Internet proxy requires authentication, you will need to obtain those credentials and configure them in VOSS Automate (as described in the Core Feature Guide). The credentials are not configured directly on the PowerShell Proxy server.

Perform these steps:

1. Sign into the PowerShell Proxy server using the local service account that VOSS Automate will use to connect to the proxy.

   Note

   VOSS Automate must use a server-local service account for accessing the PowerShell Proxy server. It must not be a domain account (should the server be domain-joined). The service account must have the following properties:

   Account Type	Local Computer Account (not a domain account)
   Local Group Membership	Administrators Remote Management Users

2. Open Windows Settings and go to Network & Internet > Proxy.

3. Under Manual proxy setup enable Use a proxy server.

4. In the Address field, fill out the IP address or FQDN of the outbound Internet proxy server.

5. In the Port field, fill out the port number required by the proxy.

   Note

   The port is typically 3128, but your organization may require a different port.

6. Select Don't use the proxy server for local (intranet) addresses.

7. Click Save.

   Note

   This is a per-user configuration, so ensure you sign in using the VOSS Automate service account.

8. To make this configuration the default setting for all HTTP clients, open an elevated PowerShell session, and issue the following command:

   netsh winhttp import proxy source=ie
   

Configure WinRM

This procedure configures the Windows Remote Management (WinRM) service with the appropriate settings for VOSS Automate.

VOSS Automate uses the Web Services-Management protocol (WSMan) to create the PowerShell sessions that manage Microsoft UC applications.

On Windows computers, the Windows Remote Management (WinRM) service implements WSMan.

You will need to configure WinRM on a PowerShell Proxy running on Windows Server 2019.

Perform these steps:

1. Open an elevated PowerShell session.
2. Issue the following commands:

Enable-WSManCredSSP -Role Server -Force
Enable-WSManCredSSP -Role Client -DelegateComputer \* -Force
Set-Item WSMan:\localhost\Service\AllowUnencrypted $true
Set-Item WSMan:\localhost\Service\Auth\Basic $true
Set-Item WSMan:\localhost\Client\AllowUnencrypted $true
Set-Item WSMan:\localhost\Client\Auth\Basic $true
Set-Item WSMan:\localhost\Client\TrustedHosts '{server identity}'

'10.1.1.10,psproxy01.domain.com'

'10.1.1.10,psproxy01.domain.com,psproxy.domain.com'

Install Software Management Components

This procedure installs the following software components on a new PowerShell Proxy server:

• Step 1: Install .NET Framework 4.8
• Step 2: Install Microsoft Teams PowerShell Module
• Step 3: Install Microsoft ExchangeOnlineManagement Module

Before you start

The Install-Module command used in Step 2: Install Microsoft Teams PowerShell Module and Step 3: Install Microsoft ExchangeOnlineManagement Module downloads the specified PowerShell module from the PowerShell Gallery (an online repository).

Since the PowerShell Gallery has deprecated the use of TLS versions earlier than TLS 1.2, you will need to force Windows PowerShell to use TLS 1.2, which will allow the Install-Module command to work correctly. TLS 1.2 is the default in Windows Server 2019 and later. If you're using an earlier release of Windows Server, use the following command to force PowerShell to use TLS 1.2:

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

The command is relevant only for the current PowerShell session (its effect persists only until you close the PowerShell window and end the session). Errors such as the following when using the Install-Module command are likely the result of a TLS version mismatch: "Unable to resolve package source", "No match was found…"

Configure Microsoft Tenant Connection Parameters

This procedure configures the following connections:

• From VOSS Automate to the PowerShell Proxy
• Between the PowerShell Proxy and the tenant
• The Graph API connection between VOSS Automate and the tenant

Prerequisites:

You will need:

• The FQDN or IP address of a single-node PowerShell Proxy, or the FQDN corresponding to your load balancer’s virtual IP address. See PowerShell Proxy Setup
• The credentials for the local service account you created on the PowerShell Proxy
• Proxy authentication credentials (if the outbound Internet Proxy requires authentication)
• The credentials for the Microsoft Teams tenant service account. See Create Microsoft Teams Service Account on Azure.
• The Client ID, Tenant ID, and, for authentication for MS Graph, the client secret and/or the certificate created when registering VOSS Automate as an application object with Azure Active Directory. See Azure Active Directory Tenant Setup for VOSS Automate Application Registration.
• If you're using VOSS Automate to manage Microsoft Exchange online, you will need the certificate authentication thumbprint you generated on the Azure portal for Microsoft Exchange. See Azure Active Directory Tenant Setup for VOSS Automate Application Registration.

To add and configure the Microsoft Tenant

1. Log in to the VOSS Automate Admin Portal as a Provider Administrator.

   Note

   By default, the Provider administrator role is the only role that has the ability to create Tenant connections).

2. Add the Microsoft tenant:

   1. Go to (default menus) Apps Management > Microsoft Tenant.
   2. Click Add.
   3. Choose the hierarchy level where you wish to add the tenant. Typically, this is at Customer level.
   4. Enter a name and a description for the tenant.

3. Add the PowerShell Proxy connection parameters:

   1. Locate the Microsoft Teams Powershell section.

   2. In the Host field, enter the FQDN or IP address of a single-node PowerShell Proxy, or the FQDN corresponding to your load balancer's virtual IP address.

      Note

      For details around the local hosts file and the TrustedHosts WinRM configuration, see PowerShell Proxy Setup.

   3. In the Username field and Password field, enter the credentials for the local service account you created on the PowerShell Proxy.

4. Configure the outbound internet Proxy:

   1. Locate the Microsoft Teams HTTP Proxy fields.

   2. If you have an outbound Internet Proxy deployed between the PowerShell Proxy and the public Internet, select the Use HTTP Proxy checkbox.

      Note

      If there is no outbound Internet Proxy deployed between the PowerShell and the public internet, leave both checkboxes unchecked, and leave the Username and Password fields blank. Continue to the next step.

   3. If the outbound Internet proxy requires authentication, select the Use HTTP Proxy Authentication checkbox, and enter the Proxy authentication credentials in the Username / Password fields.

      Note

      You will have already provisioned the outbound Internet Proxy's IP address (or FQDN) and port number when you set up the PowerShell Proxy. See PowerShell Proxy Setup, and note the caveat regarding proxy authentication in Deployment Topology Options.

5. Add the Microsoft Teams Tenant service account credentials:

   1. Locate the Microsoft Teams fields.

   2. In the Admin Username and Admin Password fields, enter the credentials for the Microsoft Teams tenant service account.

      Note

      You created this account earlier. See Create Microsoft Teams Service Account on Azure.

6. Configure the Azure Active Directory application registration parameters:

   1. Locate the client secret value you stored previously.

      Note

      You would have obtained and stored this client secret when registering your VOSS Automate application. See Azure Active Directory Tenant Setup for VOSS Automate Application Registration.

   2. Locate your Client ID and Tenant ID, which you specified in the Azure AD portal.

      If you need to obtain the Client ID and Tenant ID from the Azure Portal now:

      • Use your Global Administrator credentials to sign in to the Azure portal .
      • Go to Azure Active Directory > Manage > App registrations.
      • Select your VOSS Automate application.
      • Locate the Client ID and Tenant ID values under Essentials.

7. Add Microsoft 365 details to the Microsoft tenant:

   1. Locate the Microsoft 365 fields.

   2. Enter the Client ID and Tenant ID values.

   3. If you're using client secret authentication, copy the secret value into the Secret field.

   4. If you're using certificate authentication:

      • Paste the certificate thumbprint obtained from Azure into the Certificate Thumbprint field.

      • From the Certificate drop-down, choose the certificate previously created in the Admin Portal.

        Note

        • You uploaded the public key for this locally stored certificate to Azure. The thumbprint added in the Microsoft 365 tenant parameter is generated in Azure when the public key file is uploaded to Azure.
        • Certificate authentication only if a client secret is not provided.

   5. By default, the Max page size value is set to import a maximum of 999 users during for example a scheduled import. Modify this value to a lower value if memory or time issues are encountered.

8. If you're using VOSS Automate to manage Microsoft Exchange online, provision the Exchange Online application certificate thumbprint.

   Note

   The certificate authentication thumbprint is generated on the Azure portal for Microsoft Exchange. You would have installed this certificate on the PowerShell proxy server and configured it in the application registration.

   The certificate thumbprint is the encrypted password required for an authenticated connection to the Microsoft Cloud Exchange portal. Connecting to Microsoft Exchange is required to sync in the Microsoft Exchange objects (mailboxes, shared mailboxes, rooms, and distribution lists).

   1. Locate the Microsoft Exchange fields.

   2. Select Enable Microsoft Exchange.

   3. In the Certificate Thumbprint field, paste the certificate thumbprint you obtained earlier.

      Note

      You obtained the certificate thumbprint when logged into the PowerShell proxy to register the VOSS Automate application with Azure Active Directory. See Azure Active Directory Tenant Setup for VOSS Automate Application Registration.

      The certificate thumbprint was created on the proxy and uploaded to the Azure portal. When generating PowerShell scripts to manage Microsoft Exchange Online, VOSS Automate includes this thumbprint so that the PowerShell proxy can use the corresponding certificate to authenticate with Microsoft Exchange Online.

9. Click Save.

10. Test your Microsoft tenant connection. You will be prompted to confirm the test.

    Note

    In this step you will verify that VOSS Automate can connect to the Microsoft Teams tenant using PowerShell, and to Azure Active Directory using the Microsoft Graph API.

    1. On the Microsoft Tenant page, choose the relevant tenant.
    2. Click Test Connection.

Next Steps

• Verify that no changes are needed in user name mapping macros prior to sync. High level administrators with access to the data/MultivendorUsernameMappingMacros model instances should carry out this task.

• Perform a sync from the Microsoft tenant to import Microsoft users, tenant dial plan, licenses, and policies to the customer level. You will be prompted to confirm the syncs.

  For Microsoft Exchange, ensure that instances for all 4 device models (User mailboxes, Shared Mailboxes, Room Mailboxes, and Distribution Mailboxes) are synced in at the level were the tenant exists.

• Configure the customer-wide site defaults doc (SDD), CUSTOMER_TEMPLATE. See Site Defaults Doc Templates.

• Add network device lists (NDLs) with Microsoft 365 and Microsoft Teams tenant details. NDLs are required when adding sites. See Configure a Network Device List.

• Create sites.

• Run the overbuild. See: Overbuild for Microsoft.

• Go to VOSS Automate Configuration and Sync

Related Topics

Microsoft Overview in the Core Feature Guide

This relation implements the workflows to manage Microsoft Tenant connection parameters and enabled services.

Model Details: relation/MicrosoftTenant