Configuring Azure integration
Applies To: Windows Admin Center, Windows Admin Center Preview
Windows Admin Center supports several optional features that integrate with Azure services. Use the following information to configure the Windows Admin Center gateway to support these Azure integration features. Learn about the Azure integration options available with Windows Admin Center.
Register your gateway with Azure
The New-AadApp.ps1 script was updated April 2018 to include a
-Credential parameter. If you were previously seeing errors, please download the script and run it again.
To allow the Windows Admin Center gateway to communicate with Azure to leverage Azure Active Directory authentication for gateway access, or to create Azure resources on your behalf (for example, to protect VMs managed in Windows Admin Center using Azure Site Recovery), you must first register your Windows Admin Center gateway with Azure. You only need to do this once for your Windows Admin Center gateway - the setting is preserved when you update your gateway to a newer version.
To connect your gateway, you must run the New-AadApp.ps1 PowerShell script (there is also a hyperlink in the Windows Admin Center UI for this download, which is visible wherever you try to use an Azure integration feature for the first time), which creates a web application in Azure AD with the name "SME-gateway" and registers the application with the Windows Admin Center gateway. This allows Windows Admin Center to connect to Azure resources like Azure AD on your behalf. You can run the script from any computer that has access to the Windows Admin Center gateway and to Azure, with the Windows Admin Center gateway URL as the
-GatewayEndpoint parameter. For example,
PS> .\New-AadApp.ps1 -GatewayEndpoint "https://gateway.contoso.com"
If you are NOT using port 443, the
-GatewayEndpoint parameter should contain the port (for example, https://myComputer:6516).
Unless the computer where you run the script has administrative privilege on the computer where Windows Admin Center is installed, you will need to include the
-Credential parameter to specify a username and password with access to the computer where Windows Admin Center is installed. The
-Credential parameter takes a PSCredential, which you can create by using the cmdlet Get-Credential. Alternatively, you can pass in a username for
-Credential and you will be prompted to provide a password. For example,
PS> $cred = Get-Credential PS> .\New-AadApp.ps1 -GatewayEndpoint "https://gateway.contoso.com" -Credential $cred
If you have multiple tenants associated with your Azure account, you can use the
-TenantId parameter to specify the tenant in which you want to create the Azure AD application and associate with your Windows Admin Center gateway. For example,
PS> .\New-AadApp.ps1 -GatewayEndpoint "https://gateway.contoso.com" -TenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
This script requires two Azure PowerShell modules: AzureRm.Resources and AzureAD. If you don't have them installed, run the following commands in an elevated PowerShell console:
PS C:>Install-Module AzureRM.Resources PS C:>Install-Module AzureAD
After running the script, complete the following steps to grant permissions to the application:
- From the script output, copy the AadClientId.
- Go to the Azure portal > Azure Active Directory
- Go to App registrations, and search for the application just created, using the AadClientId copied in step 1. You can also search using the gateway name (the same name used as the -GatewayEndpoint parameter in the New-AadApp.ps1 script). Select this application.
- Select Settings > Required permissions, and then click Grant Permissions > Yes.
Finally, refresh the browser page from which you are accessing the Windows Admin Center gateway.
If you've already configured your gateway for Azure connectivity when you set up Azure Site Recovery and you used the New-AsrAadApp.ps1 available in our documentation prior to the version 1804.25 release, you need to delete your existing Azure AD application. In the Azure portal go to Azure Active Directory > Application registration > All applications and search for "ASR" (the old Azure AD app is named "ASR-Honolulu-gateway"). Then run the New-AadApp.ps1 script to create the replacement application with the correct permissions.
Manage Azure IaaS virtual machines with Windows Admin Center
You can use Windows Admin Center to manage your Azure VMs as well as on-premises machines. There are several different configurations possible - choose the configuration that makes sense for your environment:
Manage with an on-premises Windows Admin Center gateway
If you've already installed Windows Admin Center on an on-premises gateway (either on Windows 10 or Windows Server 2016), you can use this same gateway to manage Windows 10 or Windows Server 2012, Windows Server 2012 R2, or Windows Server 2016 VMs in Azure.
Connecting to VMs with a public IP
If your target VMs (the VMs you want to manage with Windows Admin Center) have public IPs, add them to your Windows Admin Center gateway by IP address, or by FQDN. There are a couple considerations to take into account:
- You must enable WinRM access to your target VM by running the following in PowerShell or the Command Prompt on the target VM:
You must also enable inbound connections to port 5985 for WinRM over HTTP in order for Windows Admin Center to manage the target VM:
Run the following PowerShell script on the target VM to enable inbound connections to port 5985 on the guest OS:
Set-NetFirewallRule -Name WINRM-HTTP-In-TCP-PUBLIC -RemoteAddress Any
You must also open the port in Azure networking:
- Select your Azure VM, select Networking, then Add inbound port rule.
- In the Port ranges field, enter 5985.
If your Windows Admin Center gateway has a static IP, you can select to allow only inbound WinRM access from your Windows Admin Center gateway for added security. To do this, select Advanced at the top of the Add inbound security rule pane.
For Source, select IP Addresses, then enter the Source IP address corresponding to your Windows Admin Center gateway.
- For Protocol select TCP.
- The rest can be left as default.
You must create a custom port rule. The WinRM port rule provided by Azure networking uses port 5986 (over HTTPS) instead of 5985 (over HTTP).
Connecting to VMs without a public IP
If your target Azure VMs don't have public IPs, and you want to manage these VMs from a Windows Admin Center gateway deployed in your on-premises network, you need to configure your on-premises network to have connectivity to the VNet on which the target VMs are connected. There are 3 ways you can do this: ExpressRoute, Site-to-Site VPN, or Point-to-Site. Learn which connectivity option makes sense in your environment.
Ensure WinRM is running on your target VMs by running the following in PowerShell or the Command Prompt on the target VM:
If you run into any issues, consult Troubleshoot Windows Admin Center to see if additional steps are required for configuration (for example, if you are connecting using a local administrator account or are not domain-joined).
Use a Windows Admin Center gateway deployed in Azure
You can manage Azure VMs without any on-premises dependency by deploying Windows Admin Center in the VNet where your target VMs are connected.
To manage VMs outside of the VNet on which the Windows Admin Center gateway is deployed, you must establish VNet-to-VNet connectivity between the VNet of the Windows Admin Center gateway and the VNet of the target servers. You can establish this connectivity with VNet Peering, VNet-to-VNet connection, or a Site-to-Site connection. Learn more about which VNet-to-VNet connectivity option makes sense in your environment.
Windows Admin Center can be installed on an existing or newly deployed VM in your environment. The VM that you choose for Windows Admin Center installation must have a public IP and DNS name.
Before installing Windows Admin Center on your desired gateway VM, install a SSL certificate to use for HTTPS communication, or you can choose to use a self-signed certificate generated by Windows Admin Center. However, you will get a warning when trying to connect from a browser if you choose the latter option. You can bypass this warning in Edge by clicking Details > Go on to the webpage or, in Chrome, by selecting Advanced > Proceed to [webpage]. We recommend you only use self-signed certificates for test environments.
Install Windows Admin Center onto an Azure VM:
These instructions are for installing on Windows Server with Desktop Experience, not on a Server Core installation.
Download Windows Admin Center to your local computer.
Establish a remote desktop connection to the VM, then copy the MSI from your local machine and paste into the VM.
Double-click the MSI to begin installation, and follow the instructions in the wizard. Be aware of the following:
By default, the installer uses the recommended port 443 (HTTPS). If you want to select a different port, note that you need to open that port in your firewall as well.
If you have already installed an SSL certificate on the VM, ensure you select that option and enter the thumbprint.
Start the Windows Admin Center service (run C:/Program Files/Windows Admin Center/sme.exe)
Configure the gateway VM to enable HTTPS port access:
Navigate to your VM in the Azure portal and select Networking.
Select Add inbound port rule and select HTTPS under Service.
If you chose a port other than the default 443, choose Custom under Service and enter the port you chose in step 3 under Port ranges.
At this point, you should be able to access Windows Admin Center from a modern browser (Edge or Chrome) on your local computer by navigating to the DNS name of your gateway VM.
If you selected a port other than 443, you can access Windows Admin Center by navigating to https://<DNS name of your VM>:<custom port>
In order to add other VMs in the VNet, ensure WinRM is running on the target VMs by running the following in PowerShell or the command prompt on the target VM: