Windows Admin Center Overview and Benefits
Windows Admin Center Overview and Benefits
Windows Admin Center is a remote management tool for Windows Server running anywhere—
physical, virtual, on-premises, in Azure, or in a hosted environment—at no extra cost.
Download now
Download Windows Admin Center from the Microsoft Evaluation Center.
For installation help, see Install. For tips on getting started with Windows Admin Center, see
Get started.
You can update non-preview versions of Windows Admin Center by using Microsoft Update or
by manually downloading and installing Windows Admin Center. Each non-preview version of
Windows Admin Center is supported until 30 days after the next non-preview version is
released. See our support policy for more info.
Simplify server management: Manage your servers and clusters with modernized
versions of familiar tools such as Server Manager. Install in under five minutes and
manage servers in your environment immediately, no extra configuration required. For
details, see What is Windows Admin Center?
Work with hybrid solutions: Integration with Azure helps you optionally connect your on-
premises servers with relevant cloud services. For details, see Azure hybrid services.
Here's a video to give you an overview, followed by a poster giving more details:
[Link]
Contents at a glance
ノ Expand table
Understand Plan
- What is Windows Admin Center? - What type of installation is right for you?
- Frequently asked questions - User access options
- Case studies
- Related management products
ノ Expand table
Deploy Configure
ノ Expand table
ノ Expand table
Extend
- Overview of extensions
- Understanding extensions
- Develop an extension
- Guides
- Publishing extensions
"Thanks to [Windows Admin Center], we can manage our customers remotely from HTML5
portal without problem and with the full integration with Microsoft Entra ID, we're able to
increase the security thanks to the multifactor authentication."
- Silvio Di Benedetto, Founder and Senior Consultant, Inside Technologies
“We have been able to deploy [Server Core] SKUs in a more effective way, improving resource
efficiency, security, and automation while still achieving a good degree of productivity and
reducing errors that can happen when relying on scripting only.”
- Guglielmo Mengora, Founder and CEO, VaiSulWeb
“With [Windows Admin Center] customers especially in the SMB market now have an easy to
use tool to manage their internal infrastructure. This minimizes administrative efforts and saves
a lot of time. And the best of it: there are no additional license fees for [Windows Admin
Center]!”
- Helmut Otto, Managing Director, SecureGUARD
To read more about companies using Windows Admin Center in their production
environments, see Windows Admin Center Case Studies.
Related products
Windows Admin Center is designed for managing a single server or cluster. It complements but
doesn't replace existing Microsoft monitoring and management solutions, such as Remote
Server Administration Tools (RSAT), System Center, Intune, or Azure Stack.
To learn how Windows Admin Center complements other Microsoft management solutions,
see Windows Admin Center and related management solutions from Microsoft.
Stay updated
Follow us on X (formerly Twitter)
Read our blogs
What is Windows Admin Center?
Article • 01/02/2024 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
Windows Admin Center is the modern evolution of "in-box" management tools, like
Server Manager and MMC. It complements System Center - it's not a replacement.
The Windows Admin Center gateway, when published to DNS and given access through
corresponding corporate firewalls, lets you securely connect to, and manage, your
servers from anywhere with Microsoft Edge or Google Chrome.
Learn how Windows Admin Center improves
your management environment
Familiar functionality
Windows Admin Center is the evolution of long-standing, well known management
platforms like Microsoft Management Console (MMC), built from the ground up for the
way systems are built and managed today. Windows Admin Center contains many of the
familiar tools you currently use to manage Windows Servers and clients.
You can securely manage your machines from anywhere–without needing a VPN, public
IP address, or other inbound connectivity to your machine.
Extensibility
Windows Admin Center was built with extensibility in mind from the beginning, with the
ability for Microsoft and 3rd party developers to build tools and solutions beyond the
current offerings. Microsoft offers an SDK that enables developers to build their own
tools for Windows Admin Center.
Tip
Feedback
Was this page helpful? Yes No
Here are answers to the most commonly asked questions about Windows Admin Center.
For info about Windows Admin Center Preview releases, see Windows Insider Preview
releases .
Computer Management – Provides a subset of the Server Manager features for managing
Windows 10 client PCs
Failover Cluster Manager – Provides support for ongoing management of failover clusters
and cluster resources
Hyper-Converged Cluster Manager – Provides an all-new experience tailored for Storage
Spaces Direct and Hyper-V. It features the Dashboard and emphasizes charts and alerts
for monitoring.
Windows Admin Center is complementary to and does not replace RSAT (Remote Server
Administration Tools) since roles such as Active Directory, DHCP, DNS, IIS do not yet have
equivalent management capabilities surfaced in Windows Admin Center.
Windows Admin Center handles the configuration of CredSSP automatically after prompting
for consent from you. Before configuring CredSSP, Windows Admin Center will check to make
sure that the system has the recent CredSSP updates .
Using disaggregated SMB storage in the virtual machines tool (the example above.)
Using the Updates tool in either the Failover or Hyper-Converged cluster management
solutions, which performs Cluster-Aware Updating
Ava6
Ava6 is an IT consulting company that specializes in design, evaluation, and
integration of IT infrastructure, specifically virtualization, networking, storage, backup,
and cloud computing.
Ava6 uses Windows Server 2016 Core, Hyper-V, Failover Clustering, and S2D.
The Challenge
Ava6's first use case for Windows Admin Center is Hyper-V and Failover Clustering, and
is evaluating hyper-converged cluster.
Windows Admin Center helps Ava6 manage Windows Server deployed in Core Edition,
especially for driver management. Windows Admin Center gives a better experience for
Hyper-V and Failover Cluster to customers, especially to manage VMs, and shows
customers that a GUI is coming for the hyper-converged solution.
The Solution
Ava6 has Windows Admin Center deployed as a single instance for VM management.
Ava6's customers have been impressed with Windows Admin Center, and prefer its
management capabilities for Hyper-V and Failover Clustering over other options. Before
Windows Admin Center, driver management was overly complicated on a Core server.
Windows Admin Center has also helped introduce S2D Ava6's customers, with a similar
offering to competitors like Nutanix and VMWare.
Comparex
Comparex is an IT service provider and software license management company that
has developed services to support management, leverage software products, and enable
productivity optimization.
Comparex uses Windows Server 2012R2, Windows Server 2016, Windows 10, Hyper-V,
Failover Clusters, Storage Spaces Direct, PowerShell, RDP over HTML, Microsoft Entra ID
and Application Proxy, File Servers, and Azure Site Recovery.
The Challenge
Comparex is responsible for running and managing thousands of servers for their
customers, and consults with customers to provide the best solution for server
management depending on needs.
The Solution
Comparex is running a server-based Windows Admin Center installation for access to,
and management of, their demo lab, which has helped alleviate extra VPN and RDP
steps. Comparex's consultants also run Windows Admin Center on their notebooks to
help customers in their environment, without the need for explicit RDP access.
Windows Admin Center has saved Comparex time in their daily business, to do more
and achieve more. Windows Admin Center has also solved common management
challenges with their customers, such as with Hyper-V and Storage Spaces Direct.
Convergent Computing
Convergent Computing is a technology strategy and implementation firm that helps
enterprises plan, implement, migrate, and automate systems to improve business
operations.
Convergent Computing uses Windows Server 2016 (Nano, Core, Datacenter, Standard,
Hyper-V) and Windows Server 2012R2 (Server Core, Datacenter, Standard, and Hyper-V).
The Challenge
Convergent Computing uses the technologies it recommends to its customers, and it
found that Windows Admin Center fits a perfect need for customers with hosted data
centers and secured (isolated) on-premise work environments.
Convergent Computing has three distinct environments: hosted, secured, and web
operations). These environments run a combination of Windows Server Nano, Core,
Cluster, and Hyper-V editions. Windows Admin Center has enabled them to centrally
manage multiple servers and services from a single point, providing an optimized
footprint and simple management platform.
The Solution
Convergent Computing uses Windows Admin Center to manage three environments
with 40+ hosts running 200+ workloads.
Prior to Windows Admin Center, Convergent Computing used a range of tools and
technologies to perform management tasks, including System Center and custom
scripts. With the goal of minimizing overhead and effort to manage their servers farms,
Convergent Computing found that the “thinner” a management layer got, the more
complex it became, so they typically ended up with higher overhead for the sake of
simplicity. With Windows Admin Center, 20+ hours a month that were spent “managing
the management system” are saved, a 75% reduction in time and effort, allowing their
operations teams to focus on more valuable tasks including security, compliance,
capacity planning, and overall systems optimization.
FZI uses Windows Server 2016, Windows 10, Hyper-V, Storage Spaces Direct, and
Failover-Cluster.
The Challenge
FZI was looking for a way to manage Hyper-V Server in a Failover Cluster, and a Hyper-
Converged Cluster.
FZI was looking for a centralized way to administrate systems both inside and outside of
their domain, with the ability to switch quickly between each of those systems. Windows
Admin Center enabled them to accomplish those goals, all in one place.
The Solution
FZI has multiple installations of Windows Admin Center, both as a server installation
connecting all of the infrastructure they manage, as well as installations in desktop
mode that their administrators use to manage their own testing servers.
Windows Admin Center allows FZI to accelerate the rate they can perform tasks like
monthly Windows Updates, connecting to servers via Remote Desktop, and making
minor administrative changes quickly.
GVC Group
GVC Group is an online entertainment provider, with over 15,000 servers operated
around the globe.
GVC Group uses Windows Server 2016 with many roles (Hyper-V, WSFC, AD-DS,
Fileserver, among others), as well as System Center products including SCCM and SCOM.
The Challenge
GVC Group operates in a highly regulated market, with the need to deploy systems to
many locations worldwide. Local requirements sometimes require that management of
systems is performed in the same country that the server is operated in. Windows
Admin Center allows GVC group to leverage global resources and still perform
management tasks on local systems.
GVC Group need to deploy servers in many locales and still provide reliable, highly
available solutions with minimal effort.
The Solution
GVC Group has deployed Windows Admin Center in a virtualized environment, with a
load balancer, to enable management of servers in remote locations.
GVC Group has seen increased productivity due to less management hops for
administrators. This has reduced their cost due to the down-scaling of local terminal
servers.
Inside Technologies
Inside Technologies is a globally-focused IT consulting firm that provides application
development, enterprise solutions, and infrastructure services. They specialize in
applying new and unique approaches with Microsoft solutions to meet customer's
needs.
The Challenge
Inside Technologies primary needed a way to provide their customers with new tools in
an always-connected environment that was integrated with high security, and without
the need to use VPN.
Inside Technologies have customers where uptime is critical, and were looking for a tool
that allowed them to manage their servers easily without exposing RDP and without
adding complexity with VPN.
The Solution
Windows Admin Center is deployed by Inside Technologies on a single server to
manage all assets in their environment.
SecureGUARD / COPA-DATA
SecureGUARD GmbH helps companies solve complex IT problems in security and
cloud infrastructure with a series of products and custom engineering services.
SecureGUARD builds IT security appliances and Microsoft Windows Server based
appliances, more recently building rack-level converged appliances for cloud
infrastructures. SecureGUARD is a Microsoft Gold Partner in Application Development
and Datacenter.
COPA-DATA develops the software solution “zenon” that allows for end-to-end
industrial IoT solutions - from the field level up to the cloud and to mobile devices.
COPA-DATA has deployed systems worldwide to companies in the Food & Beverage,
Energy & Infrastructure, Automotive and Pharmaceutical sectors.
The Challenge
COPA-DATA implemented a 4-node hyper converged cluster designed and implemented
by SecureGUARD GmbH in late 2017 to host their internal infrastructure and test servers.
COPA-DATA found itself limited by its old IT infrastructure. Specifically, monitoring and
operating their infrastructure with approx. 60 virtual machines became a real challenge
for the IT department.
The Solution
COPA-DATA uses Windows Admin Center to monitor and operate their physical and
virtual server infrastructure, all accessible from one browser window. Tasks like
provisioning a new virtual machine or viewing performance data of a physical server or
VM are now done with a simple mouse click in the Windows Admin Center web
interface.
With Windows Admin Center, COPA-DATA has an easy to use tool to manage their
internal infrastructure. This minimizes administrative efforts and saves a lot of time,
without any additional license fees.
VaiSulWeb
VaiSulWeb is a web hosting and IaaS/PaaS services provider that also provides
development and integration services.
VaiSulWeb uses Windows Server 2016 and 2012 R2, with Hyper-V, Failover Clustering,
Storage Spaces Direct, File Servers, SQL Server, IIS, and WSL.
The Challenge
VaiSulWeb was looking to leverage the agility and efficiency of Server Core when
deploying resources, while maintaining ease of management for those resources.
VaiSulWeb uses a combination of PowerShell automation for simple tasks and UI for
more complicated ones.
VaiSulWeb has gained increased confidence deploying Windows Server Core with the
increased ability to manage with Windows Admin Center, plus the ability to extend
Windows Admin Center for a customized experience.
The Solution
VaiSulWeb deploys in a wide variety of scenarios, including failover clustering and
hyper-converged. Windows Admin Center is deployed on both Windows 10
workstations and Windows Servers to manage their assets.
VaiSulWeb has been able to deploy Windows Server Core more effectively, while
improving resource efficiency, security, and automation. VaiSulWeb has achieved
improved productivity and reduced errors versus management with scripts only.
Feedback
Was this page helpful? Yes No
Windows Admin Center is the evolution of traditional in-box server management tools
for situations where you might have used Remote Desktop (RDP) to connect to a server
for troubleshooting or configuration. It's not intended to replace other existing
Microsoft management solutions; rather it complements these solutions, as described
below.
Intune
Intune is a cloud-based enterprise mobility management service that lets you manage
iOS, Android, Windows, and macOS devices, based on a set of policies. Intune focuses
on enabling you to secure company information by controlling how your workforce
accesses and shares information. In contrast, Windows Admin Center is not policy-
driven, but enables ad-hoc management of Windows 10 and Windows Server systems,
using remote PowerShell and WMI over WinRM.
Azure Stack
Azure Stack is a hybrid cloud platform that lets you deliver Azure services from your
data center. Azure Stack is managed using PowerShell or the administrator portal, which
is similar to the traditional Azure portal used to access and manage traditional Azure
services. Windows Admin Center isn't intended to manage the Azure Stack
infrastructure, but you can use it to manage Azure IaaS virtual machines (running
Windows Server 2016, Windows Server 2012 R2, or Windows Server 2012) or
troubleshoot individual physical servers deployed in your Azure Stack environment.
System Center
System Center is an on-premises data center management solution for deployment,
configuration, management, monitoring your entire data center. System Center lets you
see the status of all the systems in your environment, while Windows Admin Center lets
you drill down into a specific server to manage or troubleshoot it with more granular
tools.
ノ Expand table
Included with Windows Server license – Comprehensive suite of solutions for additional value
no additional cost, just like MMC and across your environment and platforms
other traditional in-box tools
Deep single-server & single-cluster drill- Infrastructure provisioning; automation and self-
down for troubleshooting, configuration service; infrastructure and workload monitoring
& maintenance breadth
Optimized management of individual 2–4 Deploy & manage Hyper-V, Windows Server clusters
node HCI clusters, integrating Hyper-V, at datacenter scale from bare metal with SCVMM
Storage Spaces Direct, and SDN
Monitoring on HCI only; cluster health Extensible & scalable monitoring platform in SCOM,
service stores history. Extensible platform with alerting, notifications, third-party workload
for 1st and 3rd party admin tool monitoring; SQL for history
extensions
Easiest bridge to hybrid; onboard and Built-in data protection, replication, updates
use a variety of Azure services for data (DPM/VMM/SCCM). Hybrid integration with Log
protection, replication, updates and more Analytics and Service Map
The modernized gateway is a significant backend upgrade of the Windows Admin Center
product. The Windows Admin Center backend hosts the authorization structure, PowerShell
services, and gateway plug-ins and plays a critical role in every Windows Admin Center
experience.
What's new
Updated installer
While modernizing our gateway, we also made the installer more flexible by providing
increased customization options including network access settings, selecting trusted hosts,
providing a fully qualified domain name (FQDN) for your gateway machine, and more. For
more details about the installer, read on to the Installing the modernized gateway section.
Additionally, gateway plug-ins that are compatible with the modernized gateway will also run
their own collection of subprocesses under the Windows Admin Center service manager to
perform their functions.
Changing from a monolithic service to a microservice model helps the modernized gateway be
more flexible, scalable, and resilient.
Kestrel HTTP web server
Previously, Windows Admin Center utilized Katana components, including a web server, on the
backend. With the modernized gateway, we’ve shifted to an [Link] Core Kestrel web server.
Kestrel is the recommended web server for [Link] Core applications. Additionally, Kestrel
supports the HTTP/2 web protocol, where previously we had only supported HTTP1.1 with the
Katana components. The upgrade from HTTP1.1 to HTTP/2 brings reduced latency to our
application and increased responsiveness through enhanced features like multiplexing and
server push.
Because gateway plug-ins communicate with Windows Admin Center’s backend to enable API
communication, gateway plug-in code can include components written with the .NET
framework version 4.6.2, which won't function with .NET 8.
Additionally, we've modified the way plug-ins work with our modernized gateway. Instead of
developing a C# class that implements the IPlugIn interface from the
[Link] namespace to extend the gateway plug-in,
extensions will now be written in the form of [Link] MVC controllers. These controllers have
increased flexibility compared to the simple C# class and extensive documentation.
View our developer documentation to learn more about gateway plug-in development in
Windows Admin Center.
When running the installer, you're presented with three different installation modes: express
localhost setup, express remote setup, and custom setup.
If you would like to configuration options for internal and external network ports, endpoint
FQDN, WinRM over HTTPS, and more, continue to the Custom setup section. If you're okay
with the defaults, continue to the Express setup options section.
If you would like to configure any of these features, use the Custom setup option instead.
If you select the express localhost setup option, WAC will be accessible through port 6600 and
will use internal ports 6601-6610.
If you select the express remote setup option, WAC will be accessible through port 443 and will
use internal ports 6601-6610.
Custom setup
Selecting custom setup allows you to configure all Windows Admin Center setup options,
including:
Network access – This page allows you to select how you'll be using Windows Admin
Center. You can choose to restrict WAC access to other users by selecting localhost access
only or allow remote access through machine name of FQDN.
Port numbers – This page allows you to select the ports that will be reserved for
Windows Admin Center. WAC uses one external port for its primary processes. Other
processes use internal ports. There are two internal processes by default, but extensions
can define their own services that will require port access. By default, the internal range is
10 ports.
Select TLS certificate – This page allows you to select Self-Signed certificates or an official
TLS certificate that Windows Admin Center should use. Self-Signed certificates include
Self-signed CA root certificates and TLS certificates that work with the latest
Edge/Chrome browser.
Fully qualified domain name – This page allows you to provide a fully qualified domain
name for network access. This name must match the name on the TLS certificate.
Trusted hosts – This page allows you to select which type of remote hosts you’d like to
manage. You can choose to manage only trusted domain computers or allow access to
non-domain joined machines.
WinRM over HTTPS - This page allows you to select whether to use HTTPS for WinRM
communication. WinRM communicates over HTTP by default.
Troubleshooting installation
If your installation failed, or Windows Admin Center fails to open after install, try uninstalling
and reinstalling. This issue can also happen if you have an older version of a modernized
gateway build installed, and you're trying to update to a newer version. To uninstall, follow the
instructions in the Uninstalling the modernized gateway section.
Extension support
The extension feed for the modernized gateway isn't configured. Extensions not included in the
Windows Admin Center installer, including external partner extensions, aren't available unless
you add an extension feed.
The following extensions are available upon install of the modernized gateway build:
There are some extensions that won't function even when they're added as part of a new
extension feed. For more information, see Known issues.
In the Apps & Features page of your gateway machine settings, select Windows Admin
Center (v2) from the program list and then select uninstall.
Navigate to the folder where the Windows Admin Center modernized gateway is installed
(default directory is C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Windows
Admin Center (v2) ) and select Uninstall Windows Admin Center (v2)
Running the installer again doesn't provide an uninstall option at this time. To ensure your
installation was removed successfully, check if a WindowsAdminCenter folder exists in
C:\ProgramData or C:\Program Files . If it doesn't exist in either location, your application is
successfully uninstalled.
During the uninstallation process, everything put on the machine during installation is
removed, apart from the Windows Admin Center modernized gateway .exe installer file. If you
have another build of Windows Admin Center also installed at the time of your modernized
gateway uninstallation, no files or properties of the other build are touched during the
uninstallation process. There are no interdependencies between the two installations.
Known issues
There are the following known issues in the modernized gateway build of Windows Admin
Center.
If you encounter an issue not described on this page, let us know . To help us address the
issue, specify that the issue was occurring in the modernized gateway build.
PowerShell
The account for the PowerShell session in this tool always defaults to the user signed into the
Windows Admin Center gateway, even if different management credentials were specified
when remoting to a connection.
Dell OpenManage
Lenovo XClarity Integrator
Fujitsu ServerView RAID
Fujitsu Software Infrastructure Manager (ISM)
Fujitsu ServerView Health
Pure Storage FlashArray
To change the ports your Windows Admin Center instance is using, run the following
command:
PowerShell
Set-WACHttpsPort -Wacport <port> -ServicePortRangeStart <port> -
ServicePortRangeEnd <port>
Are all the features from the 2311 release available in this
build?
Yes. Read more about the 2311 release of Windows Admin Center.
Next steps
Download and install the modernized gateway build of Windows Admin Center from the
Windows Server Insider Program
Get started with Windows Admin Center
What type of installation is right for
you?
Article • 02/05/2025 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
This topic describes the different installation options for Windows Admin Center,
including installing on a Windows 10 PC or a Windows server for use by multiple
admins. To install Windows Admin Center on a VM in Azure, see Deploy Windows
Admin Center in Azure.
We don’t recommend using Windows Admin Center for local management of the same
server on which it’s installed. To manage a server, use Windows Admin Center to
connect to the server remotely from a management PC or other server.
Installation: Types
ノ Expand table
ノ Expand table
Windows Server Semi-Annual Channel Gateway server, managed server, failover cluster
In local client scenario: Launch the Windows Admin Center gateway from the Start
menu and connect to it from a client web browser by accessing
[Link] .
2 Warning
7 Note
Port usage and defaults for Windows Admin Center installations on the modernized
gateway vary from what is mentioned above. Read more about what's different in
the modernized gateway.
ノ Expand table
7 Note
Windows Admin Center requires PowerShell features that are not included in
Windows Server 2012 and 2012 R2. If you will manage these with Windows Admin
Center, you will need to install Windows Management Framework (WMF) version
5.1 or higher on those servers.
Type $PSVersiontable in PowerShell to verify that WMF is installed, and that the
version is 5.1 or higher.
High availability
2 Warning
Windows Admin Center version 2410 doesn't support high availability. If you are
using high availability, you won't be able to update.
You can enable high availability of the gateway service by deploying Windows Admin
Center in an active-passive model on a failover cluster. If one of the nodes in the cluster
fails, Windows Admin Center gracefully fails over to another node, letting you continue
managing the servers in your environment seamlessly.
Tip
Feedback
Was this page helpful? Yes No
7 Note
7 Note
Access to the gateway does not imply access to the target servers visible to the
gateway. To manage a target server, a user must connect with credentials that have
administrative privileges on the target server.
Gateway users can connect to the Windows Admin Center gateway service in order to
manage servers through that gateway, but they cannot change access permissions nor
the authentication mechanism used to authenticate to the gateway.
Gateway administrators can configure who gets access as well as how users will
authenticate to the gateway.
7 Note
If there are no access groups defined in Windows Admin Center, the roles will
reflect the Windows account access to the gateway server.
Smartcard authentication
When using Active Directory or local machine groups as the identity provider, you can
enforce smartcard authentication by requiring users who access Windows Admin Center
to be a member of additional smartcard-based security groups. Configure smartcard
authentication in Windows Admin Center.
Role-based access control is available for the Server Manager and Failover Cluster
solutions.
Available roles
Windows Admin Center supports the following end-user roles:
ノ Expand table
Administrators Allows users to use most of the features in Windows Admin Center without
granting them access to Remote Desktop or PowerShell. This role is good for
"jump server" scenarios where you want to limit the management entry points
on a machine.
Readers Allows users to view information and settings on the server, but not make
changes.
Hyper-V Allows users to make changes to Hyper-V virtual machines and switches, but
Administrators limits other features to read-only access.
The following built-in extensions have reduced functionality when a user connects with
limited access:
At this time, you cannot create custom roles for your organization, but you can choose
which users are granted access to each role.
If you only have a few computers, you can easily apply the configuration individually to
each computer using the role-based access control page in Windows Admin Center.
When you set up role-based access control on an individual computer, local security
groups are created to control access to each role. You can grant access to users or other
security groups by adding them as members of the role security groups.
Feedback
Was this page helpful? Yes No
There are some Server versions that need additional preparation before they are ready
to manage with Windows Admin Center:
There are also some scenarios where port configuration on the target server may need
to be modified before managing with Windows Admin Center.
Type $PSVersiontable in PowerShell to verify that WMF is installed, and that the version
is 5.1 or higher.
Type $PSVersiontable in PowerShell to verify that WMF is installed, and that the version
is 5.1 or higher.
Tip
Feedback
Was this page helpful? Yes No
This article describes the networking requirements for using Windows Admin center to
manage your servers and clusters.
Networking configuration
Windows Admin Center communicates outbound securely to endpoints over TCP port
443. By default, the Windows Admin Center gateway and browser uses the default route
to the internet to perform actions. You can optionally configure the gateway to use a
proxy server if your network requires it.
The gateway - this is the server or client machine where the Windows Admin
Center gateway (.msi) is installed.
The browser - this is the machine where the Windows Admin Center web service is
being accessed from.
If outbound connectivity is restricted by your firewall or proxy server, make sure the
URLs listed below are not blocked.
Gateway URLs
ノ Expand table
Cloud
Browser URLs
ノ Expand table
Next steps
Prepare your environment
Install Windows Admin Center
Feedback
Was this page helpful? Yes No
This topic describes how to install Windows Admin Center on a Windows client machine or on
a Windows Server 2025 remote server so that multiple users can access Windows Admin
Center using a web browser.
Tip
New to Windows Admin Center? Learn more about Windows Admin Center or Download
now.
Prerequisites
To install Windows Admin Center, you need the following prerequisites:
Optional: An SSL certificate used for Server Authentication ([Link].[Link].1). You can use a
self-signed certificate for testing, but you should always use a certificate from a trusted
certificate authority for production environments. If you don't have a certificate, you can
use the Windows Admin Center installer to generate a self-signed certificate. The
certificate is valid for 60 days.
If you're using the Server Core experience, download the Windows Admin Center installer
from the Windows Admin Center Evaluation Center to a location on the machine you
want to install Windows Admin Center on.
To install Windows Admin Center on your machine running the Windows Server Desktop
Experience, follow these steps:
1. Open the Start menu and enter Windows Admin Center Setup into the search bar to
search for Windows Admin Center.
2. Select the Windows Admin Center Setup app from the Best match list.
3. On the Get started with Windows Admin Center window, if you agree to the license
terms, select Next to continue.
4. The latest installer download starts automatically and is saved to the Downloads
folder, when complete, select Install. Selecting Install initiates the installer from the
Downloads folder.
5. On the Welcome to the Windows Admin Center setup wizard window, select Next
to continue.
6. On the License Terms and Privacy Statement window, if you agree to the terms
select I accept these terms and understand the privacy statement, then select Next
to start the installation process.
7. In the Select installation mode window, select Express setup, then select Next.
8. In the Select TLS certificate window, select the option that matches your needs, then
select Next.
7 Note
You must select which Transport Layer Security (TLS) certificate Windows Admin
Center should use. If you already have a certificate, it must be installed in the
LocalMachine\My certificates store. If you're installing Windows Admin Center for
testing purposes only, the installer can generate a self-signed certificate that
expires after 60 days.
9. In the Automatic updates window, select your preferred update option, then select
Next.
10. In the Send diagnostic data to Microsoft window, select your preference, then select
Next.
11. Review the Ready to install window, select Install to start the installation process.
12. After the installation process finishes, select Start Windows Admin Center, then
select Finish.
) Important
You can deploy Windows Admin Center in a failover cluster to provide high availability for your
Windows Admin Center gateway service. The solution provided is an active-passive solution,
where only one instance of Windows Admin Center is active. If one of the nodes in the cluster
fails, Windows Admin Center gracefully fails over to another node, letting you continue
managing the servers in your environment seamlessly.
Prerequisites
High-availability deployment script from Windows Admin Center HA Script zip file .
Download the .zip file containing the script to your local machine and then copy the
script as needed based on the guidance in this article.
A failover cluster of 2 or more nodes on Windows Server 2016, 2019, or 2022. Learn more
about deploying a Failover Cluster.
A cluster shared volume (CSV) for Windows Admin Center to store persistent data that
can be accessed by all the nodes in the cluster. 10 GB is sufficient for your CSV.
Recommended, but optional: a signed certificate .pfx & password. You don't need to have
already installed the certificate on the cluster nodes - the script does that for you. If you
don't supply one, the installation script generates a self-signed certificate, which expires
after 60 days.
Center. For example, if you run the script with the parameter -clientAccessPoint
contosoWindowsAdminCenter , you access the Windows Admin Center service by
visiting [Link]
-staticAddress : Optional. One or more static addresses for the cluster generic
service.
-msiPath : The path for the Windows Admin Center .msi file.
on port 443 (HTTPS). To use a different port, specify in this parameter. If you use a
custom port besides 443, you'll access the Windows Admin Center by going to
[Link]
7 Note
Examples
PowerShell
PowerShell
.\Install-WindowsAdminCenterHA.ps1 -clusterStorage "C:\ClusterStorage\Volume1" -
clientAccessPoint "contoso-ha-gateway" -msiPath ".\[Link]" -
StaticAddress (local ip address) -generateSslCert -Verbose
PowerShell
PowerShell
You may also update the certificate at the same time you update the Windows Admin Center
platform with a new .msi file.
PowerShell
PowerShell
Troubleshooting
Logs are saved in the temp folder of the CSV. For example, C:\ClusterStorage\Volume1\temp .
Windows Admin Center Settings
Article • 06/16/2023 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
User settings
User-level settings consist of the following sections:
Account
Language/Region
Personalization
Suggestions
In the Account tab, users can review the credentials they have used to authenticate to
Windows Admin Center. If Microsoft Entra ID is configured to be the identity provider,
the user can log out of their Microsoft Entra account from this tab.
In the Language/Region tab, users can change the language and region formats
displayed by Windows Admin Center.
In the Suggestions tab, users can toggle suggestions about Azure services and new
features.
Development settings
Development settings in Windows Admin Center consist of the following sections:
Advanced
Performance profile
The Advanced tab gives Windows Admin Center extension developers additional
capabilities.
The Performance profile tab lets you collect performance data about your Windows
Admin Center session.
Gateway settings
Gateway-level settings consist of the following sections:
Access
Diagnostics & feedback
Extensions
General
Internet Access
Proxy
Register
Updates
Shared Connections
WebSocket validation
Only gateway administrators are able to see and change these settings. Changes to
these settings change the configuration of the gateway and affect all users of the
Windows Admin Center gateway.
The Access tab lets administrators configure who can access the Windows Admin Center
gateway, as well as the identity provider used to authenticate users. Learn more about
controlling access to the gateway.
In the Diagnostics & feedback tab, users can choose how much diagnostic data they
want to send to Microsoft.
In the Extensions tab, administrators can install, uninstall, or update gateway extensions.
Learn more about extensions.
In the General tab, users can select to have their UI session of Windows Admin Center
expire after some period of inactivity.
The Internet Access tab lets administrators configure who can access the Windows
Admin Center gateway, as well as the identity provider used to authenticate users. Learn
more about controlling access to the gateway.
The Proxy tab allows users to configure a proxy server to redirect all Windows Admin
Center outbound traffic.
From the Register tab, administrators can register the gateway with Azure to enable
Azure integration features in Windows Admin Center.
Using the Updates tab, users can see which version of Windows Admin Center is
running and if this version is up to date.
Using the Shared Connections tab, administrators can configure a single list of
connections to be shared across all users of the Windows Admin Center gateway. Learn
more about configuring connections once for all users of a gateway.
Feedback
Was this page helpful? Yes No
If you haven't already, familiarize yourself with the user access control options in Windows
Admin Center.
7 Note
Gateway users can connect to the Windows Admin Center gateway service to manage servers
through that gateway, but they can't change access permissions nor the authentication
mechanism used to authenticate to the gateway.
Gateway administrators can configure who gets access as well as how users authenticate to
the gateway. Only gateway administrators can view and configure the Access settings in
Windows Admin Center. Local administrators on the gateway machine are always
administrators of the Windows Admin Center gateway service.
Windows Admin Center CredSSP Administrators are registered with the Windows Admin
Center CredSSP endpoint and have permissions to perform predefined CredSSP operations.
This group is especially useful for installations of Windows Admin Center in desktop mode,
where only the user account that installed Windows Admin Center is given these permissions
by default.
7 Note
Access to the gateway doesn't imply access to managed servers visible by the gateway. To
manage a target server, the connecting user must use credentials (either through their
passed-through Windows credential or through credentials provided in the Windows
Admin Center session using the Manage as action) that have administrative access to that
target server. This is because most Windows Admin Center tools require administrative
permissions to use.
On the Users tab, you can control who can access Windows Admin Center as a gateway user.
By default, and if you don't specify a security group, any user that accesses the gateway URL
has access. Once you add one or more security groups to the users list, access is restricted to
the members of those groups.
If you don't use an Active Directory domain in your environment, access is controlled by the
Users and Administrators local groups on the Windows Admin Center gateway machine.
Smartcard authentication
You can enforce smartcard authentication by specifying an additional required group for
smartcard-based security groups. Once you have added a smartcard-based security group, a
user can only access the Windows Admin Center service if they are a member of any security
group AND a smartcard group included in the users list.
On the Administrators tab, you can control who can access Windows Admin Center as a
gateway administrator. The local administrators group on the computer will always have full
administrator access and cannot be removed from the list. By adding security groups, you give
members of those groups privileges to change Windows Admin Center gateway settings. The
administrators list supports smartcard authentication in the same way as the users list: with the
AND condition for a security group and a smartcard group.
Microsoft Entra ID
If your organization uses Microsoft Entra ID, you can choose to add an additional layer of
security to Windows Admin Center by requiring Microsoft Entra authentication to access the
gateway. In order to access Windows Admin Center, the user's Windows account must also
have access to gateway server (even if Microsoft Entra authentication is used). When you use
Microsoft Entra ID, you'll manage Windows Admin Center user and administrator access
permissions from the Azure portal, rather than from within the Windows Admin Center UI.
Accessing Windows Admin Center when Microsoft Entra
authentication is enabled
Depending on the browser used, some users accessing Windows Admin Center with Microsoft
Entra authentication configured will receive an additional prompt from the browser where they
need to provide their Windows account credentials for the machine on which Windows Admin
Center is installed. After entering that information, the users will get the additional Microsoft
Entra authentication prompt, which requires the credentials of an Azure account that has been
granted access in the Microsoft Entra application in Azure.
7 Note
Users whose Windows account has Administrator rights on the gateway machine will not
be prompted for the Microsoft Entra authentication.
By default, all members of the Microsoft Entra tenant have user access to the Windows Admin
Center gateway service. Only local administrators on the gateway machine have administrator
access to the Windows Admin Center gateway. Note that the rights of local administrators on
the gateway machine cannot be restricted - local admins can do anything regardless of
whether Microsoft Entra ID is used for authentication.
If you want to give specific Microsoft Entra users or groups gateway user or gateway
administrator access to the Windows Admin Center service, you must do the following:
1. Go to your Windows Admin Center Microsoft Entra application in the Azure portal by
using the hyperlink provided in Access Settings. Note this hyperlink is only available when
Microsoft Entra authentication is enabled.
You can also find your application in the Azure portal by going to Microsoft Entra
ID > Enterprise applications > All applications and searching
WindowsAdminCenter (the Microsoft Entra app will be named
WindowsAdminCenter-<gateway name>). If you don't get any search results, ensure
Show is set to all applications, application status is set to any and select Apply,
then try your search. Once you've found the application, go to Users and groups
2. In the Properties tab, set User assignment required to Yes. Once you've done this, only
members listed in the Users and groups tab will be able to access the Windows Admin
Center gateway.
3. In the Users and groups tab, select Add user. You must assign a gateway user or gateway
administrator role for each user/group added.
Once you turn on Microsoft Entra authentication, the gateway service restarts and you must
refresh your browser. You can update user access for the SME Microsoft Entra application in
the Azure portal at any time.
Users will be prompted to sign in using their Microsoft Entra identity when they attempt to
access the Windows Admin Center gateway URL. Remember that users must also be a member
of the local Users on the gateway server to access Windows Admin Center.
Users and administrators can view their currently logged-in account and as well as sign out of
this Microsoft Entra account from the Account tab of Windows Admin Center Settings.
If you want to give specific Microsoft Entra users or groups gateway user or gateway
administrator access to the Windows Admin Center service, you must do the following:
When you select Change access control and then select Microsoft Entra ID from
the Windows Admin Center Access settings, you can use the hyperlink provided in
the UI to access your Microsoft Entra application in the Azure portal. This hyperlink
is also available in the Access settings after you select save and have selected
Microsoft Entra ID as your access control identity provider.
You can also find your application in the Azure portal by going to Microsoft Entra
ID > Enterprise applications > All applications and searching SME (the Microsoft
Entra app will be named SME-<gateway>). If you don't get any search results,
ensure Show is set to all applications, application status is set to any and select
Apply, then try your search. Once you've found the application, go to Users and
groups
2. In the Properties tab, set User assignment required to Yes. Once you've done this, only
members listed in the Users and groups tab will be able to access the Windows Admin
Center gateway.
3. In the Users and groups tab, select Add user. You must assign a gateway user or gateway
administrator role for each user/group added.
Once you save the Microsoft Entra access control in the Change access control pane, the
gateway service restarts and you must refresh your browser. You can update user access for the
Windows Admin Center Microsoft Entra application in the Azure portal at any time.
Users will be prompted to sign in using their Microsoft Entra identity when they attempt to
access the Windows Admin Center gateway URL. Remember that users must also be a member
of the local Users on the gateway server to access Windows Admin Center.
Using the Azure tab of Windows Admin Center general settings, users and administrators can
view their currently logged-in account and as well as sign out of this Microsoft Entra account.
Learn more about configuring conditional access with Microsoft Entra ID.
When you install Windows Admin Center on Windows 10, it's ready to use single sign-on. If
you're going to use Windows Admin Center on Windows Server, however, you need to set up
some form of Kerberos delegation in your environment before you can use single sign-on. The
delegation configures the gateway computer as trusted to delegate to the target node.
PowerShell
PowerShell
Setting up RBAC consists of two steps: enabling support on the target computer(s) and
assigning users to the relevant roles.
Tip
Make sure you have local administrator privileges on the machines where you are
configuring support for role-based access control.
PowerShell modules with functions required by Windows Admin Center will be installed
on your system drive, under C:\Program Files\WindowsPowerShell\Modules . All modules
will start with [Link]
Desired State Configuration will run a one-time configuration to configure a Just Enough
Administration endpoint on the machine, named [Link]. This
endpoint defines the three roles used by Windows Admin Center and will run as a
temporary local administrator when a user connects to it.
Three new local groups will be created to control which users are assigned access to
which roles:
Windows Admin Center Administrators
Windows Admin Center Hyper-V Administrators
Windows Admin Center Readers
7 Note
Role-based access control is not supported for cluster management (i.e. features that are
dependent on RBAC such as CredSSP will fail).
To enable support for role-based access control on a single machine, follow these steps:
1. Open Windows Admin Center and connect to the machine you wish to configure with
role-based access control using an account with local administrator privileges on the
target machine.
2. On the Overview tool, select Settings > Role-based access control.
3. Select Apply at the bottom of the page to enable support for role-based access control
on the target computer. The application process involves copying PowerShell scripts and
invoking a configuration (using PowerShell Desired State Configuration) on the target
machine. It may take up to 10 minutes to complete, and will result in WinRM restarting.
This will temporarily disconnect Windows Admin Center, PowerShell, and WMI users.
4. Refresh the page to check the status of role-based access control. When it is ready for
use, the status will change to Applied.
Once the configuration is applied, you can assign users to the roles:
1. Open the Local Users and Groups tool and navigate to the Groups tab.
2. Select the Windows Admin Center Readers group.
3. In the Details pane at the bottom, select Add User and enter the name of a user or
security group that should have read-only access to the server through Windows Admin
Center. The users and groups can come from the local machine or your Active Directory
domain.
4. Repeat steps 2-3 for the Windows Admin Center Hyper-V Administrators and Windows
Admin Center Administrators groups.
You can also fill these groups consistently across your domain by configuring a Group Policy
Object with the Restricted Groups Policy Setting.
If you're running the Windows Admin Center gateway in service mode on Windows Server, use
the following command to download the configuration package. Be sure to update the
gateway address with the correct one for your environment.
PowerShell
$WindowsAdminCenterGateway = '[Link]
Invoke-RestMethod -Uri
"$WindowsAdminCenterGateway/api/nodes/all/features/jea/endpoint/export" -Method
POST -UseDefaultCredentials -OutFile "~\Desktop\WindowsAdminCenter_RBAC.zip"
If you're running the Windows Admin Center gateway on your Windows 10 machine, run the
following command instead:
PowerShell
When you expand the zip archive, you'll see the following folder structure:
InstallJeaFeatures.ps1
JustEnoughAdministration (directory)
Modules (directory)
[Link].* (directories)
To configure support for role-based access control on a node, you need to perform the
following actions:
2. Update InstallJeaFeature.ps1 file to match your desired configuration for the RBAC
endpoint.
3. Run InstallJeaFeature.ps1 to compile the DSC resource.
4. Deploy your DSC configuration to all of your machines to apply the configuration.
The following section explains how to do this using PowerShell Remoting.
By default, the configuration script will create local security groups on the machine to control
access to each of the roles. This is suitable for workgroup and domain joined machines, but if
you're deploying in a domain-only environment you may wish to directly associate a domain
security group with each role. To update the configuration to use domain security groups, open
InstallJeaFeatures.ps1 and make the following changes:
7 Note
Be sure to use unique security groups for each role. Configuration will fail if the same
security group is assigned to multiple roles.
Next, at the end of the InstallJeaFeatures.ps1 file, add the following lines of PowerShell to the
bottom of the script:
PowerShell
Copy-Item "$PSScriptRoot\JustEnoughAdministration"
"$env:ProgramFiles\WindowsPowerShell\Modules" -Recurse -Force
$ConfigData = @{
AllNodes = @()
ModuleBasePath = @{
Source = "$PSScriptRoot\Modules"
Destination = "$env:ProgramFiles\WindowsPowerShell\Modules"
}
}
InstallJeaFeature -ConfigurationData $ConfigData | Out-Null
Start-DscConfiguration -Path "$PSScriptRoot\InstallJeaFeature" -JobName
"Installing JEA for Windows Admin Center" -Force
Finally, you can copy the folder containing the modules, DSC resource and configuration to
each target node and run the InstallJeaFeature.ps1 script. To do this remotely from your admin
workstation, you can run the following commands:
PowerShell
$ComputersToConfigure | ForEach-Object {
$session = New-PSSession -ComputerName $_ -ErrorAction Stop
Copy-Item -Path "~\Desktop\WindowsAdminCenter_RBAC\JustEnoughAdministration\"
-Destination "$env:ProgramFiles\WindowsPowerShell\Modules\" -ToSession $session -
Recurse -Force
Copy-Item -Path "~\Desktop\WindowsAdminCenter_RBAC" -Destination
"$env:TEMP\WindowsAdminCenter_RBAC" -ToSession $session -Recurse -Force
Invoke-Command -Session $session -ScriptBlock { Import-Module
JustEnoughAdministration; &
"$env:TEMP\WindowsAdminCenter_RBAC\InstallJeaFeature.ps1" } -AsJob
Disconnect-PSSession $session
}
Install and manage extensions
Article • 11/13/2024 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
Windows Admin Center is built as an extensible platform where each connection type
and tool is an extension that you can install, uninstall, and update individually. You can
search for new extensions published by Microsoft and other developers, and install and
update them individually without having to update the entire Windows Admin Center
installation. You can also configure a separate NuGet feed or file share and distribute
extensions to use internally within your organization.
Installing an extension
Windows Admin Center shows extensions available from the specified NuGet feed. By
default, Windows Admin Center points to the Microsoft official NuGet feed which hosts
extensions published by Microsoft and other developers.
1. Select the Settings button in the top-right > In the left pane, select Extensions.
2. The Available Extensions tab lists the extensions on the feed that are available for
installation.
3. Select on an extension to view the extension description, version, publisher and
other information in the Details pane.
4. Select Install to install an extension. If the gateway must run in elevated mode to
make this change, you're presented with a User Account Control (UAC) elevation
prompt. After installation is complete, your browser automatically refreshes and
Windows Admin Center reloads with the new extension installed. If the extension
you are trying to install is an update to a previously installed extension, you can
select the Update to latest button to install the update. You can also go to the
Installed Extensions tab to view installed extensions and see if an update is
available in the Status column.
1. Select the Settings button in the top-right > In the left pane, select Extensions.
2. On the right pane, select the Feeds tab.
3. Select the Add button to add another feed. For a NuGet feed, enter the NuGet V2
feed URL. The NuGet feed provider or administrator should be able to provide the
URL information. For a file share, enter the full path of the file share in which the
extension package files (.nupkg) are stored. If adding a file share as a feed, it must
meet the following criteria:
4. Select Add. If the gateway must run in elevated mode to make this change, you're
presented with a UAC elevation prompt. This prompt will only be presented if you
are running Windows Admin Center in desktop mode.
The Available Extensions list shows extensions from all registered feeds. You can check
which feed each extension is from using the Package Feed column.
Uninstalling an extension
You can uninstall any extensions you have previously installed, or even uninstall any
tools that were preinstalled as part of the Windows Admin Center installation.
1. Select the Settings button in the top-right > In the left pane, select Extensions.
2. Select the Installed Extensions tab to view all installed extensions.
3. Choose an extension to uninstall, then select Uninstall.
After uninstall is complete, your browser automatically refreshes and Windows Admin
Center reloads with the extension removed. If you uninstalled a tool that was
preinstalled as part of Windows Admin Center, the tool is available for reinstallation in
the Available Extensions tab.
You may need to create a Microsoft account and sign-in to view the
extension packages.
2. Select on the name of the package you want to install to view the package details
page.
3. Select on the Download link in the top navigation bar of the package details page
and download the .nupkg file for the extension.
4. Repeat steps 2 and 3 for all the packages you want to download.
5. Copy the package files to a file share that can be accessed from the computer
Windows Admin Center is installed on, or to the local disk of the computer on
which Windows Admin Center is installed.
1. As described in the blog post , install the script as a NuGet package, or copy and
paste the script into the PowerShell ISE.
2. Edit the first line of the script to your NuGet feed's v2 URL. If you are downloading
packages from the Windows Admin Center official feed, use the following URL:
PowerShell
$feedUrlBase = "[Link]
3. Run the script and it downloads all the NuGet packages from the feed to the
following local folder: %USERPROFILE%\Documents\NuGetLocal
4. Follow the instructions to install extensions from a different feed.
Manage extensions with PowerShell
Windows Admin Center Preview includes a PowerShell module to manage your gateway
extensions.
PowerShell
# List feeds
Get-Feed "[Link]
# Install an extension (locate the latest version from all feeds and install
it)
Install-Extension -GatewayEndpoint "[Link]
"[Link]"
# Uninstall-Extension
Uninstall-Extension "[Link] "[Link]"
# Update-Extension
Update-Extension "[Link] "[Link]"
7 Note
You must be gateway administrator to modify Windows Admin Center extensions
with PowerShell.
Learn more about building an extension with the Windows Admin Center SDK.
Feedback
Was this page helpful? Yes No
With the ability to configure shared connections, gateway administrators can configure
the connections list once for all users of a given Windows Admin Center gateway. This
feature is only available on Windows Admin Center service mode.
From the Shared Connections tab of Windows Admin Center gateway Settings, gateway
administrators can add servers, clusters, and PC connections as you would from the all
connections page, including the ability to tag connections. Any connections and tags
added in the Shared Connections list will appear for all users of this Windows Admin
Center gateway, from their all connections page.
When any Windows Admin Center user accesses the "All Connections" page after
Shared Connections have been configured, they will see their connections grouped into
two sections: Personal and Shared connections. The Personal group is a specific user's
connection list and persists across that user's browser sessions. The Shared connections
group is the same across all users, and cannot be modified from the All Connections
page.
Feedback
Was this page helpful? Yes No
If you have a large organization with multiple Windows Admin Center servers, you can
use PowerShell to configure the list of connections and extensions on multiple servers at
a time.
type : The connection type. For the default connections included with Windows
ノ Expand table
Connection type Connection string
groupId : The column for shared connections. Use the value global in this column
7 Note
"name","type","tags","groupId"
"[Link]","[Link]","hyperv"
"[Link]","[Link]-server","hyperv"
"[Link]","[Link]-
[Link]","legacyCluster|WS2016","global"
"[Link],"[Link]-
[Link]","myHCIcluster|hyperv|JIT|WS2019"
"[Link]","[Link]-
[Link]","legacyCluster|WS2016","global"
"[Link]","[Link]-
[Link]","myHCIcluster|hyperv|JIT|WS2019"
7 Note
1. Copy and paste the following code into your PowerShell session:
PowerShell
<#
.SYNOPSIS
Convert an .rdg file from Remote Desktop Connection Manager into a .csv
that can be imported into Windows Admin Center, maintaining groups via
server tags. This will not modify the existing .rdg file and will
create a new .csv file
.DESCRIPTION
This converts an .rdg file into a .csv that can be imported into
Windows Admin Center.
.PARAMETER RDGfilepath
The path of the .rdg file to be converted. This file will not be
modified, only read.
.PARAMETER CSVdirectory
Optional. The directory you want to export the new .csv file. If it's
not provided, the new file is created in the same directory as the .rdg
file.
.EXAMPLE
C:\PS> RdgToWacCsv -RDGfilepath "[Link]"
#>
function RdgToWacCsv {
param(
[Parameter(Mandatory = $true)]
[String]
$RDGfilepath,
[Parameter(Mandatory = $false)]
[String]
$CSVdirectory
)
[xml]$RDGfile = Get-Content -Path $RDGfilepath
$node = $[Link]
if (!$CSVdirectory){
$csvPath = [[Link]]::GetDirectoryName($RDGfilepath) +
[[Link]]::GetFileNameWithoutExtension($RDGfilepath) +
"_WAC.csv"
} else {
$csvPath = $CSVdirectory +
[[Link]]::GetFileNameWithoutExtension($RDGfilepath) +
"_WAC.csv"
}
New-item -Path $csvPath
Add-Content -Path $csvPath -Value '"name","type","tags"'
AddServers -node $node -csvPath $csvPath
Write-Host "Converted $RDGfilepath `nOutput: $csvPath"
}
PowerShell
3. Import the resulting CSV file into Windows Admin Center. Tags in the connection
list represent your RDCMan grouping hierarchy.
# List feeds
Get-Feed "[Link]
# Install an extension (locate the latest version from all feeds and install
it)
Install-Extension -GatewayEndpoint "[Link]
"[Link]"
# Uninstall-Extension
Uninstall-Extension "[Link] "[Link]"
# Update-Extension
Update-Extension "[Link] "[Link]"
7 Note
Additional References
Deploy a highly available Windows Admin Center gateway on a cluster
Deploy a Windows Admin Center gateway in Azure using Cloud Shell
Feedback
Was this page helpful? Yes No
To protect WebSocket access, WebSocket connection will now validate origin state from
the browser so not any external application could get access the WebSocket API defined
on the gateway.
Customization of validation
Validation can be adjusted to customize various conditions.
User can configure WebSocket override setting at a Windows Admin Center registry
value, HKLM\Software\Microsoft\ServerManagementGateway\WebSocketValidationOverride ,
to specify exceptional origin host name and origin port. This include wildcard name
such as " *.[Link] " or just " * " to accept all. Wildcard must be specified
single form like " *. " and cannot be combined with complex string match condition like
" something*something ".
Always allows origin host defined on current TLS certificate. (subject name,
alternate DNS names)
Always allows origin port configured to Windows Admin Center
" * " - accept any origin host and origin port
" *:9876 " - accept any origin host and origin port 9876
" :9876 " - accept origin port 9876
"* .[Link] " - accept origin host <[Link]...>.[Link]
" *.[Link] " - accept origin host <[Link]...>.[Link] and
origin port 9876
Prevention logic
Gateway adds a session cookie (WAC-SESSION) for user browser. It associates the
browser session and username always. It prevents different user attempting using the
same browser session.
When UI starts a WebSocket connection the browser sends the session cookie back
to Gateway.
Gateway validates authenticated username matched with the session cookie
always.
Gateway looks for origin header, which is endpoint URL that original Windows Admin
Center site was loaded.
Gateway validated origin host and origin port against current SSL certificate
settings which includes list of DNS host names. This tells the UI code is loaded
from expected DNS name sites and port.
RDP enhancement
On RDP TCP connection, Gateway only allows to use port 3389 (RDP) and port 2179 (VM
connection), so TCP forwarding feature cannot be used for any other purpose.
value to set the IP address or just specify " * " to ignore validation.
Feedback
Was this page helpful? Yes No
This article describes how to get started with Windows Admin Center after you
download and install it on a Windows PC. To learn more about Windows Admin
Center, see Windows Admin Center overview.
) Important
You must be a member of the local administrators group to use Windows Admin
Center on Windows 10.
1. On the Start menu, select Windows Admin Center. Or enter Windows Admin
Center on the search bar and then select it from the search results.
Windows Admin Center opens in your default browser with the URL
[Link] . Alternatively, you can start it from your desired browser
by entering [Link] .
7 Note
Select the certificate labeled Windows Admin Center Client, and then select OK.
You can also select the Certificate information link to see more details about the
certificate.
) Important
Be sure to select Windows Admin Center Client and not any other certificate.
If you select any other certificate, the following error message appears:
"You are not authorized to view this page. If you recently updated Windows
Admin Center, you may need to restart your browser, and then refresh the
page."
If you continue to get the same error even after restarting your browser and
refreshing the page, try clearing the browser cache or switching to another
browser. If none of these troubleshooting steps resolve the issue, you might
need to uninstall and reinstall Windows Admin Center, and then restart it.
3. (First time only:) A pop-up window confirms that your Windows Admin Center
version is successfully installed. It also provides information on what's new in this
release. Close the window to proceed.
The All connections page shows your Windows 10 computer name in the list of
connections. You're now ready to add connections to Windows Admin Center.
The types of resources that you can add from the All connections page are servers,
Windows PCs, clusters, and Azure VMs. The resources that you can create are clusters
and Azure VMs.
7 Note
To add or create an Azure VM, you must first register Windows Admin Center with
Azure.
2. The types of resources that you can add are displayed. Select Add for the resource
type that you want to add.
Select the tab based on how you want to add resources. The label for each tab can
differ based on the resource type that you're adding.
Add one
Adding one resource at a time is the default method. The label for this tab
appears as Add cluster when you're adding a cluster.
As you begin entering text, Windows Admin Center starts searching for a
resource based on your text string. If a match is found, you can add the
name exactly as you entered it or use the default resource name. If no
match is found, you can still add this resource to appear in your list of
connections.
4. (Optional:) Select Add tags to add connection tags. You can use tags to identify
and filter related resources in your connection list. For more information, see Use
tags to organize your connections later in this article.
7 Note
2. Select Manage as to specify the credentials that you'll use to authenticate to the
managed node.
3. If Windows Admin Center is running in service mode on Windows Server, but you
don't have Kerberos delegation configured, you must reenter your Windows
credentials.
You can apply the credentials to all connections, which will cache them for that specific
browser session. If you reload your browser, you must reenter your Manage as
credentials.
Edit tags
You can add tags to a connection while you're adding a new connection. Or you can add
or edit them later for one or more connections on the All connections page.
3. On the Available tags pane, you can take any of these actions:
To add a new tag to your selected connections, select Add tags and enter a
desired tag name.
To tag the selected connections with an existing tag name, select the
checkbox next to the tag name that you want to apply.
To remove a tag from all selected connections, clear the checkbox next to the
tag that you want to remove.
You can select Or, And, or Not to modify the filter behavior of the selected tags.
ノ Expand table
groupId : The column for shared connections. Use the value global in this column
7 Note
"name","type","tags","groupId"
"[Link]","[Link]","hyperv"
"[Link]","[Link]-server","hyperv"
"[Link]","[Link]-
[Link]","legacyCluster|WS2016","global"
"[Link],"[Link]-
[Link]","myHCIcluster|hyperv|JIT|WS2019"
"[Link]","[Link]-
[Link]","legacyCluster|WS2016","global"
"[Link]","[Link]-
[Link]","myHCIcluster|hyperv|JIT|WS2019"
7 Note
1. Copy and paste the following code into your PowerShell session:
PowerShell
<#
.SYNOPSIS
Convert an .rdg file from Remote Desktop Connection Manager into a .csv
that can be imported into Windows Admin Center, maintaining groups via
server tags. This will not modify the existing .rdg file and will
create a new .csv file
.DESCRIPTION
This converts an .rdg file into a .csv that can be imported into
Windows Admin Center.
.PARAMETER RDGfilepath
The path of the .rdg file to be converted. This file will not be
modified, only read.
.PARAMETER CSVdirectory
Optional. The directory you want to export the new .csv file. If it's
not provided, the new file is created in the same directory as the .rdg
file.
.EXAMPLE
C:\PS> RdgToWacCsv -RDGfilepath "[Link]"
#>
function RdgToWacCsv {
param(
[Parameter(Mandatory = $true)]
[String]
$RDGfilepath,
[Parameter(Mandatory = $false)]
[String]
$CSVdirectory
)
[xml]$RDGfile = Get-Content -Path $RDGfilepath
$node = $[Link]
if (!$CSVdirectory){
$csvPath = [[Link]]::GetDirectoryName($RDGfilepath) +
[[Link]]::GetFileNameWithoutExtension($RDGfilepath) +
"_WAC.csv"
} else {
$csvPath = $CSVdirectory +
[[Link]]::GetFileNameWithoutExtension($RDGfilepath) +
"_WAC.csv"
}
New-item -Path $csvPath
Add-Content -Path $csvPath -Value '"name","type","tags"'
AddServers -node $node -csvPath $csvPath
Write-Host "Converted $RDGfilepath `nOutput: $csvPath"
}
PowerShell
3. Import the resulting CSV file into Windows Admin Center. Tags in the connection
list represent your RDCMan grouping hierarchy.
View PowerShell scripts used in Windows
Admin Center
After you connect to a server, cluster, or PC, you can view the PowerShell scripts that
power the UI actions available in Windows Admin Center:
1. From within a tool, select the PowerShell icon on the application bar.
Feedback
Was this page helpful? Yes No
Tip
New to Windows Admin Center? Download or learn more about Windows Admin
Center.
You can add individual servers running Windows Server to Windows Admin Center so
that you can manage them by using a comprehensive set of tools.
The server is added to your list of connections on the All connections page. Select it to
connect to the server.
7 Note
Summary of tools
The following table briefly describes the tools that are available in Windows Admin
Center for server connections. Sections in this article provide more details for all the
tools except Performance Monitor and Packetmon (whose links go to blog posts).
ノ Expand table
Tool Description
Local users & groups View and modify local users and groups.
Microsoft Defender for Cloud View and configure Microsoft Defender for Cloud.
Storage Migration Service Migrate servers and file shares to Azure or Windows Server 2019.
System Insights Get increased insight into the functioning of your servers.
Overview
The Overview page shows the current state of CPU, memory, and network performance.
You can also use it to perform operations and modify settings on a target computer or
server.
Overview supports these features:
Create a user.
Create a group.
Search for users, computers, and groups.
View a details pane for users, computers, and groups when they're selected in a
grid.
Perform global grid actions for users, computers, and groups (disable, enable, and
remove).
Reset user passwords.
Configure basic properties and group memberships for user objects.
Configure delegation to a single machine for computer objects.
Manage membership for group objects. (Add or remove one user at a time.)
Azure Backup
Use Azure Backup to help protect your Windows server from corruptions, attacks, or
disasters by backing up your server directly to Microsoft Azure. Learn more about Azure
Backup .
Azure Monitor
Use Azure Monitor to monitor your servers and configure alerts. Learn more about
Azure Monitor.
Certificates
Use Certificates to manage certificate stores on a computer or server.
Containers
Use Containers to view the containers on a Windows Server container host. In the case
of a running Windows Server Core container, you can view the event logs and access the
command-line interface of the container. It's available on the extension feed.
Devices
Use Devices to manage connected devices on a computer or server.
DHCP
Use DHCP to manage connected devices on a computer or server. It's available on the
extension feed.
DNS
Use DNS to manage connected devices on a computer or server. It's available on the
extension feed.
View details of DNS forward lookup zones, reverse lookup zones, and DNS records.
Create forward lookup zones (primary, secondary, and stub), and configure the
properties of forward lookup zones.
Create Host (A or AAAA), CNAME, and MX types of DNS records.
Configure the properties of DNS records.
Create IPv4 and IPv6 reverse lookup zones (primary, secondary, and stub), and
configure the properties of reverse lookup zones.
Create PTR and CNAME types of DNS records under reverse lookup zones.
Events
Use Events to manage event logs on a computer or server.
Files
Use Files to manage files and folders on a computer or server.
Firewall
Use Firewall to manage firewall settings and rules on a computer or server.
Installed apps
Use Installed apps to list and uninstall applications that are installed.
Networks
Use Networks to manage network devices and settings on a computer or server.
PowerShell
Use PowerShell to interact with a computer or server via a PowerShell session.
Processes
Use Processes to manage running processes on a computer or server.
Registry
Use Registry to manage registry keys and values on a computer or server.
Remote Desktop
Use Remote Desktop to interact with a computer or server via an interactive desktop
session.
Scheduled tasks
Use Scheduled tasks to manage scheduled tasks on a computer or server.
Security
Use Security to manage your security settings on a computer or server.
Services
Use Services to manage services on a computer or server.
Settings
Settings is a central location to manage settings on a computer or server.
Storage
Use Storage to manage storage devices on a computer or server.
7 Note
Storage Replica
Use Storage Replica to manage server-to-server storage replication. Learn more about
Storage Replica.
System Insights
System Insights introduces predictive analytics natively in Windows Server to give you
increased insight into the functioning of your server. Get an overview of System Insights.
7 Note
Updates
Use Updates to manage Microsoft and Windows updates on a computer or server.
Virtual machines
See Manage virtual machines by using Windows Admin Center.
Virtual switches
Use Virtual switches to manage Hyper-V virtual switches on a computer or server.
Feedback
Was this page helpful? Yes No
Provide product feedback
Manage Windows Defender Application
Control (WDAC)-enforced infrastructure
Article • 02/10/2025 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
Windows Defender Application Control (WDAC) can help mitigate many security threats
by restricting the applications that users are allowed to run and the code that runs in the
system core (kernel). Application control policies can also block unsigned scripts and
MSI files, and restrict Windows PowerShell to running in ConstrainedLanguage mode.
Learn more about application control for Windows.
Extra configuration is required for Windows Admin Center to install on and manage
WDAC-enforced environments. This article covers these requirements and known issues
in managing a WDAC-enforced environment.
Requirements
The following sections provide the requirements for using Windows Admin Center to
manage your WDAC-enforced infrastructure (servers, client machines, or clusters).
Policy requirements
Depending on your use case, you need to add one or more certificates to your allowlist
as part of your base or supplemental policies. Learn more about deploying a base or
supplemental policy.
For Case 1, only the following signer rule needs to be allowlisted in the WDAC policy on
your managed node:
XML
XML
The signer rule with CertPublisher Value=".NET" is not required if you're using a version
of Windows Admin Center older than 2410. However, these older versions require the
following file/hash rules to be allowlisted only on the machine on which you deploy
Windows Admin Center:
XML
<FileRules>
<!--Requirement from WAC to allow files from WiX-->
<Allow ID="ID_ALLOW_E_X_XXXX_X" FriendlyName="WiX [Link]"
Hash="9DE61721326D8E88636F9633AA37FCB885A4BABE" />
<Allow ID="ID_ALLOW_E_X_XXXX_XXXX_X" FriendlyName="WiX [Link]"
Hash="B216DFA814FC856FA7078381291C78036CEF0A05" />
<Allow ID="ID_ALLOW_E_X_XXXX_X" FriendlyName="WiX [Link]"
Hash="233F5E43325615710CA1AA580250530E06339DEF861811073912E8A16B058C69" />
<Allow ID="ID_ALLOW_E_X_XXXX_XXXX_X" FriendlyName="WiX [Link]"
Hash="B216DFA814FC856FA7078381291C78036CEF0A05" />
<Allow ID="ID_ALLOW_E_X_XXXX_X" FriendlyName="WiX [Link] 2"
Hash="EB4CB5FF520717038ADADCC5E1EF8F7C24B27A90" />
<Allow ID="ID_ALLOW_E_X_XXXX_XXXX_X" FriendlyName="WiX [Link] 2"
Hash="6C65DD86130241850B2D808C24EC740A4C509D9C" />
<Allow ID="ID_ALLOW_E_X_XXXX_X" FriendlyName="WiX [Link] 2"
Hash="C8D190D5BE1EFD2D52F72A72AE9DFA3940AB3FACEB626405959349654FE18B74" />
<Allow ID="ID_ALLOW_E_X_XXXX_XXXX_X" FriendlyName="WiX [Link] 2"
Hash="6C65DD86130241850B2D808C24EC740A4C509D9C" />
<Allow ID="ID_ALLOW_E_X_XXXX_X" FriendlyName="WiX [Link]"
Hash="2F0903D4B21A0231ADD1B4CD02E25C7C4974DA84" />
<Allow ID="ID_ALLOW_E_X_XXXX_XXXX_X" FriendlyName="WiX [Link]"
Hash="868635E434C14B65AD7D7A9AE1F4047965740786" />
<Allow ID="ID_ALLOW_E_X_XXXX_X" FriendlyName="WiX [Link]"
Hash="5C29B8255ACE0CD94C066C528C8AD04F0F45EBA12FCF94DA7B9CA1B64AD4288B" />
<Allow ID="ID_ALLOW_E_X_XXXX_XXXX_X" FriendlyName="WiX [Link]"
Hash="868635E434C14B65AD7D7A9AE1F4047965740786" />
</FileRules>
The policy creation tool/script should automatically generate Signer ID and Allow ID
(that is, Signer ID="ID_SIGNER_S_XXXXX" ). For more info, refer to the WDAC
documentation.
Tip
The App Control for Business Wizard can be helpful for creating and editing
WDAC policies. Remember that when you're creating a new policy, whether by
using the wizard or the PowerShell commands, use the Publisher rule on binaries
to generate rules. For example, when you're using the wizard, you can generate the
WDAC policy for Case 1 based on the Windows Admin Center .msi file. For Case 2,
you can still use the wizard, but you need to manually edit your WDAC policy to
include the listed signer and hash rule.
Network requirements
By default, Windows Admin Center communicates with your servers via WinRM over
HTTP (port 5985) or HTTPS (port 5986). For WDAC-enforced infrastructure, Windows
Admin Center additionally needs SMB access to the managed nodes (TCP port 445).
Permissions
File transfer based on UNC paths over SMB port 445 is critical for Windows Admin
Center to manage these environments. Make sure that you're an administrator on the
managed server or cluster. Also make sure that security policies aren't blocking file
transfers.
Installing
Install Windows Admin Center on your WDAC-enforced server or client machine just as
you normally would. If you meet the preceding requirements, Windows Admin Center
should install and function as normal.
Connecting
Connect to your WDAC-enforced server, client, or cluster machines as you normally
would. Upon connecting to your server, you can track the enforcement status via the
PowerShell Language Mode field on the Overview page. If the value of this field is
Constrained, WDAC is being enforced.
When you connect to a WDAC-enforced cluster for the first time, Windows Admin
Center might take a few minutes to set up a connection to your cluster. Subsequent
connections won't have a delay.
7 Note
If you change the WDAC enforcement status of your managed nodes, don't use
Windows Admin Center for at least 30 seconds for this change to be reflected.
Known issues
Currently, deploying Azure Kubernetes Service on Azure Local and Azure Arc
resource bridge through Windows Admin Center isn't supported in a WDAC-
enforced environment.
Troubleshooting
If you get a "Module not found" or "failed to connect" error:
Ensure that the machine where Windows Admin Center is installed has access to
TCP port 445 on the managed node.
Related content
WDAC design guide
WDAC deployment guide
AppLocker overview
Feedback
Was this page helpful? Yes No
You can use Windows Admin Center version 1910 or later to deploy a hyperconverged
infrastructure by using two or more suitable Windows servers. This feature takes the
form of a multistage workflow that guides you through installing features, configuring
networking, creating the cluster, and deploying Storage Spaces Direct and/or software-
defined networking (SDN).
As of Windows Admin Center version 2007, Windows Admin Center supports the Azure
Stack HCI operating system. To read about how to deploy a cluster in Windows Admin
Center, see the Azure Local documentation. Although that documentation is focused on
Azure Local, most of the instructions are applicable to Windows Server deployments.
PowerShell
2 Warning
These cmdlets permanently delete any data in Storage Spaces Direct volumes. You
can't undo this action.
PowerShell
Get-VirtualDisk | Remove-VirtualDisk
Get-StoragePool -IsPrimordial $False | Remove-StoragePool
Disable-ClusterS2D
PowerShell
Remove-Cluster -CleanUpAD
To also remove cluster validation reports, run this cmdlet on every server that was part
of the cluster:
PowerShell
PowerShell
Get-VMSwitch | Remove-VMSwitch
The Remove-VMSwitch cmdlet automatically removes any virtual adapters and undoes
switch-embedded teaming of physical adapters.
If you modified network adapter properties such as name, IPv4 address, and VLAN ID,
use the following cmdlets.
2 Warning
These cmdlets remove network adapter names and IP addresses. Make sure that
you have the information that you need to connect afterward, such as an adapter
for management that's excluded from the script. Also make sure that you know
how the servers are connected in terms of physical properties like MAC address,
not just the adapter's name in Windows.
PowerShell
Related content
Windows Admin Center overview
Deploy Storage Spaces Direct on Windows Server
Feedback
Was this page helpful? Yes No
You can use Windows Admin Center to manage and monitor a hyper-converged
infrastructure that's running Windows Server 2016 or Windows Server 2019. Windows
Admin Center is the next-generation management tool for Windows Server. It's the
successor to traditional "in-box" tools like Server Manager. It's free and can be installed
and used without an internet connection.
Some of the features that this article describes are available only in Windows Admin
Center Preview. For more information, see Windows Admin Center overview.
Tip
Unified dashboard for compute, storage, and networking. View your virtual
machines (VMs), host servers, volumes, drives, and more within one purpose-built,
consistent, interconnected experience.
Creation and management of storage spaces and Hyper-V virtual machines. Use
simple workflows to create, open, resize, and delete volumes. Or use workflows to
create, start, connect to, and move virtual machines.
Powerful cluster-wide monitoring. The dashboard graphs memory and CPU
usage, storage capacity, input/output operations per second (IOPS), throughput,
and latency in real time across every server in the cluster. Get clear alerts when
something isn't right.
Software Defined Networking support. Manage and monitor virtual networks and
subnets, connect virtual machines to virtual networks, and monitor the SDN
infrastructure.
Tip
1. Verify that every server in the cluster installed the 2018-05 Cumulative Update for
Windows Server 2016 (KB4103723) or later. To download and install this update,
go to Settings > Update & Security > Windows Update and select Check online
for updates from Microsoft Update.
PowerShell
Tip
You need to run the cmdlet only once, on any server in the cluster. You can run it
locally in Windows PowerShell or use CredSSP to run it remotely. Depending on
your configuration, you might not be able to run this cmdlet from within Windows
Admin Center.
1. Prepare the virtual hard disk (VHD) of the operating system, which is the same
operating system that you installed on the hyper-converged infrastructure hosts.
This VHD will be used for all NC-series, Software Load Balancer (SLB), and gateway
VMs.
2. Download all the folders and files under SDN Express from GitHub .
3. Prepare a different VM by using the deployment console. This VM should be able
to access the SDN hosts. Also, the VM should have the Remote Server
Administration Tools (RSAT) Hyper-V package installed.
4. Copy everything that you downloaded for SDN Express to the deployment console
VM, and share this SDNExpress folder. Make sure every host can access the
SDNExpress shared folder, as defined in line 8 of the configuration file:
\\$env:Computername\SDNExpress
5. Copy the VHD of the operating system to the images folder under the SDNExpress
folder on the deployment console VM.
PowerShell
3. Enter the name of the cluster. If you're prompted, select the credentials to use.
The cluster is added to your list of connections. Select it to open the dashboard.
3. Enter the name of the cluster. If you're prompted, select the credentials to use.
5. Enter the network controller URI value, and then select Validate.
6. Select Add to finish.
The cluster is added to your list of connections. Select it to open the dashboard.
) Important
Although Windows Admin Center offers powerful and convenient integration with the
Microsoft Azure cloud platform, the core management and monitoring experience for
hyper-converged infrastructures is completely on-premises. You can install and use it
without an internet connection.
Things to try
Now that you understand the basics of using Windows Admin Center to manage and
monitor a hyper-converged infrastructure, you can try more tasks in your environment.
Expand a volume
[Link]
Delete a volume
[Link]
2. At the top of the Virtual Machines pane, select the Inventory tab, and then select
New.
3. Enter the virtual machine name, and choose between generation 1 and generation
2.
4. Choose a host for the virtual machine, or use the recommended host.
5. Choose a path for the virtual machine files. Select a volume from the dropdown
list, or select Browse to choose a folder. The virtual machine configuration files and
virtual hard disk file will be saved in a single folder under the \Hyper-V\[virtual
machine name] path of the selected volume or path.
6. Choose the number of virtual processors and whether you want nested
virtualization enabled. Configure memory settings, network adapters, and virtual
hard disks. Choose whether you want to install an operating system from an .iso
image file or from the network.
7. Select Create.
8. After the virtual machine is created and appears in the list of virtual machines, start
it.
9. Connect to the virtual machine's console via VMConnect to install the operating
system. Select the virtual machine from the list, and then select More > Connect to
download the .rdp file. Open the .rdp file in the Remote Desktop Connection app.
Because you're connecting to the virtual machine's console, you need to enter the
Hyper-V host's admin credentials.
Learn more about virtual machine management with Windows Admin Center.
4. Select Pause server for maintenance. If it's safe to proceed, this action moves
virtual machines to other servers in the cluster. The server has a status of Draining
during this process.
If you want, you can watch the virtual machines move on the Virtual machines >
Inventory pane, where the grid clearly shows their host server. After all the virtual
machines move, the server status is Paused.
5. Select Manage server to access all the per-server management tools in Windows
Admin Center.
7. Back on the dashboard, the server is colored red while it's down. After it's back up,
go to the Server page and select Resume server from maintenance to set the
server status to Up. In time, virtual machines will move back. No user action is
required.
Or to browse through drives and see their status for yourself, you can either:
On the Inventory tab, the grid supports sorting, grouping, and keyword search.
2. On the dashboard, select the alert to see details, like the drive's physical location.
To learn more, select the Go to drive shortcut to the Drive detail page.
3. If your hardware supports it, you can select Turn light on/off to control the drive's
indicator light.
4. Storage Spaces Direct automatically retires and evacuates failed drives. When this
process happens, the drive status is Retired, and its storage capacity bar is empty.
6. In Drives > Inventory, the new drive appears. In time, the alert will clear, volumes
will repair back to OK status, and storage will rebalance onto the new drive. No
user action is required.
Manage virtual networks (SDN-enabled HCI clusters via
Windows Admin Center Preview)
1. On the left pane, select Virtual Networks.
2. On the Inventory tab, select New to create a new virtual network and subnets. Or
choose an existing virtual network and then select Settings to modify its
configuration.
2. Choose an existing virtual machine, select Settings, and then open the Networks
tab.
3. Configure the Virtual Network and Virtual Subnet fields to connect the virtual
machine to a virtual network.
You can also configure the virtual network when you're creating a virtual machine.
2. View detailed information about the health of your network controller, software
load balancer, and virtual gateway. You can also monitor your virtual gateway pool,
public and private IP pool usage, and SDN host status.
Manage GPUs
1. On the left pane, select GPUs.
2. View the available GPUs from your clustered VMs, and provide GPU acceleration to
workloads running in the clustered VMs through Discrete Device Assignment.
Learn more about using GPUs with clustered VMs .
Use the security tool
1. On the left pane, select Security.
2. Select the Secured-core tab, and then enable or disable the available security
features.
Give us feedback
The most important benefit of frequent updates is to hear what's working and what
needs to be improved. Here are some ways to let us know what you're thinking:
Feedback
Was this page helpful? Yes No
Tip
New to Windows Admin Center? Download or learn more about Windows Admin
Center.
Failover Clustering is a Windows Server feature that enables you to group multiple
servers together into a fault-tolerant cluster. The purpose is to increase availability and
scalability of applications and services such as Scale-Out File Server, Hyper-V, and
Microsoft SQL Server.
You can manage failover cluster nodes as individual servers by using Server Manager to
add them in Windows Admin Center. But you can also add them as failover clusters to
view and manage cluster resources, storage, networks, nodes, roles, virtual machines,
and virtual switches.
The cluster is added to your list of connections on the Overview page. Select it to
connect to the cluster.
7 Note
You can also manage hyper-converged clusters by adding the cluster as a hyper-
converged cluster connection in Windows Admin Center.
Tools
The following areas of Windows Admin Center represent tools that are available for
failover cluster connections:
ノ Expand table
Area Description
Feedback
Was this page helpful? Yes No
Provide product feedback
Manage virtual machines by using
Windows Admin Center
Article • 02/10/2025 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
The Virtual Machines tool in Windows Admin Center is available in server, failover
cluster, or hyper-converged cluster connections if the Hyper-V role is enabled on the
server or cluster. You can use the Virtual Machines tool to manage Hyper-V hosts
running Windows Server, either installed with Desktop Experience or installed as Server
Core. Hyper-V Server 2016 and 2019 are also supported.
High-level Hyper-V host resource monitoring. View overall CPU and memory
usage, I/O performance metrics, and virtual machine (VM) health alerts and events
for the Hyper-V host server or the entire cluster in a single dashboard.
Unified experience that brings together Hyper-V Manager and Failover Cluster
Manager capabilities. View all the virtual machines across a cluster and drill down
into a single virtual machine for advanced management and troubleshooting.
Simplified, yet powerful workflows for virtual machine management. Use UI
experiences that are tailored to IT administration scenarios to create, manage, and
replicate virtual machines.
This article describes some of the Hyper-V tasks that you can do in Windows Admin
Center.
2. Use the Summary tab to get a holistic view of Hyper-V host resources and
performance for the current server or the entire cluster. The information includes:
The number of VMs grouped by state: Running, Off, Paused, and Saved.
Recent health alerts or Hyper-V event log events. Alerts are available only for
hyper-converged clusters running Windows Server 2016 or later.
Line charts for storage performance are available only for hyper-converged
clusters running Windows Server 2016 or later. Historical data is available
only for hyper-converged clusters running Windows Server 2019.
View a list of the virtual machines running on the current server or cluster.
View a virtual machine's state and host server if you're viewing virtual
machines for a cluster. Also view CPU and memory usage from the host
perspective, including memory pressure, memory demand, and assigned
memory.
View a virtual machine's uptime, heartbeat status, and protection status by
using Azure Site Recovery.
Create a virtual machine.
Delete, start, turn off, shut down, pause, resume, reset, or rename a virtual
machine. Also save the virtual machine, delete a saved state, or create a
checkpoint.
Change settings for a virtual machine.
Connect to a virtual machine console by using VMConnect via the Hyper-V
host.
Replicate a virtual machine by using Azure Site Recovery.
Select multiple VMs and run an operation on all of them at once. This ability
applies to operations that you can run on multiple VMs, such as start, shut
down, save, pause, delete, and reset.
7 Note
If you're connected to a cluster, the Virtual Machine tool displays only clustered
virtual machines.
5. If you're creating a virtual machine on a cluster, you can choose a host for the
virtual machine. If you're running Windows Server 2016 or later, the tool provides a
host recommendation for you.
6. Choose a path for the virtual machine files. Select a volume from the dropdown
list, or select Browse to choose a folder. The virtual machine configuration files and
the virtual hard disk (.vhd) file will be saved in a single folder under the \Hyper-V\\
[virtual machine name] path of the selected volume or path.
Tip
You can browse to any available Server Message Block (SMB) share on the
network by entering the path in the Folder name field as \\server\share .
Using a network share for VM storage requires CredSSP.
7. Choose the number of virtual processors and whether you want nested
virtualization enabled. Configure memory settings, network adapters, and virtual
hard disks. Choose whether you want to install an operating system from an .iso
image file or from the network.
8. Select Create.
9. After the virtual machine is created and appears in the list of virtual machines, start
it.
10. Connect to the virtual machine's console via VMConnect to install the operating
system. Select the virtual machine from the list, and then select Connect >
Download RDP file to download the RDP file. Open the RDP file in the Remote
Desktop Connection app. Because you're connecting to the virtual machine's
console, you need to enter the Hyper-V host's admin credentials.
3. Choose a virtual machine from the list, and then select Settings.
4. For each of the General, Memory, Processors, Disks, Networks, Boot order, and
Checkpoints tabs, configure the necessary settings, and then select the button that
saves the current tab's settings.
The available settings vary, depending on the virtual machine's generation. Also,
some settings can't be changed for running virtual machines. For those settings,
you need to stop the virtual machine first.
3. Choose a virtual machine from the list, and then select Manage > Move.
4. Choose a server from the list of available cluster nodes, and then select Move.
5. Notifications for the move progress appear in the upper-right corner of Windows
Admin Center. If the move is successful, the host server name changes in the list of
virtual machines.
3. Choose a virtual machine from the list. In the pane that opens, you can:
3. Choose a virtual machine from the list, and then select one of these options:
Connect. Interact with the guest VM through the Remote Desktop web
console that's integrated into Windows Admin Center.
Download RDP file. Download an RDP file that you can open with the
Remote Desktop Connection application ([Link]).
Both options use VMConnect to connect to the guest VM through the Hyper-V
host. They both require you to enter administrator credentials for the Hyper-V host
server.
2. On a Hyper-V host server or cluster, the Hyper-V Host Settings group has the
following sections. Make the necessary changes.
General. Change virtual hard disks, virtual machine file path, and hypervisor
schedule type (if it's supported).
Enhanced Session Mode
NUMA Spanning
Live Migration
Storage Migration
If you make any Hyper-V host setting changes in a hyper-converged cluster or failover
cluster connection, the change will be applied to all cluster nodes.
4. The Event Viewer tool shows the Hyper-V event channels on the left pane. Choose
a channel to view the events on the right pane.
Feedback
Was this page helpful? Yes No
Windows Admin Center writes event logs that show the management activities performed on
the servers in your environment. Event logs can also help you troubleshoot any Windows
Admin Center problems.
Management activities
Windows Admin Center provides insight into the management activities performed on the
servers in your environment by logging actions to the WindowsAdminCenter event channel in
the event log of the managed server. EventID is 4000 , and Source is SMEGateway .
Windows Admin Center logs only actions on the managed server. Events aren't logged if a user
accesses a server for read-only purposes.
ノ Expand table
Key Value
PowerShell PowerShell script name that was run on the server, if the action ran a PowerShell script.
CIM CIM call that was run on the server, if the action ran a CIM call.
Gateway Name of the Windows Admin Center gateway machine where the action was run.
UserOnGateway Username that's used to access the Windows Admin Center gateway and execute the
action.
UserOnTarget Username that's used to access the target managed server, if it's different from
UserOnGateway . That is, the user accessed the server by using Manage as credentials.
Delegation Boolean, if the target managed server trusts the gateway and credentials are delegated
from the user's client machine.
LAPS Boolean, if the user accessed the server by using LAPS credentials.
File Name of the uploaded file, if the action was a file upload.
Gateway usage
Windows Admin Center logs gateway activity to the event channel on the gateway computer to
help you troubleshoot issues and view metrics on usage. These events are also logged to the
WindowsAdminCenter event channel.
By using Windows Admin Center, you can manage Windows Server machines running
on Amazon EC2 in Amazon Web Services. In this article, you learn how to prepare and
connect a Windows Server machine running on Amazon EC2 to Windows Admin Center
by using a public IP address.
Prerequisites
Have a running Amazon EC2 instance.
Configure WinRM for HTTPS. WinRM HTTPS requires a server authentication
certificate for a local computer, with a CN that matches the public name of your
Windows Server Amazon EC2 instance. For more information, see How to
configure WINRM for HTTPS.
Enable inbound connections for your Amazon EC2 instance. For more information,
see the AWS documentation .
For Type, select WinRM-HTTPS. For the port range, enter 5986.
For Source, select IP Addresses, and then enter the source IP address that
corresponds to your Windows Admin Center gateway.
7 Note
Alternatively, you can connect to your Amazon EC2 instance via HTTP by selecting
WinRM-HTTP and entering 5985 as your port range. However, we recommend that
you consider the security implications.
1. Enable WinRM access to your target Amazon EC2 instance by running the winrm
quickconfig command in PowerShell on the target EC2 instance.
2. Enable inbound connections to port 5986 for WinRM over HTTPS by running the
following PowerShell script on the target EC2 instance: Set-NetFirewallRule -Name
WINRM-HTTPS-In-TCP-PUBLIC -RemoteAddress Any . Alternatively, you can configure
2. On the Add or create resource menu, in the Servers section, select Add.
3. For Server name, enter the public IPv4 address of your Amazon EC2 instance.
4. Select Use another account for this connection and enter your Windows
credentials.
Related content
Now that you've set up your Amazon EC2 instance with Windows Admin Center, learn
how to manage it:
Feedback
Was this page helpful? Yes No
You can extend on-premises deployments of Windows Server to the cloud by using
Azure hybrid services. These cloud services provide an array of useful functions, both for
extending on-premises into Azure, and for centrally managing from Azure.
Using Azure hybrid services within Windows Admin Center, you can:
Protect virtual machines and use cloud-based backup and disaster recovery
(HA/DR).
Extend on-premises capacity with storage and compute in Azure, and simplify
network connectivity to Azure.
Centralize monitoring, governance, configuration, and security across your
applications, network, and infrastructure with the help of cloud-intelligent Azure
management services.
You can set up most Azure hybrid services by downloading an app and doing some
manual configuration. Many Azure hybrid services are integrated directly into Windows
Admin Center to provide a simplified setup experience and a server-centric view of the
services. Windows Admin Center also provides convenient intelligent hyperlinks to the
Azure portal to see connected Azure resources as well as a centralized view of your
hybrid environment.
Discover integrated services in the Azure
hybrid services tool
The Azure hybrid services tool in Windows Admin Center consolidates all the integrated
Azure services into a centralized hub where you can easily discover all the available
Azure services that bring value to your on-premises or hybrid environment.
If you connect to a server with Azure services already enabled, the Azure hybrid services
tool lets you see all enabled services on that server in a single glance. You can easily get
to the relevant tool within Windows Admin Center, launch out to the Azure portal for
deeper management of those Azure services, or learn more with documentation at your
fingertips.
Back up your Windows Server from Windows Admin Center with Azure Backup
Protect your Hyper-V Virtual Machines from Windows Admin Center with Azure
Site Recovery
Sync your file server with the cloud, using Azure File Sync
Manage operating system updates for all your Windows servers, both on-premises
or in the cloud, with Azure Update Management
Monitor servers, both on-premises or in the cloud, and configure alerts with Azure
Monitor
Apply governance policies to your on-premises servers through Azure Policy using
Azure Arc for servers
Secure your servers and get advanced threat protection with Microsoft Defender
for Cloud
Connect your on-premises servers to an Azure Virtual Network with Azure Network
Adapter
Make Azure VMs look like your on-premises network with Azure Extended
Network
The regional support for each Azure hybrid service is different. Broadly, the following
table shows the clouds supported for each Azure hybrid service in Windows Admin
Center:
ノ Expand table
For a more detailed regional support breakdown for each service, see Azure products
available by region .
Protect your Hyper-V virtual machines with Azure Site Recovery You can replicate
workloads running on VMs so that your business-critical infrastructure is protected
in case of a disaster. Windows Admin Center streamlines setup and the process of
replicating your virtual machines on your Hyper-V servers or clusters, making it
easier to bolster the resiliency of your environment with Azure Site Recovery's
disaster recovery service. For more info, see Protect your VMs with Azure Site
Recovery and Windows Admin Center.
Migrate storage to a VM in Azure using Storage Migration Service Use the step-
by-step tool to inventory data on Windows and Linux servers and then transfer the
data to a new Azure VM. Windows Admin Center can create a new Azure VM for
the job that is right-sized and correctly configured to receive the data from your
source server. For more info, see Use Storage Migration Service to migrate a server.
Leverage Azure to achieve quorum on your failover cluster with Cloud Witness
Instead of investing in additional hardware to achieve quorum on a 2-node cluster,
you can use an Azure storage account to serve as the cluster witness for your
Azure Local cluster or other failover cluster. For more info, see Deploy a Cloud
Witness for a Failover Cluster.
Make Azure VMs look like your on-premises network with Azure Extended
Network Windows Admin Center can set up a site-to-site VPN and extend your
on-premises IP addresses into your Azure vNet to let you more easily migrate
workloads into Azure without breaking dependencies on IP addresses.
Centrally manage operating system updates for all your Windows Servers with
Azure Update Management You can manage updates and patches for multiple
servers and VMs from a single place, instead of on a per-server basis. With Azure
Update Management, you quickly can assess the status of available updates,
schedule installation of required updates, and review deployment results to verify
updates that apply successfully. This is possible whether your servers are Azure
VMs, hosted by other cloud providers, or on-premises. For more info, see Use
Windows Admin Center to manage operating system updates with Azure Update
Management.
Improve your security posture and get advanced threat protection with
Microsoft Defender for Cloud Microsoft Defender for Cloud is a unified
infrastructure security management system that strengthens the security posture
of your data centers, and provides advanced threat protection across your hybrid
workloads in the cloud - whether they're in Azure or not - as well as on premises.
With Windows Admin Center, you can easily set up and connect your servers to
Microsoft Defender for Cloud. For more info, see Integrate Microsoft Defender for
Cloud with Windows Admin Center (Preview).
Apply policies and ensure compliance across your hybrid environment with
Azure Arc for servers and Azure Policy Inventory, organize, and manage on-
premises servers from Azure. You can govern servers using Azure policy, control
access using RBAC, and enable additional management services from Azure.
Back up your Windows Server from Windows Admin Center with Azure Backup
Protect your Hyper-V Virtual Machines from Windows Admin Center with Azure
Site Recovery
Sync your file server with the cloud, using Azure File Sync
Manage operating system updates for all your Windows servers, both on-premises
or in the cloud, with Azure Update Management
Monitor servers, both on-premises or in the cloud, and configure alerts with Azure
Monitor
Apply governance policies to your on-premises servers through Azure Policy using
Azure Arc for servers
Secure your servers and get advanced threat protection with Microsoft Defender
for Cloud
Connect your on-premises servers to an Azure Virtual Network with Azure Network
Adapter
Make Azure VMs look like your on-premises network with Azure Extended
Network
Additional References
Connect Windows Admin Center to Azure
Deploy Windows Admin Center in Azure
Feedback
Was this page helpful? Yes No
Windows Admin Center streamlines the process of backing up your Windows Servers to
Azure and protecting you from accidental or malicious deletions, corruption and even
ransomware. To automate setup, you can connect the Windows Admin Center gateway
to Azure.
Use the following information to configure Backup for you Windows Server and create a
Backup policy to backup your server's Volumes and the Windows System State from the
Windows Admin Center.
Azure Backup offers multiple components that you download and deploy on the
appropriate computer, server, or in the cloud. The component, or agent, that you deploy
depends on what you want to protect. All Azure Backup components (no matter
whether you're protecting data on-premises or in Azure) can be used to back up data to
a Recovery Services vault in Azure.
The integration of Azure Backup in the Windows Admin Center is ideal for backing up
volumes and the Windows System state on-premises Windows physical or virtual
servers. This makes for a comprehensive mechanism to backup File Servers, Domain
Controllers and IIS Web Servers.
Windows Admin Center exposes the Azure Backup integration via the native Backup
tool. The Backup tool provides setup, management and monitoring experiences to
quickly start backing up your servers, perform common backup and restore operations
and to monitor overall backup health of your Windows Servers.
Prerequisites and planning
An Azure Account with at least one active subscription
The target Windows Servers that you want to backup must have Internet access to
Azure
Connect your Windows Admin Center gateway to Azure
To start the workflow to backup your Windows Server, open a server connection, click on
the Backup tool and follow the steps mentioned below.
If Azure Backup is already configured, clicking on the Backup tool will open the Backup
Dashboard. Refer to the (Management and Monitoring) section to discover operations
and tasks that can be performed from the dashboard.
7 Note
If you have connected your Windows Admin Center gateway to Azure, you should
be automatically logged in to Azure. You can click sign-out to further sign-in as a
different user.
Subscription Id: The Azure subscription you want to use backing up your Windows
Server to Azure. All Azure assets like the Azure Resource Group, the Recovery
Services Vault will be created in the selected Subscription.
Vault: The Recovery Services Vault where your servers' backups will be stored. You
can select from existing vaults or Windows Admin Center will create a new Vault.
Resource Group: The Azure Resource Group is a container for a collection of
resources. The Recovery Services vault is created or contained in the specified
Resource Group. You can select from existing Resource Groups or Windows Admin
Center will create a new one.
Location: The Azure region where the Recovery Services Vault will be created. It is
recommended to select the Azure region closest to the Windows Server.
7 Note
The first backup is a full-backup of all the selected data. However, subsequent
backups are incremental in nature and transfer only the changes to the data since
the previous backup.
Select from multiple preset Backup Schedules for you System State and/or
Volumes.
7 Note
The passphrase must be stored in a secure offsite location such as another server or
the Azure Key Vault. Microsoft does not store the passphrase and cannot retrieve
or reset the passphrase if it is lost or forgotten.
Access the Vault in Azure: You can click on the Recovery Services Vault link in the
Overview tab of the Backup Dashboard to be taken to the Vault in Azure to
perform a rich set of management operations
Perform an ad hoc backup: Click on Backup Now to take an ad hoc backup.
Monitor Jobs and Configure alert notifications: Navigate to the Jobs tab of the
dashboard to monitor on-going or past jobs and configure alert notifications to
receive emails for any failed jobs or other backup related alerts.
View Recovery Points and Recover Data: Click on the Recovery Points tab of the
dashboard to view the Recovery Points and click on Recover Data for steps to
recover you data from Azure.
Feedback
Was this page helpful? Yes No
This guide describes how to protect Windows and Linux VM workloads running on your Azure
Local if there's a disaster. You can use Azure Site Recovery to replicate your on-premises Azure
Local virtual machines (VMs) into Azure and protect your business critical workloads.
This feature is enabled on Azure Local running the May 2023 cumulative update of version
22H2 and later.
) Important
This feature is currently in PREVIEW. See the Supplemental Terms of Use for Microsoft
Azure Previews for legal terms that apply to Azure features that are in beta, preview, or
otherwise not yet released into general availability.
The disaster recovery strategy for Azure Site Recovery consists of the following steps:
Replication - Replication lets you replicate the target VM’s VHD to an Azure Storage
account and thus protects your VM if there's a disaster.
Failover - Once the VM is replicated, fail over the VM and run it in Azure. You can also
perform a test failover without impacting your primary VMs to test the recovery process
in Azure.
Re-protect – VMs are replicated back from Azure to the on-premises system.
Failback - You can fail back from Azure to the on-premises system.
In the current implementation of Azure Site Recovery integration with Azure Local, you can
start the disaster recovery and prepare the infrastructure from the Azure Local resource in the
Azure portal. After the preparation is complete, you can finish the remaining steps from the
Site Recovery resource in the Azure portal.
7 Note
To test Azure Site Recovery for Azure Local VMs, you can temporarily configure
Application Control policy to Audit mode. However, using Audit policy mode isn't
recommended for production environments. To set policy mode to Audit, follow the
instructions in Manage Application Control for Azure Local. Once the installation is
complete, revert the policy mode to Enforced.
Overall workflow
Here are the main steps that occur when using Site Recovery with an Azure Local:
1. Start with a registered Azure Local on which you enable Azure Site Recovery.
2. Make sure that you meet the prerequisites before you begin.
3. Create the following resources in your Azure Local resource portal:
a. Recovery services vault
b. Hyper-V site
c. Replication policy
4. Once you have created all the resources, prepare infrastructure.
5. Enable VM replication. Complete the remaining steps for replication in the Azure Site
Recovery resource portal and begin replication.
6. Once the VMs are replicated, you can fail over the VMs and run on Azure.
7. To fail back from Azure, follow the instructions in Fail back from Azure.
Supported scenarios
The following table lists the scenarios that are supported for Azure Site Recovery and Azure
Local.
ノ Expand table
If an Azure Local VM is deleted after a failover, manual intervention is needed to fail back
to the same or a different host..
The Hyper-V VMs that you intend to replicate should be made highly available for
replication to happen. If VMs aren't highly available, then the replication would fail. For
more information, see How to make an existing Hyper-V machine VM highly available .
Make sure that Hyper-V is set up on the Azure Local.
The machines hosting the VMs you want to protect must have internet access to replicate
to Azure.
The Azure Local must already be registered.
The system must be running May cumulative update for Azure Local, version 22H2.
If you're running an earlier build, the Azure portal indicates that the disaster recovery
isn't supported as managed identity isn't enabled for older versions.
Run the repair registration cmdlet to ensure that a managed identity is created for
your Azure Local resource and then retry the workflow. For more information, go to
Enable enhanced management from Azure for Azure Local.
The system must be Arc-enabled. If the system isn't Arc-enabled, you see an error in
the Azure portal to the effect that the Capabilities tab isn't available.
You need owner permissions on the Recovery Services Vault to assign permissions to the
managed identity. You also need read/write permissions on the Azure Local resource and
its child resources.
Review the caveats associated with the implementation of this feature.
Review the capacity planning tool to evaluate the requirements for successful replication
and failover.
On your Azure Local target system, follow these steps to prepare infrastructure:
1. In the Azure portal, go to the Overview pane of the target system resource that is hosting
VMs that you want to protect.
2. In the right-pane, go to the Capabilities tab and select the Disaster recovery tile. As
managed identity is enabled on your system, disaster recovery should be available.
5. On the Prepare infrastructure, select an existing or create a new Recovery services vault.
You use this vault to store the configuration information for virtual machine workloads.
For more information, see Recovery services vault overview.
a. If you choose to create a new Recovery services vault, the subscription and resource
groups are automatically populated.
b. Provide a vault name and select the location of the vault same as where the system is
deployed.
) Important
Select Review + Create to start the vault creation. For more information, see Create
and configure a Recovery services vault.
7. Select an existing Replication policy or create new. This policy is used to replicate your
VM workloads. For more information, see Replication policy. After the policy is created,
select OK.
8. Select Prepare infrastructure. When you select Prepare infrastructure, the following
actions occur:
a. A Resource Group with the Storage Account and the specified Vault and the
replication policy are created in the specified Location.
d. Replication policy is associated with the specified Hyper-V site and the target system
host is registered with the Azure Site Recovery service.
If you don't have owner level access to the subscription/resource group where you
create the vault, you see an error to the effect that you don't have authorization to
perform the action.
9. Depending on the number of nodes in your system, the infrastructure preparation could
take several minutes. You can watch the progress by going to Notifications (the bell icon
at the top right of the window).
1. On Step 2: Enable replication, select Enable replication. You're now directed to the
Recovery services vault where you can specify the VMs to replicate.
2. Select Replicate and in the dropdown select Hyper-V machines to Azure.
3. On the Source environment tab, specify the source location for your Hyper-V site. In this
instance, you have set up the Hyper-V site on your Azure Local resource. Select Next.
b. For Post-failover resource group, select the resource group name to which you fail
over. When the failover occurs, the VMs in Azure are created in this resource group.
c. For Post-failover deployment model, select Resource Manager. The Azure Resource
Manager deployment is used when the failover occurs.
d. For Storage, select the type of Azure storage you are replicating to. We recommend
using managed disk.
e. For the network configuration of the VMs that you’ve selected to replicate in Azure,
provide a virtual network and a subnet that would be associated with the VMs in
Azure. To create this network, see the instructions in Create an Azure network for
failover.
Once the VM is replicated, you can select the replicated VM and go to the Compute
and Network setting and provide the network information.
5. Select Next.
6. On the Virtual machine selection tab, select the VMs to replicate, and then select Next.
Make sure to review the capacity requirements for protecting the VM.
7. On the Replication settings tab, select the operating system type, operating system disk,
and the data disks for the VM you intend to replicate to Azure, and then select Next.
8. On the Replication policy tab, verify that the correct replication policy is selected. The
selected policy should be the same replication policy that you created when preparing
the infrastructure. Select Next.
9. On the Review tab, review your selections, and then select Enable Replication.
a. To view the Replication health and Status, select the VM and go to the Overview. You
can see the percentage completion of the replication job.
b. To see a more granular job status and Job id, select the VM and go to the Properties
of the replicated VM.
c. To view the disk information, go to Disks. Once the replication is complete, the
Operating system disk and Data disk should show as Protected.
1. If you didn't specify the network configuration for the replicated VM, you can complete
that configuration now.
a. First, make sure that an Azure network is set up to test failover as per the instructions
in Create a network for test failover.
b. Select the VM and go to the Compute and Network settings and specify the virtual
network and the subnet. The failed-over VM in Azure attaches to this virtual network
and subnet.
2. Once the replication is complete and the VM is Protected as reflected in the status, you
can start Test Failover.
3. To run a test failover, see the detailed instructions in Run a disaster recovery drill to Azure.
You can also use the test failover feature of Recovery Plan to test the recovery of the
application. Recovery Plan lets you group VMs, sequence the order in which they should be
brought up during a failover, and automate other steps to be performed as part of the
recovery process. Once you've protected your VMs, you can go to the Azure Site Recovery
vault in the Azure portal and create recovery plans for these VMs. Learn more about recovery
plans.
Caveats
Consider the following information before you use Azure Site Recovery to protect your on-
premises VM workloads by replicating those VMs to Azure.
Extensions installed by Arc aren’t visible on the Azure VMs. The Arc-enabled server will
still show the extensions that are installed, but you can't manage those extensions (for
example, install, upgrade, or uninstall) while the machine is in Azure.
Guest Configuration policies won't run while the machine is in Azure, so any policies that
audit the OS security/configuration won't run until the machine is migrated back on-
premises.
Log data (including Sentinel, Defender, and Azure Monitor info) will be associated with
the Azure VM while it's in Azure. Historical data is associated with the Arc-enabled server.
If it's migrated back on-premises, it starts being associated with the Arc-enabled server
again. They can still find all the logs by searching by computer name as opposed to
resource ID, but it's worth noting the Portal UX experiences look for data by resource ID
so you'll only see a subset on each resource.
We strongly recommend that you don't install the Azure VM Guest Agent to avoid
conflicts with Arc if there's any potential that the machine will be migrated back on-
premises. If you need to install the guest agent, make sure that the VM has extension
management disabled. If you try to install/manage extensions using the Azure VM guest
agent when there are already extensions installed by Arc on the same machine (or vice
versa), you run into all sorts of issues because our agents are unaware of the previous
extension installations and will encounter state reconciliation issues.
Known issues
Here's a list of known issues and the associated workarounds in this release:
ノ Expand table
# Issue Workaround/Comments
1. When you register Azure Site In this instance, your VMs may not be protected. Verify that
Recovery with a system, a machine all machines in the system are registered in the Azure portal
fails to install Azure Site Recovery or by going to the Recovery Services vault > Jobs > Site
register to the Azure Site Recovery Recovery Jobs.
service.
2. Azure Site Recovery agent fails to When the Azure Site Recovery agent installation fails, it is
install. No error details are seen at because of the one of the following reasons:
the system or machine levels in the
Azure Local portal. - Installation fails as Hyper-V isn't set up on the host.
3. Azure Site Recovery agent fails to The installation fails when Application Control is enforced.
install. Error message of "Microsoft
Azure Site Recovery Provider - Setting Application Control policy mode to Audit mode will
installation has failed with exit code - allow the installation to complete. However, this isn't
1." appears in the portal with the recommended for production environments. To set the
failed installation. policy mode to Audit, follow the instructions in Manage
Application Control for Azure Local.
Next steps
Learn more about Hybrid capabilities with Azure services.
Sync your file server with the cloud by
using Azure File Sync
Article • 11/04/2024 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
Use Azure File Sync to centralize your organization's file shares in Azure, while keeping
the flexibility, performance, and compatibility of an on-premises file server. Azure File
Sync transforms Windows Server into a quick cache of your Azure file share with the
optional cloud tiering feature. You can use any protocol that's available on Windows
Server to access your data locally, including SMB, NFS, and FTPS.
Once your files have synced to the cloud, you can connect multiple servers to the same
Azure file share to sync and cache the content locally—permissions (ACLs) are always
transported as well. Azure Files offers a snapshot capability that can generate differential
snapshots of your Azure file share. These snapshots can even be mounted as read-only
network drives via SMB for easy browsing and restore. Combined with cloud tiering,
running an on-premises file server has never been easier.
Azure File Sync in Windows Admin Center is supported on Windows Server 2012 R2,
Windows Server 2016, Windows Server 2019, Windows Server 2022, and Windows
Server 2025.
For more info, see Planning for an Azure File Sync deployment.
Feedback
Was this page helpful? Yes No
Azure Monitor is a solution that collects, analyzes, and acts on telemetry from various
resources, including Windows Servers and VMs, both on-premises and in the cloud.
Though Azure Monitor pulls data from Azure virtual machines (VMs) and other Azure
resources, this article focuses on how Azure Monitor works with on-premises servers
and VMs, specifically with Windows Admin Center. If you're interested to learn how you
can use Azure Monitor to get email alerts about your hyper-converged cluster, read
about using Azure Monitor to send emails for Health Service Faults.
When you enable a monitoring solution in a Log Analytics workspace, all the servers
reporting to that workspace starts collecting data relevant to that solution, so that the
solution can generate insights for all the servers in the workspace.
To collect telemetry data on an on-premises server and push it to the Log Analytics
workspace, Azure Monitor requires the installation of the Microsoft Monitoring Agent,
or the MMA. Certain monitoring solutions also require a secondary agent. For example,
Azure Monitor for VMs also needs on the Dependency agent for functionality that this
solution provides.
Some solutions, like Azure Update Management, also depend on Azure Automation,
which enables you to centrally manage resources across Azure and non-Azure
environments. For example, Azure Update Management uses Azure Automation to
schedule and orchestrate installation of updates across machines in your environment,
centrally, from the Azure portal.
You can get started using Azure Monitor from either of these tools. If you've never used
Azure Monitor before, Windows Admin Center automatically provisions a Log Analytics
workspace (and Azure Automation account, if needed). Windows Admin Center also
installs and configures the Microsoft Monitor Agent (MMA) on the target server, and
installs the corresponding solution into the workspace.
For instance, if you first go to the Updates tool to set up Azure Update Management,
Windows Admin Center will:
If you want to add another monitoring solution from within Windows Admin Center on
the same server, Windows Admin Center installs that solution into the existing
workspace to which that server is connected. Windows Admin Center additionally
installs any other necessary agents.
If you connect to a different server and have already setup a Log Analytics workspace,
you can also install the Microsoft Monitor Agent on the server, connecting it up to an
existing workspace. When you connect a server into a workspace, it automatically starts
collecting data and reporting to solutions installed in that workspace.
7 Note
Despite its name, VM insights works for physical servers as well as virtual machines.
You can try Azure Monitor using the free 5 GB of data/month/customer allowance. To
learn more about log ingestion plans and pricing, see Azure Monitor pricing . The
following sections show some of the benefits onboarding servers into Azure Monitor,
for example having a consolidated view of systems performance across your
environment.
7 Note
The visualizations for Virtual Machines Insights for Azure Monitor are offered in 6
public regions currently. For the latest information, check the Azure Monitor for
VMs documentation. You must deploy the Log Analytics workspace in one of the
supported regions to get the additional benefits provided by the Virtual Machines
Insights solution described previously.
Disabling monitoring
To completely disconnect your server from the Log Analytics workspace, uninstall the
Microsoft Monitor Agent. With the agent uninstalled it means that this server no longer
sends data to the workspace, and all the solutions installed in that workspace no longer
collect and process data from that server. However, uninstalling the Microsoft Monitor
Agent doesn't affect the workspace itself – all the resources reporting to that workspace
continues to do so. To uninstall the Microsoft Monitoring Agent within Windows Admin
Center, connect to the server and then go to Installed apps, find the Microsoft Monitor
Agent, and then select Remove.
If you want to turn off a specific solution within a workspace, you need to remove the
monitoring solution from the Azure portal. Removing a monitoring solution means that
the insights created by that solution are no longer generated for any of the servers
reporting to that workspace. For example, uninstalling the Azure Monitor for VMs
solution mean you can no longer see insights about VM or server performance from any
of the machines connected to my workspace.
Next steps
Learn more about Azure integration with Windows Admin Center
Feedback
Was this page helpful? Yes No
Windows Admin Center and Azure Network Adapter provide a one-click experience to
connect the server with your virtual network using a Point-to-Site VPN connection. The
process automates configuring the virtual network gateway and the on-premises VPN
client.
Requirements
Using Azure Network Adapter to connect to a virtual network requires the following:
7 Note
It’s not required to install Windows Admin Center on the server that you want to
connect to Azure. However, you can do that in a single server scenario.
Add an Azure Network Adapter to a server
To configure Azure Network Adapter, go to the Network extension for it in Windows
Admin Center.
1. Navigate to the server hosting the VMs that you want to add to Azure Network
Adapter.
2. Under Tools, select Networks.
3. Select Add Azure Network Adapter.
4. On the Add Azure Network Adapter pane, enter the following required
information, and then select Create:
Subscription
Location
Virtual Network
The client address pool is a range of private IP addresses that you specify.
The clients that connect over a Point-to-Site VPN dynamically receive an IP
address from this range. Use a private IP address range that does not overlap
with the on-premises location that you connect from, or the virtual network
that you want to connect to. We recommend using IP addresses that are in
the ranges designated for private networks (10.x.x.x, 192.168.x.x, or [Link]
to [Link]).
Authentication Certificate
7 Note
Network appliances, such as VPN Gateway and Application Gateway that run inside
a virtual network, come with additional cost. To learn more, see Virtual Network
pricing .
If there is no existing Azure Virtual Network gateway, Windows Admin Center creates
one for you. The setup process can take up to 25 minutes. After the Azure Network
Adapter is created, you can start to access VMs in the virtual network directly from your
server.
If you don’t need the connectivity anymore, under Networks, select the Azure Network
Adapter that you want to disconnect, from the top menu, select Disconnect, and then
on the Disconnect VPN Confirmation pop-up window, select Yes.
Next steps
For more information about Azure Virtual Network, see also:
Feedback
Was this page helpful? Yes No
With Windows Admin Center, you can easily set up and use Azure Update Management
to keep your managed servers up to date. If you don't already have a Log Analytics
workspace in your Azure subscription, Windows Admin Center will automatically
configure your server and create the necessary Azure resources in the subscription and
location you specify. If you have an existing Log Analytics workspace, Windows Admin
Center can automatically configure your server to consume updates from Azure Update
Management.
To get started, go to the Updates tool in a server connection and select “Set up now”,
and provide your preferences for the related Azure resources.
Once you've configured your server to be managed by Azure Update Management, you
can access Azure Update Management by using the hyperlink provided in the Updates
tool.
Learn how to stop using Azure Update Management to update your server.
Note that you must register your Windows Admin Center gateway with Azure before
setting up Azure Update Management.
Feedback
Was this page helpful? Yes No
Provide product feedback
Configuring Azure integration
Article • 11/13/2024 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
Windows Admin Center supports several optional features that integrate with Azure
services. Learn about the Azure integration options available with Windows Admin
Center.
To allow the Windows Admin Center gateway to communicate with Azure to leverage
Microsoft Entra 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 need to first register your Windows Admin Center gateway with
Azure. You only need to do this action once for your Windows Admin Center gateway -
the setting is preserved when you update your gateway to a newer version.
The guided in-product steps create a Microsoft Entra app in your directory, which allows
Windows Admin Center to communicate with Azure. To view the Microsoft Entra app
that is automatically created, go to the Azure tab of Windows Admin Center settings.
The View in Azure hyperlink lets you view the Microsoft Entra app in the Azure portal.
The Microsoft Entra app created is used for all points of Azure integration in Windows
Admin Center, including Microsoft Entra authentication to the gateway. Windows Admin
Center automatically configures the permissions needed to create and manage Azure
resources on your behalf:
Microsoft Graph
[Link]
[Link]
[Link]
[Link]
[Link]
[Link]
Azure Service Management
user_impersonation
Manual Microsoft Entra app configuration
If you wish to configure a Microsoft Entra app manually, rather than using the Microsoft
Entra app created automatically by Windows Admin Center during the gateway
registration process, follow these steps:
1. Grant the Microsoft Entra app the required API permissions listed above. You can
do so by navigating to your Microsoft Entra app in the Azure portal. Go to the
Azure portal > Microsoft Entra ID > App registrations > select your Microsoft
Entra app you wish to use. Then to the API permissions tab and add the API
permissions listed above.
2. Add the Windows Admin Center gateway URL to the reply URLs (also known as the
redirect URIs). Navigate to your Microsoft Entra app, then go to Manifest. Find the
"replyUrlsWithType" key in the manifest. Within the key, add an object containing
two keys: "url" and "type." The key "url" should have a value of the Windows
Admin Center gateway URL, appending a wildcard at the end. The key "type" key
should have a value of "Web." For example:
JSON
"replyUrlsWithType": [
{
"url": "[Link]
"type": "Single-Page Application"
}
],
7 Note
If you have Microsoft Defender Application Guard enabled for your browser, you
won't be able to register Windows Admin Center with Azure or sign into Azure.
There are two redirect URIs that must be added to the Single-Page Application (SPA)
platform. An example of these redirect URIs would be:
[Link]
[Link]
In this example, the numerical value refers to the port referenced in your Windows
Admin Center installation.
The Fully Qualified Domain Name (FQDN) or hostname of your gateway machine,
no mention of localhost
The HTTPS prefix, not HTTP
After adding the proper redirect URIs, it's good practice to clean up old, unused redirect
URIs.
If you'd like to continue using your existing app registration for your Windows Admin
Center application, use Microsoft Entra admin center to update the registration's
redirect URIs to the Single-Page Application (SPA) platform. Doing so enables the
authorization code flow with Proof Key for Code Exchange (PKCE) and cross-origin
resource sharing (CORS) support for applications that use that registration.
Follow these steps for application registrations that are currently configured with Web
platform redirect URIs:
4. Select the redirect URI for your application and then select Configure. These
redirect URIs should now appear in the Single-page application platform tile,
showing that CORS support with the authorization code flow and PKCE is enabled
Instead of updating existing URIs, you can instead create a new application registration
for your gateway. App registrations that are newly created for Windows Admin Center
through the gateway registration flow create Single-Page Application platform redirect
URIs.
If you can't migrate your application registration's redirect URIs to use auth code flow,
you can continue to use the existing application registration as is. To do so, you must
unregister your Windows Admin Center gateway and re-register with the same
application registration ID.
Stay updated
Follow us on Twitter
Feedback
Was this page helpful? Yes No
Windows Admin Center version 1910 allows you to deploy Azure virtual machines. This
integrates VM deployment into Windows Admin Center-managed workloads like
Storage Migration Service and Storage Replica. Instead of building new servers and VMs
in the Azure Portal by hand prior to deploying your workload - and possibly missing
required steps and configuration - Windows Admin Center can deploy the Azure VM,
configure its storage, join it to your domain, install roles, and then set up your
distributed system. You can also deploy new Azure VMs without a workload from the
Windows Admin Center Connections page.
Windows Admin Center also manages a variety of Azure services. Learn more about the
Azure integration options available with Windows Admin Center.
If you want to lift and shift virtual machines to Azure instead of creating new ones,
consider using Azure Migrate. For more info, see Azure Migrate overview.
Scenarios
Windows Admin Center version 1910 Azure VM deployment supports the following
scenarios:
Requirements
Creating a new Azure VM from within Windows Admin Center requires that you have:
An Azure subscription .
A Windows Admin Center gateway registered with Azure
An existing Azure resource group where you have Create permissions.
An existing Azure Virtual Network and subnet.
An Azure ExpressRoute circuit or Azure VPN solution tied to the virtual
network and subnet that allows connectivity from Azure VMs to your on-premises
clients, domain controllers, the Windows Admin Center computer, and any servers
requiring communication with this VM as part of a workload deployment. For
instance, to use the Storage Migration Service to migrate storage to an Azure VM,
the orchestrator computer and the source computer must both be able to contact
the destination Azure VM you are migrating to.
Usage
Azure VM deployment steps and wizards vary by scenario. Review the workload's
documentation for detailed information about the overall scenario.
This begins a step-by-step creation tool that selects a Windows Server 2012 R2,
Windows Server 2016, or Windows Server 2019 Azure VM as a destination for the
migration. Storage Migration Service provides recommended VM sizes to match
your source, but you can override them by clicking See all sizes.
Source server data is also used to automatically configure your managed disks and
their file systems as well as join your new Azure VM to your Active Directory
domain. If the VM is Windows Server 2019 (which we recommend), Windows
Admin Center installs the Storage Migration Service proxy feature. Once it has
created the Azure VM, Windows Admin Center returns to the normal Storage
Migration Service transfer workflow.
Here's a video showing how to use Storage Migration Service to migrate to Azure VMs.
[Link]
Here's a video showing how to use Storage Replica to replicate to Azure VMs.
[Link]
This begins a step-by-step creation tool that will let you select a Windows Server
2012 R2, Windows Server 2016, or Windows Server 2019 Azure VM, pick a size, add
managed disks, and optionally join your Active Directory domain.
Here's a video showing how to use Windows Admin Center to create Azure VMs.
[Link]
Feedback
Was this page helpful? Yes No
This article describes how to use Windows Admin Center running on your on-premises
PC or server to manage the operating system on one or more Azure virtual machines (in
addition to on-premises servers, PCs, and VMs).
To instead use Windows Admin Center directly in the Azure portal to manage the
operating system on a single Azure VM, see Use Windows Admin Center in Azure. You
can also use scripts to set up a Windows Admin Center server in an Azure VM.
You must enable WinRM access to your target VM by running the following in
PowerShell or the Command Prompt on the target VM: winrm quickconfig
If you haven't domain-joined the Azure VM, the VM behaves like a server in
workgroup, so you'll need to make sure you account for using Windows Admin
Center in a workgroup.
You must also enable inbound connections to port 5985 for WinRM over HTTP in
order for Windows Admin Center to manage the target VM:
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.
7 Note
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).
Tip
If you wish to use a Point-to-Site VPN to connect your Windows Admin Center
gateway to an Azure VNet to manage Azure VMs in that VNet, you can use the
Azure Network Adapter feature in Windows Admin Center. To do so, connect to
the server on which Windows Admin Center is installed, navigate to the Network
tool and select "Add Azure Network Adapter". When you provide the necessary
details and click "Set up", Windows Admin Center will configure a Point-to-Site VPN
to the Azure VNet you specify, after which, you can connect to and manage Azure
VMs from your on-premises Windows Admin Center gateway.
Ensure WinRM is running on your target VMs by running the following in PowerShell or
the Command Prompt on the target VM: winrm quickconfig
If you haven't domain-joined the Azure VM, the VM behaves like a server in workgroup,
so you'll need to make sure you account for using Windows Admin Center in a
workgroup.
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).
Feedback
Was this page helpful? Yes No
This article describes how to manually deploy Windows Admin Center in an Azure VM
for use in managing multiple Azure VMs. To manage a single VM, instead use the
Windows Admin Center functionality built into the Azure portal, as described in Use
Windows Admin Center in the Azure portal).
Prerequisites
Set up your account in Azure Cloud Shell . If this is your first time using Cloud
Shell, you will be asked you to associate or create an Azure storage account with
Cloud Shell.
In a PowerShell Cloud Shell, navigate to your home directory: PS Azure:\> cd ~
To upload the Deploy-WACAzVM.ps1 file, drag and drop it from your local machine to
anywhere on the Cloud Shell window.
Upload the certificate to Azure Key Vault. First, create a key vault in Azure portal,
then upload the certificate into the key vault. Alternatively, you can use Azure
portal to generate a certificate for you.
Script parameters
ResourceGroupName - [String] Specifies the name of the resource group where
the VM will be created.
MsiPath - [String] Specifies the local path of the Windows Admin Center MSI when
deploying Windows Admin Center on an existing VM. Defaults to the version from
[Link] if omitted.
VaultName - [String] Specifies the name of the key vault that contains the
certificate.
CertName - [String] Specifies the name of the certificate to be used for MSI
installation.
GenerateSslCert - [Switch] True if the MSI should generate a self signed ssl
certificate.
PortNumber - [int] Specifies the ssl port number for the Windows Admin Center
service. Defaults to 443 if omitted.
VirtualNetworkName - [String] Specifies the name of the virtual network for the
VM.
SubnetName - [String] Specifies the name of the subnet for the VM.
SecurityGroupName - [String] Specifies the name of the security group for the VM.
PublicIpAddressName - [String] Specifies the name of the public IP address for the
VM.
There are 2 different options for the MSI to deploy and the certificate used for MSI
installation. The MSI can either be downloaded from [Link]/WACDownload or, if
deploying to an existing VM, the filepath of an MSI locally on the VM can be given. The
certificate can be found in either Azure Key Vault or a self-signed certificate will be
generated by the MSI.
Script Examples
First, define common variables needed for the parameters of the script.
PowerShell
$ResourceGroupName = "wac-rg1"
$VirtualNetworkName = "wac-vnet"
$SecurityGroupName = "wac-nsg"
$SubnetName = "wac-subnet"
$VaultName = "wac-key-vault"
$CertName = "wac-cert"
$Location = "westus"
$PublicIpAddressName = "wac-public-ip"
$Size = "Standard_D4s_v3"
$Image = "Win2016Datacenter"
$Credential = Get-Credential
PowerShell
$scriptParams = @{
ResourceGroupName = $ResourceGroupName
Name = "wac-vm1"
Credential = $Credential
VirtualNetworkName = $VirtualNetworkName
SubnetName = $SubnetName
GenerateSslCert = $true
}
./Deploy-WACAzVM.ps1 @scriptParams
Example 2: Same as #1, but using a certificate from Azure Key Vault.
PowerShell
$scriptParams = @{
ResourceGroupName = $ResourceGroupName
Name = "wac-vm2"
Credential = $Credential
VirtualNetworkName = $VirtualNetworkName
SubnetName = $SubnetName
VaultName = $VaultName
CertName = $CertName
}
./Deploy-WACAzVM.ps1 @scriptParams
PowerShell
$MsiPath = "C:\Users\<username>\Downloads\WindowsAdminCenter<version>.msi"
$scriptParams = @{
ResourceGroupName = $ResourceGroupName
Name = "wac-vm3"
Credential = $Credential
MsiPath = $MsiPath
InstallWACOnly = $true
GenerateSslCert = $true
}
./Deploy-WACAzVM.ps1 @scriptParams
PowerShell
PowerShell
Enable-AzVMPSRemoting -ResourceGroupName $ResourceGroupName -Name $Name
Invoke-AzVMCommand -ResourceGroupName $ResourceGroupName -Name $Name -
ScriptBlock {Set-NetFirewallRule -Name WINRM-HTTP-In-TCP-PUBLIC -
RemoteAddress Any} -Credential $Credential
Invoke-AzVMCommand -ResourceGroupName $ResourceGroupName -Name $Name -
ScriptBlock {winrm create winrm/config/Listener?Address=*+Transport=HTTP} -
Credential $Credential
7 Note
These instructions are for installing on Windows Server with Desktop Experience,
not on a Server Core installation.
2. Establish a remote desktop connection to the VM, then copy the MSI from your
local machine and paste into the VM.
3. 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.
4. Start the Windows Admin Center service (run C:/Program Files/Windows Admin
Center/[Link])
Learn more about deploying Windows Admin Center.
2. Select Add inbound port rule and select HTTPS under Service.
7 Note
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.
7 Note
If you selected a port other than 443, you can access Windows Admin Center by
navigating to [Link] name of your VM>:<custom port>
When you attempt to access Windows Admin Center, the browser will prompt for
credentials to access the virtual machine on which Windows Admin Center is installed.
Here you will need to enter credentials that are in the Local users or Local administrators
group of the virtual machine.
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: winrm
quickconfig
If you haven't domain-joined the Azure VM, the VM behaves like a server in workgroup,
so you'll need to make sure you account for using Windows Admin Center in a
workgroup.
Feedback
Was this page helpful? Yes No
You can now use Windows Admin Center in the Azure portal to manage the Windows
operating system inside an Azure VM. Manage operating system functions from the Azure
portal and work with files in the VM without using Remote Desktop or PowerShell.
This article provides an overview of the functionality provided, requirements, and how to install
Windows Admin Center and use it to manage a single VM. It also answers frequently asked
questions, and provides a list of known issues and tips for troubleshooting in case something
doesn't work.
Overview of functionality
Windows Admin Center in the Azure portal provides the essential set of management tools for
managing Windows Server and Client Azure VMs:
Certificates
Devices
Events
Files and file sharing
Firewall
Installed apps
Local users and groups
Performance Monitor
PowerShell
Processes
Registry
Remote Desktop
Roles and features
Scheduled tasks
Services
Storage
Updates
We don't support extensions to Windows Admin Center in the Azure portal at this time.
If you manually installed Windows Admin Center in the VM to manage multiple systems,
installing this VM extension reduces the functionality to managing just the VM in which the
extension is installed. Uninstall the extension to get back full functionality.
Requirements
This section provides the requirements for using Windows Admin Center in the Azure portal to
manage your Azure IaaS VM:
Azure permissions
To install the Windows Admin Center extension on your IaaS VM, your account must be
granted the Owner or Contributor role in Azure.
Connecting to Windows Admin Center requires you to have Reader and Windows Admin
Center Administrator Login permissions at the virtual machine resource level.
Networking requirements
The VM also has the following networking requirements, which we step through during the
installation procedure:
Outbound internet access or an outbound port rule allowing HTTPS traffic to the
WindowsAdminCenter and AzureActiveDirectory service tag
Just like with Remote Desktop, we recommend connecting to the VM using a private IP address
in the VM's virtual network to increase security. Using a private IP address doesn't require an
inbound port rule, though it does require access to the virtual network (which we discuss next).
7 Note
Inbound connectivity is redirected by another service (i.e. Azure Firewall) isn't supported.
You must have inbound connectivity from the Azure portal to one of the direct IP
addresses of your VM, as seen on the Networking tab of your Azure VM in the Azure
portal, on the port Windows Admin Center is installed.
Management PC requirements
The management PC or other system that you use to connect to the Azure portal has the
following requirements:
Install in a VM
Before you can use Windows Admin Center in the Azure portal, you must install it in the VM
you want to manage. Here's how:
2. If the VM has all outbound internet traffic blocked, create an outbound port rule to
connect to the Windows Admin Center service.
To do so, navigate to Windows Admin Center (found in the Settings group) and select the
checkbox titled "Open an outbound port for Windows Admin Center to install" on the
Install screen of Windows Admin Center. Alternatively, you can run the following
PowerShell commands:
PowerShell
3. In the virtual machine settings, navigate to Windows Admin Center (found in the
Settings group).
4. To optionally provide access to your VM over the public internet from any IP address
(convenient for testing but exposes the VM to attack from any host on the internet), you
can select Open this port for me.
1. Select Install.
Installing takes a few minutes. If you selected Open this port for me or manually created
an inbound port rule in the last couple minutes, it might take another couple minutes
before you can connect with Windows Admin Center.
Use with a VM
After you install Windows Admin Center in an Azure VM, here's how to connect to it and use it
to manage Windows:
1. Open the Azure portal and navigate to your VM, then Windows Admin Center.
2. Select the IP address you want to use when connecting to the VM, and then select
Connect.
Windows Admin Center opens in the portal, giving you access to the same tools you might be
familiar with from using Windows Admin Center in an on-premises deployment.
If you see a "Failed to connect" message, ensure your account is a member of the Windows
Admin Center Administrator Login role on the VM resource.
However, if you need to use a public IP address, you can improve security by limiting the IP
addresses that can reach your VM to only the IP addresses used by the systems you use to
connect to the Azure portal. Here's how:
1. Open the Azure portal and navigate to your VM > Networking > Inbound port rules.
2. If Windows Admin Center is installed and configured, it to open an inbound port for your
public IP address, select PortForWAC. Otherwise, select Add inbound port rule.
3. Provide the following values, specifying the public IP addresses of your management
systems (separated with commas), and optionally changing the destination port from port
6516. Then select Add.
ノ Expand table
Field Value
Source IP address
Destination Any
Protocol Any
Action Allow
You might need to use a non-Microsoft website or app to find the public IP address of the
system you're using to connect to the Azure portal.
7 Note
The Windows Admin Center Administrator Login role uses dataActions and thus can't be
assigned at management group scope. Currently these roles can only be assigned at the
subscription, resource group or resource scope.
To configure role assignments for your VMs using the Microsoft Entra admin center experience:
1. Select the Resource Group containing the VM and its associated Virtual Network,
Network Interface, Public IP Address, or Load Balancer resource.
3. Select Add > Add role assignment to open the Add role assignment page.
4. Assign the following role. For detailed steps, see Assign Azure roles using the Azure
portal.
ノ Expand table
Setting Value
For more information on how to use Azure RBAC to manage access to your Azure subscription
resources, see the following articles:
Proxy configuration
If the machine connects through a proxy server to communicate over the internet, review the
following requirements to understand the network configuration required.
The Windows Admin Center extension can communicate through a proxy server by using the
HTTPS protocol. Use the extensions settings for configuration as described in the following
steps. Authenticated proxies aren't supported.
1. Use this flowchart to determine the values of the Settings parameters
2. After you determine the Settings parameter values, provide these other parameters
when you deploy the AdminCenter Agent. Use PowerShell commands, as shown in the
following example:
PowerShell
$wacPort = "6516"
$settings = @{"port" = $wacPort; "proxy" = @{"mode" = "application"; "address" =
"[Link]
Set-AzVMExtension -ExtensionName AdminCenter -ExtensionType AdminCenter -Publisher
[Link] -ResourceGroupName <resource-group-name> -VMName <virtual-
machine-name> -Location <location> -TypeHandlerVersion "0.0" -settings $settings
PowerShell
Set-AzContext <subscription_id>
Set-AzVMExtension -ExtensionName "AdminCenter" -Publisher "[Link]"
-ExtensionType "AdminCenter" -ResourceGroupName <RG_name> -VMName <VM_name>
Implementation details
Windows Admin Center is currently implemented in the Azure portal in the form of an
extension that we install on each Azure VM with which you want to use Windows Admin
Center.
This extension connects to an external service that manages certificates and DNS records so
that you can easily connect to your VM.
Each Azure VM that uses the Windows Admin Center extension gets a public DNS record that
Microsoft maintains in Azure DNS. We hash the record name to anonymize the VM's IP address
when saving it in DNS - the IP addresses aren't saved in plain text in DNS. This DNS record is
used to issue a certificate for Windows Admin Center on the VM, enabling encrypted
communication with the VM.
Troubleshooting
Here are some tips to try in case something isn't working. For general help troubleshooting
Windows Admin Center (not specifically in Azure), see Troubleshooting Windows Admin
Center.
If this page doesn't load successfully, there's something wrong with your connection to
Windows Admin Center itself. Make sure that you're connected to the correct Vnet and
are using the correct IP address before trying further troubleshooting.
2. If you're using a Public IP address, make sure that the port you selected upon installation
is open to the internet. By default, the port is set to 6516. In your virtual machine,
navigate to Networking > Add inbound port rule.
4. Make sure that outbound traffic to Windows Admin Center is allowed on your virtual
machine
b. Create a new port rule for the Windows Admin Center and Azure Active Directory
service tags.
c. You can test this by running the following command using PowerShell inside of your
virtual machine:
PowerShell
Expected
Microsoft Certificate and DNS service for Windows Admin Center in the Azure
Portal
d. If you allowed all outbound traffic and are still seeing an error from the Invoke-
RestMethod command, check that there are no firewall rules blocking connection. If
nothing seems wrong, create a support request as our service might be experiencing
problems.
5. Make sure that the Windows Admin Center service is running on your VM.
a. In the Azure portal, navigate to Connect > RDP > Download RDP File.
b. Open the RDP file and sign in with your administrator credentials.
c. Open Task Manager (Ctrl+Shift+Esc) and navigate to Services.
d. Make sure WindowsAdminCenter is Running. If not, start the service.
1. On Edge:
a. Navigate to the ellipses on the top right corner, and navigate to Settings
b. Navigate to Cookies and site permissions
c. Navigate to Manage and delete cookies and site data
d. Ensure that the checkbox for Block third-party cookies is turned off
2. On Chrome
a. Navigate to the ellipses on the top right corner, and navigate to Settings
b. Navigate to Privacy and Security
c. Navigate to Cookies and other site data
d. Select the radio button for either Block third-party cookies in Incognito or Allow all
cookies
If no other tool is loading, there might be a problem with your network connectivity. Try
closing the blade and then connecting again. If this doesn’t work, open a support ticket.
2. Make sure that outbound traffic to Windows Admin Center is allowed on your virtual
machine.
c. Test connectivity by running the following command using PowerShell inside of your
virtual machine:
PowerShell
Expected
Microsoft Certificate and DNS service for Windows Admin Center in the Azure
Portal
3. If you have allowed all outbound traffic, and are getting an error from the Invoke-
RestMethod command, check that there are no firewall rules blocking the connection.
If nothing seems wrong and Windows Admin Center still won't install, open a support request
with the following information:
Logs in the Azure portal. This can be found under Settings > Extensions > AdminCenter >
View Detailed Status
Logs in the VM. Share the logs from the following locations:
C:\WindowsAzure\Logs\Plugins\AdminCenter
C:\Packages\Plugins\AdminCenter
Network trace, if appropriate. Network traces can contain customer data and sensitive
security details, such as passwords, so we recommend reviewing the trace and removing
any sensitive details before sharing it.
JSON
const deploymentTemplate = {
"$schema": "[Link]
01/[Link]#",
"contentVersion": "[Link]",
"parameters": {
"vmName": {
"type": "string"
},
"location": {
"type": "string"
},
"extensionName": {
"type": "string"
},
"extensionPublisher": {
"type": "string"
},
"extensionType": {
"type": "string"
},
"extensionVersion": {
"type": "string"
},
"port": {
"type": "string"
},
"salt": {
"type": "string"
}
},
"resources": [
{
"type": "[Link]/virtualMachines/extensions",
"name": "[concat( parameters('vmName'), '/' ,
parameters('extensionName') )]",
"apiVersion": "2018-10-01",
"location": "[parameters('location')]",
"properties": {
"publisher": "[parameters('extensionPublisher')]",
"type": "[parameters('extensionType')]",
"typeHandlerVersion": "[parameters('extensionVersion')]",
"autoUpgradeMinorVersion": true,
"settings": {
"port": "[parameters('port')]",
"salt": "[parameters('salt')]",
}
}
}
];
const parameters = {
vmName: <VM name>,
location: <VM location>,
extensionName: "AdminCenter",
extensionPublisher: "[Link]",
extensionType: "AdminCenter",
extensionVersion: "0.0",
port: "6516",
salt: ""
}
PowerShell
$wacPort = "6516"
$Settings = @{"port" = $wacPort; "salt" = $salt}
# Install VM extension
Set-AzVMExtension -ResourceGroupName $resourceGroupName -Location $vmLocation -
VMName $vmName -Name "AdminCenter" -Publisher "[Link]" -Type
"AdminCenter" -TypeHandlerVersion "0.0" -settings $Settings
Known issues
If you change any of your networking rules, it takes Windows Admin Center about a
minute or so to update its networking. The connection may fail for a few minutes.
If you just started your virtual machine, it takes about a minute for the IP address to be
registered with Windows Admin Center and thus, it may not load.
The first load time of Windows Admin Center might be a little longer. Any subsequent
load is just a few seconds.
Chrome Incognito mode isn't supported.
Azure portal desktop app isn't supported.
For an inbound port, why must I open a port and why should
the source be set to “Any”?
Windows Admin Center installs on your Azure Virtual Machine. The installation consists of a
web server and a gateway. By publishing the web server to DNS and opening the firewall (the
inbound port in your VM), you can access Windows Admin Center from the Azure portal. The
rules for this port perform similar to the “RDP” port. If you don’t wish to open this port up to
“Any”, we recommend specifying the rule to the IP address of the machine used to open the
Azure portal.
PowerShell: Set-AzVMExtension
Azure CLI: az vm extension set
) Important
Version 1.36 and 1.35 of the Azure Connected Machine Agent (Arc agent) breaks
connection to Windows Admin Center. This has been fixed in later versions of the
Arc agent (1.37+) The current version can be downloaded here .
Using Windows Admin Center in the Azure portal allows you to manage the Windows
Server operating system of your Arc-enabled servers, known as hybrid machines. You
can securely manage hybrid machines from anywhere–without needing a VPN, public IP
address, or other inbound connectivity to your machine. To learn more about Arc-
enables servers, see What is Azure Arc-enabled servers?.
With Windows Admin Center extension in Azure, you get the management,
configuration, troubleshooting, and maintenance functionality for managing your Arc-
enabled servers in the Azure portal. Windows Server infrastructure and workload
management no longer requires you to establish line-of-sight or Remote Desktop
Protocol (RDP)–it can all be done natively from the Azure portal. Windows Admin Center
provides tools that you'd normally find in Server Manager, Device Manager, Task
Manager, Hyper-V Manager, and most other Microsoft Management Console (MMC)
tools.
This article provides an overview of using Windows Admin Center in the Azure portal,
requirements, and how to install Windows Admin Center in the Azure portal and use it
to manage your hybrid machine. It also answers frequently asked questions, and
provides a list of known issues and tips for troubleshooting in case something doesn't
work.
Using Windows Admin Center in the Azure portal, you can manage:
Certificates
Devices
Events
Files and file sharing
Firewall
Installed apps
Local users and groups
Performance Monitor
PowerShell
Processes
Registry
Remote Desktop
Roles and Features
Scheduled tasks
Services
Storage
Updates
Virtual machines
Virtual switches
We don't support other extensions for Windows Admin Center in the Azure portal at this
time.
2 Warning
Requirements
This section provides the requirements for using Windows Admin Center in the Azure
portal to manage a hybrid machine:
During the deployment of Windows Admin Center, we'll attempt to register the
[Link] resource provider for your subscription.
) Important
You must have permission to register a resource provider, which requires the
*/register/action operation. This is included if you are assigned the contributor
or owner role on your subscription.
7 Note
Azure permissions
To install the Windows Admin Center extension for an Arc-enabled server resource, your
account must be granted the Owner, Contributor, or Windows Admin Center
Administrator Login role in Azure.
Connecting to Windows Admin center requires you to have Reader and Windows
Admin Center Administrator Login permissions at the Arc-enabled server resource.
Learn more about assigning Azure roles using the Azure portal
Australia East
Brazil South
Canada Central
Canada East
Central India
Central US
East Asia
East US
East US 2
France Central
Japan East
Korea Central
North Central US
North Europe
South Africa North
South Central US
Southeast Asia
Sweden Central
Switzerland North
UAE North
UK South
UK West
West Central US
West Europe
West US
West US 2
West US 3
7 Note
) Important
As of November 1st, 2024, Windows Admin Center for Azure Arc requires your
hybrid machine to have a Pay-as-you-go or Software Assurance license type to use.
All new installations of the Windows Admin Center agent must adhere to this
requirement. Machines with Windows Admin Center for Azure Arc installed prior to
November 1st, 2024, may continue to use Windows Admin Center for Azure Arc for
up to 12 months without updates until November 1st, 2025.
Networking requirements
The hybrid machine must meet the following networking requirements:
Outbound internet access or an outbound port rule allowing HTTPS traffic to the
following endpoints:
*[Link] or the WindowsAdminCenter service tag
[Link]
*.[Link]
7 Note
The management machine where the Azure portal is running must meet the following
networking requirements:
Make sure you review the supported devices and recommended browsers before
accessing the Azure portal from the management machine or system.
1. Open the Azure portal and navigate to your Arc-enabled server, and then under
the Settings group, select Windows Admin Center (preview).
2. Select Connect.
7 Note
Starting August 2022, Windows Admin Center now allows you to use Microsoft
Entra ID-based authentication for your hybrid machine. You will no longer be
prompted for the credentials of a local administrator account.
Windows Admin Center opens in the portal, giving you access to the same tools you
might be familiar with from using Windows Admin Center in an on-premises
deployment.
7 Note
The Windows Admin Center Administrator Login role uses dataActions and thus
cannot be assigned at management group scope. Currently these roles can only be
assigned at the subscription, resource group or resource scope.
To configure role assignments for your hybrid machines using the Microsoft Entra admin
center experience:
1. Open the hybrid machine that you wish to manage using Windows Admin Center.
3. Select Add > Add role assignment to open the Add role assignment page.
4. Assign the following role. For detailed steps, see Assign Azure roles using the
Azure portal.
ノ Expand table
Setting Value
For more information on how to use Azure RBAC to manage access to your Azure
subscription resources, see the following articles:
Proxy configuration
If the machine connects through a proxy server to communicate over the internet,
review the following requirements to understand the network configuration required.
The Windows Admin Center extension can communicate through a proxy server by
using the HTTPS protocol. Use the extensions settings for configuration as described in
the following steps. Authenticated proxies aren't supported.
7 Note
Proxy configuration is only supported for extension versions greater than [Link].
1. Use this flowchart to determine the values of the Settings parameters
2. After you determine the Settings parameter values, provide these other
parameters when you deploy the AdminCenter Agent. Use PowerShell commands,
as shown in the following example:
PowerShell
$wacPort = "6516"
$settings = @{"port" = $wacPort; "proxy" = @{"mode" = "application";
"address" = "[Link]
New-AzConnectedMachineExtension -Name AdminCenter -ExtensionType AdminCenter
-Publisher [Link] -ResourceGroupName <resource-group-name> -
MachineName <arc-server-name> -Location <arc-server-location> -Setting
$settings -SubscriptionId <subscription-id>
How it works
By using Windows Admin Center in Azure, you can connect to your hybrid machine
without requiring any inbound port to be enabled on the firewall. Windows Admin
Center, via the Arc agent, is able to securely establish a reverse proxy session connection
with the Azure Arc service in an outbound manner.
For each hybrid machine that you want to manage with Windows Admin Center in the
Azure portal, you must deploy an agent to each machine.
The agent communicates to an external service that manages certificates so that you
can easily connect to your hybrid machine.
7 Note
Uninstalling Windows Admin Center does not delete the logical Azure endpoint
resource. This is kept for other experiences that might leverage this resource, such
as SSH.
1. The Azure portal asks the [Link] resource provider for access
to the Arc-enabled server.
2. The resource provider communicates with a Layer 4 SNI proxy to establish a short-
lived session-specific access to your Arc-enabled server on the Windows Admin
Center port.
3. A unique short-lived URL is generated and connection to Windows Admin Center
is established from the Azure portal.
PowerShell
$location = "<location_of_hybrid_machine>"
$machineName = "<name_of_hybrid_machine>"
$resourceGroup = "<resource_group>"
$subscription = "<subscription_id>"
$port = "6516"
$portint = 6516
#Allow connectivity
$putPayload = "{'properties': {'type': 'default'}}"
Invoke-AzRestMethod -Method PUT -Uri
"[Link]
{resourceGroup}/providers/[Link]/machines/${machineName}/pr
oviders/[Link]/endpoints/default?api-version=2023-03-
15" -Payload $putPayload
Troubleshooting
Here are some tips to try in case something isn't working. For general Windows Admin
Center troubleshooting (not specifically in Azure), see Troubleshooting Windows Admin
Center.
PowerShell
3. Make sure that the Windows Admin Center service is running on your machine.
a. RDP into your server.
b. Open Task Manager (Ctrl+Shift+Esc) and navigate to Services.
c. Make sure ServerManagementGateway / Windows Admin Center is running.
d. If it isn't running, start the service.
PowerShell
Output
Local configuration setting
[Link] (preview): 443
PowerShell
If you're using another experience (like SSH) using this solution, you can specify
multiple ports separated by a comma.
ServiceTag
[Link]
*.[Link]
2. Make sure that outbound traffic to Windows Admin Center is allowed on your
hybrid machine
PowerShell
Invoke-RestMethod -Method GET -Uri
[Link]
Output
3. If you've allowed all outbound traffic and are getting an error from the command
above, check that there are no firewall rules blocking the connection.
If nothing seems wrong and Windows Admin Center still won't install, open a support
request with the following information:
Logs from the Azure portal. Windows Admin Center logs can be found under
Settings > Extensions > AdminCenter > View Detailed Status.
Logs in the hybrid machine. Run the following PowerShell command and share the
resulting .zip file.
PowerShell
azcmagent logs
Network trace, if appropriate. Network traces can contain customer data and
sensitive security details, such as passwords, so we recommend reviewing the trace
and removing any sensitive details before sharing it.
Known issues
Chrome incognito mode isn't supported.
Azure portal desktop app isn't supported.
Detailed error messages for failed connections aren't yet available.
As of November 1st, 2024, some existing customers are unable to use Windows
Admin Center for Azure Arc.
As of November 1st, 2024, some customers are unable to install or use Windows
Admin Center for Azure Arc, even with proper license attestation.
Furthermore, accessing Windows Admin Center from Azure requires no inbound port
and only outbound connectivity via a reverse proxy solution. These outbound rules are
required in order to establish the connection.
How do I find the port used for Windows Admin Center
installation?
To verify the value of SmePort registry setting:
Azure CLI
You can also install the extension using PowerShell. Learn more about how to automate
Windows Admin Center deployment using PowerShell.
2 Warning
Enabling this capability will replace your existing instance of Windows Admin
Center and removes the capability to manage other machines. Your previously
deployed instance of Windows Admin Center will no longer be usable. Please don’t
do this if you use your instance of Admin Center to manage multiple servers.
Next steps
Learn about Windows Admin Center
Learn about managing servers with Windows Admin Center
Learn about Azure Arc
Feedback
Was this page helpful? Yes No
) Important
Windows Admin Center in the Azure portal is currently in preview. See the Supplemental
Terms of Use for Microsoft Azure Previews for legal terms that apply to Azure features
that are in beta, preview, or otherwise not yet released into general availability.
) Important
Version 1.36 and 1.35 of the Azure Connected Machine Agent (Arc agent) breaks
connection to Windows Admin Center. This has been fixed in later versions of the Arc
agent (1.37+) This can be downloaded here .
) Important
There are currently several known issues impacting connections to Azure Local machines
and installation of the Windows Admin Center in the Azure Portal extension on Azure
Local machines. These issues are impacting Windows Admin Center in the Azure Portal
extension versions [Link] and above.
Using Windows Admin Center in the Azure portal you can manage the Azure Local operating
system of your cluster. You can securely manage your cluster from anywhere–without needing
a VPN, public IP address, or other inbound connectivity to your machine.
With Windows Admin Center extension in Azure, you get the management, configuration,
troubleshooting, and maintenance functionality for managing your Azure Local cluster in the
Azure portal. Azure Local cluster and workload management no longer require you to establish
line-of-sight or Remote Desktop Protocol (RDP)–it can all be done natively from the Azure
portal. Windows Admin Center provides tools that you'd normally find in Failover cluster
manager, Device Manager, Task Manager, Hyper-V Manager, and most other Microsoft
Management Console (MMC) tools.
This article provides an overview of using Windows Admin Center in the Azure portal,
requirements, and how to install Windows Admin Center and use it to manage your cluster. It
also answers frequently asked questions, and provides a list of known issues and tips for
troubleshooting in case something doesn't work.
Using Windows Admin Center in the Azure portal, you can manage:
Servers
Volumes
Drives
SDN infrastructure
Diagnostics
Security
Certificates
Devices
Events
Files and file sharing
Firewall
Installed apps
Local users and groups
Performance Monitor
PowerShell
Processes
Registry
Remote Desktop
Roles and Features
Scheduled tasks
Services
Storage
Virtual machines
Virtual switches
We don't support other extensions for Windows Admin Center in the Azure portal at this time.
2 Warning
If you manually installed Windows Admin Center on your cluster to manage multiple
systems, enabling Windows Admin Center in Azure will replace your existing instance of
Windows Admin Center and removes the capability to manage other machines. You will
lose access to your previously deployed instance of Windows Admin Center.
Requirements
This section provides the requirements for using Windows Admin Center in the Azure portal to
manage a hybrid machine:
) Important
You must have permission to register a resource provider, which requires the
*/register/action operation. This is included if you are assigned the contributor or
Azure permissions
Connecting to Windows Admin center requires you to have Reader and Windows Admin
Center Administrator Login permissions at the Arc-enable Azure Local resource.
Learn more about assigning Azure roles using the Azure portal.
7 Note
Windows Admin Center isn't supported in Azure China 21Vianet, Azure Government, or
other non-public clouds
Networking requirements
Every node of the Azure Local cluster must meet the following networking requirements:
Outbound internet access or an outbound port rule allowing HTTPS traffic to the
following endpoints:
*.[Link] or the WindowsAdminCenter service tag
[Link]
*.[Link]
7 Note
The management machine where the Azure Portal is running must meet the following
networking requirements:
Make sure you review the supported devices and recommended browsers before accessing the
Azure portal from the management machine or system.
1. Open the Azure portal and navigate to your Azure Local cluster.
2. Under the Settings group, select Windows Admin Center.
3. Specify the port on which you wish to install Windows Admin Center, and then select
Install.
1. Open the Azure portal and navigate to your Azure Local cluster, and then under the
Settings group, select Windows Admin Center.
2. Select Connect.
7 Note
Starting April 2023, Windows Admin Center now allows you to use Microsoft Entra ID-
based authentication for your 22H2 or higher clusters running the AdminCenter extension
greater than [Link]. You will no longer be prompted for the credentials of a local
administrator account. However, there may still be some experiences within Windows
Admin Center that might require local administrator credentials. For example, when
CredSSP is required. Clusters running 21H2 or below will continue to require local
administrator credentials.
Windows Admin Center opens in the portal, giving you access to the same tools you might be
familiar with from using Windows Admin Center in an on-premises deployment.
7 Note
The Windows Admin Center Administrator Login role uses dataActions and thus cannot be
assigned at management group scope. Currently these roles can only be assigned at the
subscription, resource group or resource scope.
To configure role assignments for your cluster using the Microsoft Entra admin center
experience:
1. Select the Resource Group containing the cluster and the associated Azure Arc resources.
3. Select Add > Add role assignment to open the Add role assignment page.
4. Assign the following role. For detailed steps, see Assign Azure roles using the Azure
portal.
ノ Expand table
Setting Value
For more information on how to use Azure RBAC to manage access to your Azure subscription
resources, see the following articles:
How it works
By using Windows Admin Center in Azure, you can connect to your cluster without requiring
any inbound port to be enabled on the firewall. Windows Admin Center, via the Arc agent, is
able to securely establish a reverse proxy session connection with the Azure Arc service in an
outbound manner.
For each Azure Local cluster that you want to manage with Windows Admin Center in the
Azure portal, you must deploy an agent to all the nodes in the cluster.
The agent communicates to an external service that manages certificates so that you can easily
connect to your cluster.
7 Note
Uninstalling Windows Admin Center does not delete the logical Azure endpoint resource.
This is kept for other experiences that might leverage this resource, such as SSH.
Clicking Connect performs the following actions:
1. The Azure portal asks the [Link] resource provider for access to
the Arc-enabled server.
2. The resource provider communicates with a Layer 4 SNI proxy to establish a short-lived
session-specific access to one of your Arc-enabled nodes of the cluster on the Windows
Admin Center port.
3. A unique short-lived URL is generated and connection to Windows Admin Center is
established from the Azure portal.
PowerShell
$clusterName = "<name_of_cluster>"
$resourceGroup = "<resource_group>"
$subscription = "<subscription_id>"
$port = "6516"
#Allow connectivity
$patch = @{ "properties" = @{ "connectivityProperties" = @{"enabled" = $true}}}
$patchPayload = ConvertTo-Json $patch
Invoke-AzRestMethod -Method PATCH -Uri
"[Link]
Group/providers/[Link]/clusters/$clusterName/ArcSettings/default?
api-version=2023-02-01" -Payload $patchPayload
Troubleshooting
Here are some tips to try in case something isn't working. For general Windows Admin Center
troubleshooting (not specifically in Azure), see Troubleshooting Windows Admin Center.
PowerShell
2. Make sure that the Windows Admin Center service is running on your cluster.
a. RDP into each node of your cluster.
b. Open Task Manager (Ctrl+Shift+Esc) and navigate to Services.
c. Make sure ServerManagementGateway / Windows Admin Center is running.
d. If it isn't, start the service.
PowerShell
Output
Local configuration setting
[Link] (preview): 443
PowerShell
If you're using another experience (like SSH) using this solution, you can specify
multiple ports separated by a comma.
[Link]
*.[Link]
2. If no other tool is loading, there might be a problem with your network connectivity. Try
closing the blade and then connecting again. If this doesn’t work, open a support ticket.
2. Make sure that outbound traffic to Windows Admin Center is allowed on each node of
your cluster.
a. Test connectivity by running the following command using PowerShell inside of your
virtual machine:
PowerShell
Expected
Microsoft Certificate and DNS service for Windows Admin Center in the Azure
Portal
3. If you've allowed all outbound traffic and are getting an error from the command above,
check that there are no firewall rules blocking the connection.
If nothing seems wrong and Windows Admin Center still won't install, open a support request
with the following information:
Logs in the Azure portal. This can be found under Settings > Extensions > AdminCenter
> View Detailed Status.
Logs on each node of the cluster. Run the following PowerShell command and share the
resulting .zip file.
PowerShell
azcmagent logs
Network trace, if appropriate. Network traces can contain customer data and sensitive
security details, such as passwords, so we recommend reviewing the trace and removing
any sensitive details before sharing it.
Known issues
On extension versions [Link] and above, installation of Windows Admin Center in the
Azure Portal or connections to Azure Local OS systems may fail. Installation issues may be
mitigated by reverting to version [Link] of the extension. Connection issues may be
fixed by a page refresh.
Chrome incognito mode isn't supported.
Azure portal desktop app isn't supported.
Detailed error messages for failed connections aren't available yet.
Updates isn’t supported. Users cannot apply updates to Azure Local cluster with CAU
(Cluster-Aware Updating).
Furthermore, accessing Windows Admin Center from Azure requires no inbound port and only
outbound connectivity via a reverse proxy solution. These outbound rules are required in order
to establish the connection.
2 Warning
Enabling this capability will replace your existing instance of Windows Admin Center and
removes the capability to manage other machines. Your previously deployed instance of
Windows Admin Center will no longer be usable.
Next steps
Learn about Windows Admin Center
Learn about managing servers with Windows Admin Center
Learn about Azure Local
Learn about connecting Azure Local to Azure
What's new with Windows Admin
Center Azure extension
Article • 12/19/2024 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
The Windows Admin Center Azure extension (seen as "AdminCenter" in Azure) receives
improvements on an ongoing basis. To stay up to date with the most recent
developments, this article provides you with information about:
7 Note
This article is only for Windows Admin Center in Azure. For release notes on
Windows Admin Center on-premises, navigate to release history.
New features
Support for Windows 10/11 machines.
Fixed
Fixed an issue where connection to Azure Local clusters fails.
New features
Updated the build of Windows Admin Center to our new modernized gateway .
Significant agent upgrade from .NET 4.6.2 to .NET Core.
Switch to a multi-process, micro-service based architecture, allowing Admin Center
to be more flexible, scalable, and resilient.
Shift from Kantana to Kestrel HTTP web server.
Fixed
Fixed an issue where updating between versions fails because certificates don't get
imported
Fixed an issue where installation would fail on WDAC-enforced devices.
Fixed an issue where connection would fail due to a new Chromium policy
impacting 1% of Edge/Chrome users.
Fixed
Fixed an issue where the Remote Desktop tool was not working or resizing it would
make it unusable.
Fixed an issue where the text in some languages was garbled.
New features
Updated the build of Windows Admin Center to v2311. For a full summary of new
features, visit our blog post .
Added support for installation when TLS 1.3 is enabled.
Fixed
Fixed an issue where momentarily losing access to IMDS/HIMDS does not result in
Windows Admin Center installation failure.
Fixed
Removed the "Unrestricted" execution policy when Windows Admin Center scripts
are executed.
Added more logging when proxies are used for better debugging.
Version [Link] - September 2023
Fixed
Fixed an issue where Windows Admin Center's certificate validation would not
cause Windows Admin Center to fail if a valid certificate is already available. This
issue would show up during server reboots when the "Enable" operation is run.
Fixed
Fixed an issue where an additional URL was required when using proxies.
Updated the build of Windows Admin Center to the latest preview version.
New features
Introduced support for proxies. You can now configure a proxy to monitor/filter all
outbound traffic from the AdminCenter extension.
Updated the build of Windows Admin Center to v2306. For a full summary of new
features, visit our blog post .
Introduced new management capabilities for Azure Local - Remote Support and
Diagnostics.
New features
Introduced Microsoft Entra authentication for Azure Local. Note that this
functionality is in preview. Please create a support ticket for all issues.
Introduced a Network tool.
Introduced Virtual Machine Live Storage Migration.
Introduced new security experiences for Azure Local clusters with the supplemental
package.
Fixed
If a prior installation of Windows Admin Center exists on your machine, the
extension will first uninstall it before installing Windows Admin Center in Azure.
Fixed the infinite loading of the Remote Desktop tool.
New features
Updated the build of Windows Admin Center to v2211. A few highlights are listed.
For a full summary, visit our blog post .
Support for WDAC-enforced infrastructure.
Support for 400% zoom.
Search settings with smart keywords.
Azure Local management improvements.
Fixed
Fixed Microsoft Entra authentication when managing domain controllers. Microsoft
Entra authentication isn't supported on domain controllers and users must enter
local administrator credentials.
New features
Introduced Microsoft Entra authentication for Windows Server Azure Virtual
Machines and Arc-enabled Servers. Azure Local doesn't support Microsoft Entra
authentication yet.
Windows Admin Center for Azure Virtual Machines is now generally available.
Windows Admin Center for Arc-enabled servers and Azure Local remains in Public
Preview.
Feedback
Was this page helpful? Yes No
Version 2410 is the most recently available (GA) release - it includes an upgrade
of the backend from .NET 4.6.2 to .NET 8, improvements to the virtual machines
and security tools, and many improvements and bugfixes.
Version 2311 includes an Angular 15 upgrade, improvements to the Import VM
experience, Azure Arc at-scale onboarding, and a new Azure Migrate assessment
experience.
Version 2306 includes the WDAC-enabled infra GA, new Hyper-V features and
improvements, the long awaited cluster-aware event viewer, as well as a plethora
of bug fixes and improvements.
Version 2211 includes support for 400% zoom and WDAC-enabled
infrastructure, improvements to Azure Local management features, as well as bug
fixes and updates in several extensions.
Version 2110.2 includes major bug fixes to Role-based Access Control (RBAC),
the connections page’s search feature, as well as bug fixes in several extensions.
Version 2110 includes Angular 11 upgrades, performance and security
enhancements. It also includes updated developer SDK for extension development
using Angular 11 or upgrading of existing extensions, CredSSP enhancements, a
better Virtual Machine tool, and two brand new tools for Security and GPU
management.
Version 2103.2 includes key bug fixes and feature updates to the Azure sign in
process, support for Azure China, support for seamless over-the-air updates for
Azure Local as well as additional updates to the Events and Remote Desktop tool
experience.
Version 2103 introduces automatic platform an extension updates and includes
updates to several of our core tools like the VM tool and Events.
Version 2009 includes support for Azure Kubernetes Service on Azure Local and
major updates to the Virtual machines, File shares, and Containers tools.
Version 2007 includes support for the new Azure Local and new features for
several tools.
Version 1910.2 includes updates to the platform’s accessibility and numerous
bug fixes
Version 1910 introduces several new Azure hybrid services and brings features
that were previously in preview to the GA channel.
Version 1909 introduces the Azure VM specific connection type and unifies the
connection types for traditional failover clusters and HCI clusters.
Version 1908 added visual updates, Packetmon, FlowLog Audit, Azure Monitor
onboarding for clusters, and support for WinRM over HTTPS (port 5986.)
Version 1907 added Azure cost estimate links and made improvements to
import/export and tagging of virtual machines.
Version 1906 added import/export VMs, switch Azure accounts, add connections
from Azure, connectivity settings experiment, performance improvements, and
performance profiling tool.
Version 1904.1 was a maintenance update to improve stability of gateway plugins.
Version 1904 was a GA release that introduced the Azure Hybrid Services tool,
and brought features that were previously in preview to the GA channel.
Version 1903 added email notifications from Azure Monitor, the ability to add
Server or PC connections from Active Directory, and new tools to manage Active
Directory, DHCP, and DNS.
Version 1902 added a shared connection list & improvements to software
defined network (SDN) management, including new SDN tools to manage ACLs,
gateway connections, and logical networks.
Version 1812 added dark theme (in preview), power configuration settings, BMC
info, and PowerShell support to manage extensions and connections.
Version 1809.5 was a GA cumulative update that included various quality and
functional improvements, bug fixes throughout the platform, and a few new
features in the hyper-converged infrastructure management solution.
Version 1809 was a GA release that brought features that were previously in
preview to the GA channel.
Version 1808 added Installed Apps tool, lots of under the hood improvements,
and major updates to the preview SDK.
Version 1807 added a streamlined Azure connect experience, improvements to
VM inventory page, file sharing functionality, Azure update management
integration, and more.
Version 1806 added show PowerShell script, SDN management, 2008 R2
connections, SDN, scheduled tasks, and many other improvements.
Version 1804.25 - a maintenance update to support users installing Windows
Admin Center in completely offline environments.
Version 1804 - Project Honolulu becomes Windows Admin Center and adds
security features and role-based access control. Our first GA release.
Version 1803 added support for Microsoft Entra access control, detailed logging,
resizable content, and a bunch of tool improvements.
Version 1802 added support for accessibility, localization, high-availability
deployments, tagging, Hyper-V host settings, and gateway authentication.
Version 1712 added more virtual machine features and performance
improvements throughout the tools.
Version 1711 added highly anticipated tools (Remote Desktop and PowerShell)
along with other improvements.
Feedback
Was this page helpful? Yes No
For info about Windows Admin Center Preview releases, see Windows Insider Preview
releases .
Feedback
Was this page helpful? Yes No
This article describes how to diagnose and resolve issues in Windows Admin Center. If you're
having an issue with a specific tool, check to see if you're experiencing a known issue.
Prerequisite
Windows Admin Center is supported on the following operating systems:
For Windows client, your device must be running Windows 10 version 1709 or later (Fall
Creators Update).
For Windows Server, your device must be running Windows Server 2016 or later.
This failure can happen if your default PowerShell module path has been modified or removed.
To resolve this issue, make sure that %SystemRoot%\system32\WindowsPowerShell\v1.0\Modules is
the first item in your PSModulePath environment variable. You can set this path by running the
following command in an elevated PowerShell window:
PowerShell
[Environment]::SetEnvironmentVariable("PSModulePath","%SystemRoot%\system32\Window
sPowerShell\v1.0\Modules;" +
([Environment]::GetEnvironmentVariable("PSModulePath","User")),"User")
Make sure you're using either Microsoft Edge or Google Chrome as your web browser
with the latest updates.
Try opening your browser in a private or incognito window. If Windows Admin Center
loads successfully, clear your browser cache in your regular session and try again.
This might have cleared your trusted hosts settings. See the Configure TrustedHosts list
section.
Make sure you're using either Microsoft Edge or Google Chrome as your web browser
with the latest updates.
Open Task Manager, select the Services tab, then make sure that
ServerManagementGateway or Windows Admin Center is running.
Test the network connection to the Gateway. Run the following command. Replace
<Port> and <Gateway> with your port number and gateway hostname (or IP address):
PowerShell
If the Windows Admin Center app is installed in an Azure Windows Server VM:
Verify and update the inbound port rule for HTTPS through the network security group or
firewall settings.
Ensure the Windows Remote Management (WinRM) service is running on both the gateway
machine and managed node:
3. In the Services window, check if the WinRM service is running and set to automatically
start.
I'm receiving WinRM error messages while
managing servers
WinRM doesn't allow credential delegation by default. To allow delegation, the computer
needs to have Credential Security Support Provider (CredSSP) enabled temporarily.
If you're receiving WinRM error messages, try the Manual troubleshooting section of
Troubleshoot CredSSP to resolve them.
Did you upgrade your server from Windows 2016 to a later release?
This might have cleared your trusted hosts settings. See the Configure TrustedHosts list
section to update your settings.
Can't connect securely to this page. This might be because the site uses outdated
or unsafe TLS security settings.
Your machine is restricted to HTTP/2 connections. Windows Admin Center uses integrated
Windows authentication, which isn't supported in HTTP/2. Add the following two registry
values under HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Http\Parameters
on the machine running the browser to remove the HTTP/2 restriction:
PowerShell
$registryPath = "HKLM:\SYSTEM\CurrentControlSet\Services\Http\Parameters"
New-ItemProperty -Path $registryPath -Name "EnableHttp2Cleartext" -PropertyType
DWORD -Value 0 -Force
New-ItemProperty -Path $registryPath -Name "EnableHttp2Tls" -PropertyType DWORD -
Value 0 -Force
If the session connects successfully, the PowerShell prompt updates to show you're
connected to the target machine. This indicates that connectivity and permissions are
likely configured correctly.
If the session doesn't successfully connect, it might relate to WinRM issues, network
connectivity problems, or authorization issues.
If your environment uses a workgroup instead of a domain, see using Windows Admin
Center in a workgroup.
You are not authorized to view this page. If you recently updated Windows Admin
Center, you may need to restart your browser, and then refresh the page.
Make sure to select the Windows Admin Center Client certificate when prompted on the first
launch, and not any other certificate. If you select any other certificate, you'll receive this error
message. To resolve this error, restart your browser and refresh the page, and select the
Windows Admin Center Client certificate. If you continue to get the same error, try clearing
the browser cache or switching to another browser. If none of these troubleshooting steps
resolve the issue, you may need to uninstall Windows Admin Center, reboot your device, and
reinstall it.
$registryPath = "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System"
New-ItemProperty -Path $registryPath -Name "LocalAccountTokenFilterPolicy" -
PropertyType DWORD -Value 1 -Force
PowerShell
PowerShell
PowerShell
Get-Item WSMan:\localhost\Client\TrustedHosts
2 Warning
If the current settings of your TrustedHosts file isn't empty, running the following
commands overwrite your settings. We recommend that you export the current
settings to a text file so you can restore it later if needed. The following command
exports only the entries from the Value column:
2. Set TrustedHosts to the IP, FQDN, or NetBIOS name of the machines you intend to
manage:
PowerShell
Tip
For an easy way to set all TrustedHosts at once, you can use a wildcard.
PowerShell
3. When you're done testing, you can issue the following command to clear your
TrustedHosts setting:
PowerShell
Clear-Item WSMan:localhost\Client\TrustedHosts
4. If you previously exported your settings and want to restore them, run the following
command and replace the Get-Content location to where you previously exported your
text file:
PowerShell
$oldTrustedHosts = Get-Content C:\[Link]
Set-Item WSMan:\localhost\Client\TrustedHosts -Value $oldTrustedHosts
If you're having trouble using Azure features when using Microsoft Edge, perform these steps
to add the required URLs:
2. Select the Security tab, select Trusted sites, then select the Sites button.
3. Add the following URLs in the Add the website to the zone field and select Add for each
one:
[Link]
[Link]
5. Open Microsoft Edge, paste this link in the search bar edge://settings/content/popups?
search=pop-up , then press Enter.
a. Under the Allowed to send pop-ups and use redirects section, select Add site.
b. Add the following URLs and select Add to add each one:
[Link]
[Link]
File a bug on the Windows Admin Center feedback intake that describes your issue.
Include any errors or warning you find in the event log including the following information:
Platform where Windows Admin Center is installed (Windows client or Windows Server).
If installed on a Server device, provide the Windows version (Windows Key + R, type
winver, then press Enter) of the machine running the browser to access Windows
Admin Center:
Are you using the self-signed certificate created by the installer?
If you're using your own certificate, does the subject name match the machine?
If you're using your own certificate, does it specify an alternate subject name?
Provide the Windows version (Windows Key + R, type winver, then press Enter) where
Windows Admin Center is installed:
To collect a HAR file in Microsoft Edge or Google Chrome, follow these steps:
1. Open your browser, press F12 to open Developer Tools window, then select the Network
tab.
2. Select the Clear icon to clean up the network log.
3. Select the Preserve log check box.
4. Reproduce the issue.
5. After reproducing the issue, select the icon to Export HAR.
6. Specify where you want to save the HAR log and select Save.
2 Warning
Before sharing your HAR files with Microsoft, review and redact any sensitive data, such as
passwords or personal information.
Windows Admin Center known issues
Article • 06/05/2024 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
If you encounter an issue not described on this page, let us know at the Windows Admin
Center feedback page .
Installer
When you install Windows Admin Center using your own certificate, if you copy
the thumbprint from the certificate manager Microsoft Management Center
(MMC) tool, when you paste it, it contains an invalid character at the beginning .
As a workaround, enter the first character of the thumbprint, then copy and paste
the characters that come after the first.
Windows Admin Center doesn't support ports lower than 1024. In service mode,
you can optionally configure port 80 to redirect to your specified port.
General
Windows Admin Center version 2410 build [Link] may appear as build number
2.4.1 on the Windows Admin Center Updates settings page.
In Windows Admin Center version 2410, users are unable to register their Windows
Admin Center gateways to sovereign clouds. This issue is actively being
investigated.
Manually modifying URLs to include the names of different machines while using
Windows Admin Center without going through the connection experience in the
UI can cause extensions to not load properly, especially extensions compatible with
specific hardware. We don't recommend manually modifying URLs for navigation
in Windows Admin Center.
If you have Windows Admin Center installed as a heavily used gateway on
Windows Server 2016, the service can crash and display an error in the event log
that contains Faulting application name: [Link] and Faulting module name:
[Link] . This error happens because of a bug that we've fixed as of Windows
Server 2019. However, we've also released a patch for Windows Server 2016 to
address this issue in the February 2019 cumulative update, KB4480977 .
If you have Windows Admin Center installed as a gateway and your connection list
appears to be corrupted, follow these steps:
2 Warning
The procedure in these instructions deletes the connection list and settings
for all Windows Admin Center users on the gateway.
2. Go to
C:\Windows\ServiceProfiles\NetworkService\AppData\Roaming\Microsoft
and delete the Server Management Experience folder.
If you leave the tool open and idle for a long period of time, several error
messages appear that say "The runspace state is not valid for this operation." If this
issue occurs, refresh your browser. If you encounter this error, send us feedback .
You can access and use Windows Admin Center tool application programming
interfaces (APIs) through other methods during an active session of Windows
Admin Center if you have access to that session. The actions you take using these
APIs only affect the machine you installed Windows Admin Center on, also known
as the gateway machine. They don't affect machines managed remotely without
authentication through the Windows Admin Center gateway.
Some APIs used by Windows Admin Center, including the DeploymentShare API,
require the user to be a local administrator. Network share creation operations
cannot be performed by a standard Windows user by default. Windows Admin
Center cannot elevate a standard user account to administrator. Adding the user to
the "Gateway administrators" group in Settings only changes the permissions the
user has within the gateway, not on the system.
You may not run into this issue on modernized gateway builds of Windows
Admin Center. By default, modernized gateway builds utilize a form login to
access the gateway, which does not have the local administrator restriction.
Existing versions of Windows Admin Center utilize NTLM/Kerberos, which
obtains a token limited to the localhost environment. NTLM/Kerberos login is
also available on modernized gateway builds.
Windows Admin Center does not support authenticating guest users of Microsoft
Entra ID tenants. As a result, guest users of Microsoft Entra ID tenants will no
longer be able to connect their Windows Admin Center instance to Azure or use
Azure services like Azure Arc, Azure Site Recovery, Azure File Sync, etc.
Extension Manager
When you update Windows Admin Center, you must reinstall your extensions.
Browser-specific issues
This section describes issues that can happen when you use Windows Admin Center in
an internet browser.
Microsoft Edge
If you have Windows Admin Center deployed as a service and you're using Microsoft
Edge as your browser, you might not be able to connect your gateway to Azure after
opening a new browser window. There isn't currently a solution for this issue, but you
can work around it by adding [Link] ,
[Link] , and the URL of your gateway as trusted sites and allowed sites
Google Chrome
Before version 70, Chrome had a bug that affected the WebSockets protocol and
Windows New Technology Local Area Network Manager (NTLM) authentication.
This bug also affects the following programs:
Windows Events
PowerShell
Remote Desktop
Many credential prompts might appear while you're using Chrome, especially
when you're adding connections in a workgroup environment.
If you have Windows Admin Center deployed as a service, you must enable
popups from the gateway URL to use Azure integration.
Mozilla Firefox
Windows Admin Center isn't tested with Mozilla Firefox, but most functionality
should work.
If you're using Windows 10, you need to import the Windows Admin Center Client
certificate into Firefox to use Windows Admin Center.
Remote Desktop
PowerShell
Packet Monitoring
Windows Events
Events
When you export large log files, you can sometimes receive an error message about
packet size.
Remote Desktop
When you deploy Windows Admin Center as a service, the Remote Desktop tool
sometimes doesn't load after the Windows Admin Center service updates to a new
version. To work around this issue, clear your browser cache.
The Remote Desktop tool sometimes doesn't connect when managing Windows
Server 2012.
When using the Remote Desktop to connect to a machine that isn't Domain joined,
you must enter your account in the MACHINENAME\USERNAME syntax.
Some configurations can block Windows Admin Center's remote desktop client
with group policy. If you're blocked by this issue, open the Local Group Policy
Editor and reconfigure the Computer Configuration\Administrative
Templates\Windows Components\Remote Desktop Services\Remote Desktop
Session Host\Connections Group Policy Object (GPO).
The Remote Desktop tool doesn't currently support any text, image, or file copy
and paste between the local desktop and the remote session.
You can copy text the same way you would during a local session by either right-
clicking and selecting Copy or pressing the Ctrl+C keys, but you can only paste by
right-clicking and selecting Paste.
Remote sessions don't support the following keys and keyboard shortcuts:
Alt+Tab
Function keys
Windows Key
PrtScn
To install WMF:
2. Enter $PSVersiontable to verify if you have WMF installed and check the version
number.
To use RBAC in a cluster, you must deploy the configuration to each member node
individually.
When you deploy RBAC, you may get unauthorized errors incorrectly attributed to
the RBAC configuration.
Certificates
Server Manager on Windows Admin Center doesn't currently support importing the .PFX
Encrypted Certificate into the current user store.
Files
Windows Admin Center doesn't currently support uploading or downloading files over
100 MB in size.
PowerShell
The issue described in WebSocket compatibility when using a proxy service affects
PowerShell.
PowerShell in Server Manager doesn't support pasting into the window by right-
clicking. To paste into the window, you need to right-click and select Paste from
the drop-down context menu or use the Ctrl+V shortcut.
PowerShell in Server Manager doesn't support the Ctrl+C shortcut to copy content
to the clipboard. To copy content, highlight the text, right-click it, then select Copy.
When you make the Windows Admin Center window smaller, the terminal content
adjusts to fit the new window size. When you return the window to its original size,
the content might not return to its original state. You can restore the text by using
the Clear-Host command, or disconnect and reconnect using the button above
the terminal.
Registry Editor
Registry Editor for Windows Admin Center for Windows Server hasn't implemented
search functionality.
If you choose to not automatically restart after you install a role, you won't see any
more notification messages asking you to restart.
If you do choose to automatically reboot, the reboot occurs before the status bar
reaches 100%.
Storage
DVD, CD, and Floppy drives don't appear as volumes on down-level.
Some properties in Volumes and Disks appear as unknown or blank in the Details
panel because they aren't available in down-level storage.
If you're creating a new Resilient File System (ReFS) volume, ReFS only supports an
allocation unit size of 64K on Windows 2012 and 2012 R2 machines. If you create a
ReFS volume with a smaller allocation unit size on down-level targets, file system
formatting doesn't work, making the new volume unusable. To resolve this issue,
delete the unusable volume, then create a new one with 64K allocation unit size.
Updates
After the system installs updates, it sometimes caches the install status and requires a
browser refresh. If you see an error message that says "Keyset does not exist" when
attempting to set up Azure Update management, follow these directions on the
managed node:
Virtual machines
If you're managing your virtual machines (VMs) on a Windows Server 2012 session
host, the in-browser VMConnect tool can't connect to the VM. You can resolve this
issue by downloading the .rdp file to connect to the VM.
If you've set up Azure Site Recovery on a host outside of Windows Admin Center, it
can't protect VMs from inside Windows Admin Center.
When you try to manage the local host, a message appears telling you to elevate
the gateway process. If you select No in the User Account Control window that
appears, you must cancel the connection attempt and start over.
You should also update your firewall to allow connections from outside the local
subnet by running Set-NetFirewallRule -Name WINRM-HTTP-In-TCP -
RemoteAddress Any . For more information about how to update your firewall in
Cluster deployment
This section describes known issues that affect cluster deployment.
To install Hyper-V on VMs running Azure Local, open an elevated PowerShell prompt
and run the following command:
PowerShell
To work around this issue, close the cluster deployment wizard before manually
restarting the server. Once you've restarted the server, you can open the cluster
deployment wizard again.
If you've already encountered this error message, here's how to clear the deleted cluster
object from the storage pools:
PowerShell
Clear-ClusterNode
3. Next, remove all previous storage pools by running the following command:
PowerShell
4. If you've configured the storage pools to be read-only, then you must change the
storage pools to write mode before removing them by running the following
command:
PowerShell
If you haven't encountered this error but want to avoid it, follow these instructions.
PowerShell
Get-VirtualDisk | Remove-VirtualDisk
PowerShell
PowerShell
PowerShell
Remove-Cluster -CleanupAD
PowerShell
Clear-ClusterNode
2. Disable CredSSP settings on all nodes and the Windows Admin Center gateway
machine.
PowerShell
PowerShell
PowerShell
4. Next, open a command prompt and run the following command on all nodes to
reset group policy propagated data:
Windows Command Prompt
gpupdate /force
6. After rebooting the nodes, open PowerShell again and run the following command
to test the connectivity between your gateway machine and target nodes.
PowerShell
CredSSP
When you use the Updates tool, you sometimes see an error message that says
"You can't use Cluster-Aware updating tool without enabling CredSSP and
providing explicit credentials" when you try to update new clusters, as shown in
the following screenshot.
To resolve this issue, update Windows Admin Center to version 2110 or later.
The CredSSP session endpoint permission issue is a common CredSSP error that
appears when Windows Admin Center is running on Windows client machines. To
resolve this issue, you should add affected users to the Windows Admin Center
CredSSP administrators group, then ask the user to sign back in to the desktop
computer running Windows Admin Center.
Nested virtualization
When you're validating Azure Local cluster deployments on VMs, you must enable
nested virtualization before you enable roles or features by running the following
command in PowerShell:
PowerShell
Set-VMProcessor -VMName <VMName> -ExposeVirtualizationExtensions $true
If you're using virtual switch teaming in a VM environment, you also need to run this
command on the session host after creating a VM:
PowerShell
If you're deploying a cluster using the Azure Stack HCI OS, there's an extra requirement.
The VM boot virtual hard drive must be preinstalled with Hyper-V features. To preinstall
these features, run the following command before creating the VMs:
PowerShell
You can sometimes encounter an issue when managing a down-level cluster with
an incomplete configuration. To resolve this issue, make sure the cluster has the
RSAT-Clustering-PowerShell feature installed and enabled on each member node.
If not, open PowerShell and enter the following command on each cluster node:
PowerShell
Install-WindowsFeature -Name RSAT-Clustering-PowerShell
If Windows Admin Center can't discover the cluster, try adding it with the entire
fully qualified domain name (FQDN).
Azure services
The following sections describe issues you can encounter when using Azure services
while in Windows Admin Center.
In the 2009 release, you can run into issues signing in to Azure or registering your
Windows Admin Center gateway with Azure. Try doing the following to
troubleshoot the issue:
Before using any Azure features in Windows Admin Center, including gateway
registration, make sure you've signed in to your Azure account in a different tab
or window. We recommend you sign in through the Azure portal .
If you successfully sign in to Azure during gateway registration but don't see
visual confirmation on the Azure page of your Windows Admin Center settings,
refresh the page by going to another page, then returning.
If you've already given admin approval for Windows Admin Center in the portal
but still see an error message that says "Need admin approval", try signing in to
Azure using the banners around Windows Admin Center instead of going to the
Settings page.
If your proxy is misconfigured, you can see an error message that says "Error:
Value cannot be null. Parameter name: httpClientFactory." To resolve this issue,
go to the Settings page and adjust your settings to the correct configuration.
There are two ways you can update Microsoft Entra ID.
2. Register Windows Admin Center with Azure again, making sure you choose to
create a new Microsoft Entra application.
5. Select Microsoft Graph > Delegated permissions > Directory and select the
[Link] checkbox.
6. Finally, select Add permissions to save the changes you made to the app.
If you've already configured Azure management services that use the Microsoft
Monitoring Agent before trying to use Azure Update Management in Windows Admin
Center, the service only lets you configure Azure Update Management if existing
resources linked to the Microsoft Monitoring Agent support it.
If the linked resources don't support Azure Update Management, there are two ways
you can work around it.
2. Follow the directions in How do I stop an agent from communicating with Log
Analytics to disconnect your server from Azure Monitor, Azure Security Center, or
other Azure management solutions you're currently using.
This error usually appears when you're trying to connect using WinRM. It can happen for
the following reasons:
If the service couldn't resolve DNS, make sure you entered the correct server name.
If the service couldn't reach the server name at all, this is likely due to a network
connection issue, such as a network disruption.
If the firewall rules aren't configured for the WinRM service, you must reconfigure
them for domain and private profiles.
If the WinRM service isn't running or disabled, enable the service and make sure it
keeps running.
Authentication error
When you encounter this error, the following error message appears:
error
Connecting to remote server ack failed with the following error message:
WinRM cannot process the request. The following error with error code
0x8009030e occurred while
using Negotiate authentication: A specified logon session does not exist. It
may already have been
terminated. \r\n This can occur if the provided credentials are not valid on
the target server, or
if the server identity could not be verified. If you trust the server
identity add the server name
to the TrustedHosts list, and then retry the request. User [Link] to view
or edit the
TrustedHosts list. Note that computers in the TrustedHosts list might not be
authenticated. For
more information about how to edit the TrustedHosts list, run the following
command: winrm help
config. For more information, see the about_Remote_Troubleshooting Help
topic.
This error usually occurs on cluster connections when WinRM can't connect because of
the following reasons:
The user trying to sign in is in the domain but can't contact the domain even
though they can reach the server. When this happens, WinRM treats the user like
they aren't in the domain but are connecting to a domain account.
Make sure users can always contact the domain, especially after a network
operation.
You should add all computers you're connecting to into the trusted hosts (FQDNS),
such as
@{TrustedHosts="[Link],[Link],[Link]"} .
WinRM service
When you encounter this error, the following error message appears:
error
The WinRM listener isn't configured or is corrupted. The quickest way to solve this
problem is to run WinRM quickconfig in PowerShell, which creates a listener.
WinRM also has two built-in listeners for HTTPS and HTTP connections. The HTTPS
server and client should both have the same valid certificates.
Security error
When you encounter this error, the following error message appears:
error
This error is uncommon. You usually encounter this area when an account tries to create
a remote connection. In most cases, one or more default HTTP SPNs are registered to a
service account, causing Kerberos authentication to fail. This issue usually happens
because some software installed on the server needs one or more SPNs to function
properly, such as SQL Server Reporting Services, Microsoft Dynamics, SharePoint, and so
on.
In some cases, one of the SPNs is registered to a service account while the other one
isn't. In that case, the WinRM connection succeeds when trying to start a session with
the server name, but fails when it tries to start a session using the FQDN.
To resolve this issue, check if one or more default HTTP SPNs are registered to a service
account by running the following command in PowerShell:
PowerShell
setspn -q HTTP/[Link]
If the service finds the SPN but the server name isn't in the highlighted field of the error
message, run the following command to set up dedicated SPNs for WinRM by
specifying the port number and the machine account:
PowerShell
If you're connecting remotely using PowerShell, make sure to also use the
IncludePortInSPN parameter, as shown in the following example command:
PowerShell
error
This error is very rare. When you see this error message, it usually means WinRM
couldn't process the request. The reason why this error appears varies based on context.
To resolve this issue, make sure remoting is enabled and that you configure the WinRM
listener to accept requests. We also recommend you check the event logs for other
errors, such as if WinRM can't access certain files in the file system due to the files only
having read permissions.
Feedback
Was this page helpful? Yes No
Provide product feedback
Windows Admin Center - License Terms
Article • 03/31/2022
Windows Admin Center for Microsoft Windows Server and Microsoft Windows
operating system (Version 10)
Feedback
Was this page helpful? Yes No
Extensions for Windows Admin Center
Article • 01/12/2022 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
Windows Admin Center extensions are built using modern web technologies including
HTML5, CSS, Angular, TypeScript and jQuery, and can manage target servers via
PowerShell or WMI. You can also manage target servers, services, or devices over
different protocols such as REST by building a Windows Admin Center gateway plugin.
Integrate with Windows Admin Center tools: Integrate your products and services
with server and cluster management tools in Windows Admin Center and deliver
unified and seamless, end-to-end monitoring, management, troubleshooting
experiences to your customers.
Leverage platform security, identity and management capabilities: Enable
Microsoft Entra ID support, multi-factor authentication, Role-Based Access Control
(RBAC), logging, and auditing for your product and services by leveraging
Windows Admin Center platform capabilities to meet the complex requirements of
today's IT organizations.
Develop using the latest web technologies: Quickly build stunning user
experiences using modern web technologies including HTML5, CSS, Angular,
TypeScript and jQuery, and rich, powerful UI controls included in the Windows
Admin Center SDK.
Extend product outreach: Become a part of the Windows Admin Center ecosystem
with outreach to our expanding customer base.
Start developing with the Windows Admin
Center SDK
Getting started with Windows Admin Center development is easy! Sample code can be
found for tool, solution, and gateway plugin extension types in our SDK documentation.
There you will use the Windows Admin Center SDK to build a new extension project,
then follow the individual guides to customize your project to meet your needs.
We've made a Windows Admin Center SDK design toolkit available to help you rapidly
mock up extensions in PowerPoint using Windows Admin Center styles, controls, and
page templates. See what your extension can look like in Windows Admin Center before
you start coding!
We also have sample code hosted on GitHub: Developer Tools is a sample solution
extension containing a rich collection of controls that you can browse and use in your
own extension. Developer Tools is a fully functioning extension that can be side-loaded
into Windows Admin Center in Developer Mode.
See the topics below to learn more about the SDK and get started:
Partner Spotlight
See the amazing value our partners have started to bring to the Windows Admin Center
ecosystem and try these extensions out today. Learn more on how to install extensions
from Windows Admin Center.
BiitOps
The BiitOps Changes extension provides change tracking for hardware, software, and
configuration settings on your Windows Server physical/virtual machines. The BiitOps
Changes extension will show precisely what is new, what has changed and what has
been deleted in a single-pane-of-glass to help track issues related to compliance,
reliability and security. Learn more about the BiitOps Changes extension.
DataON
The DataON MUST extension brings monitoring, management, and end-to-end insight
into DataON's hyper-converged infrastructure and storage systems based on Windows
Server. The MUST extension adds unique value such as historical data reporting, disk
mapping, system alerts and SAN-like call home service, complementing the Windows
Admin Center server and hyper-converged infrastructure management capabilities,
through a seamless, unified experience. Learn more about DataON's MUST extension
and their development experience.
Fujitsu
Fujitsu's ServerView Health and RAID Health extensions for Windows Admin Center
provide in-depth monitoring and management of critical hardware components such as
processors, memory, power, and storage subsystems for Fujitsu PRIMERGY servers. By
utilizing the Windows Admin Center UX design patterns and UI controls, Fujitsu has
brought us a huge step towards our vision of end-to-end insight into server roles and
services, to operating system, and to hardware management through the Windows
Admin Center platform. Learn more about Fujitsu's extensions and their development
experience.
Lenovo
The Lenovo XClarity Integrator extension takes hardware management to the next level
by seamlessly integrating into various experiences within Windows Admin Center. The
XClarity Integrator solution provides a high-level view of all your Lenovo servers, and
different tool extensions provide hardware details whether you are connected to a
single server, failover cluster, or hyper-converged cluster. Learn more about the Lenovo
XClarity Integrator extension.
Pure Storage
Pure Storage provides enterprise, all-flash data storage solutions that deliver data-
centric architecture to accelerate your business for a competitive advantage. The Pure
Storage extension for Windows Admin Center provides a single-pane view into Pure
FlashArray products and empowers users to conduct monitoring tasks, view real-time
performance metrics, and manage storage volumes and initiators through a single UI
experience. Learn more about Pure's extensions and their development experience.
QCT
The QCT Management Suite extension complements Windows Admin Center by
providing physical server monitoring and management for QCT Azure Local certified
systems. The QCT Management Suite extension displays server hardware information,
and provides an intuitive wizard UI to help replace physical disks efficiently, hardware
event log tools, and S.M.A.R.T. based predictive disk management. Learn more about
the QCT Management Suite extension.
Feedback
Was this page helpful? Yes No
In case you're not yet familiar with how Windows Admin Center works, let's start with
the high-level architecture. Windows Admin Center is composed of two main
components:
Lightweight web service that serves Windows Admin Center UI web pages to web
browser requests.
Gateway component that listens for REST API requests from the web pages and
relays WMI calls or PowerShell scripts to be executed on a target server or cluster.
The Windows Admin Center UI web pages served by the web service have two main UI
components from an extensibility perspective, solutions and tools, which are
implemented as extensions, and, a third extension type called gateway plugins.
Solution extensions
In the Windows Admin Center home screen, by default, you can add connections that
are one of four types – Windows Server connections, Windows PC connections, server
clusters connections and Azure VMs connections. Once a connection is added, the
connection name and type will be displayed in the home screen. Clicking on the
connection name will attempt to connect to the target server or cluster and then load
the UI for the connection.
Each connection type maps to a solution, and solutions are defined through a type of
extension called “solution” extensions. Solutions typically define a unique type of object
you wish to manage through Windows Admin Center, such as servers, PCs or failover
clusters. You could also define a new solution for connecting to and managing other
devices such as network switches and Linux servers, or even services such as Remote
Desktop Services.
Tool extensions
When you click on a connection in the Windows Admin Center home screen and
connect, the solution extension for the selected connection type will be loaded and
you'll then be presented with the solution UI including a list of tools in the left
navigation pane. When you click on a tool, the tool UI is loaded and displayed in the
right pane.
Each tool is defined through a second type of extension called “tool” extensions. When a
tool is loaded, it can execute WMI calls or PowerShell scripts on a target server or cluster
and display information in the UI or execute commands based on user input. A tool
extension defines which solutions it should be displayed for, resulting in a different set
of tools for each solution. If you're creating a new solution extension, you'll additionally
need to write one or more tool extensions that provide functionality for the solution.
Gateway plugins
The gateway service exposes REST APIs for the UI to call and relays commands and
scripts to be executed on the target. The gateway service can be extended by gateway
plugins that support different protocols. Windows Admin Center is pre-packaged with
two gateway plugins, one for executing PowerShell scripts and the other for WMI
commands. If you need to communicate with the target through a protocol other than
PowerShell or WMI, such as REST, you can build a gateway plugin for this.
Next steps
Depending on what capabilities you want to build in Windows Admin Center, building a
tool extension for an existing server or cluster solution may be sufficient, and is the
easiest first step into building extensions. However, if your feature is for managing a
device, service or something completely new, rather than a server or cluster, you should
consider building a solution extension with one or more tools. And finally, if you need to
communicate with the target through a protocol other than WMI or PowerShell, you'll
need to build a gateway plugin. Continue reading on to learn how to set up your
development environment and start writing your first extension.
Feedback
Was this page helpful? Yes No
Windows Admin Center supports three types of extensions - tool extensions, solution
extensions and gateway plugins. The SDK contains content and examples to guide you
in building the different types of extensions/plugins.
7 Note
Not familiar with the different extension types? Learn more about the extensibility
architecture and extension types.
Development step-by-step
Prepare your development environment
Create a tool extension
Create a solution extension
Create a gateway plugin
Learn more with our guides
Feedback
Was this page helpful? Yes No
Let's get started developing extensions with the Windows Admin Center SDK! In this
document, we'll cover the process to get your environment up and running to build and
test an extension for Windows Admin Center.
7 Note
New to the Windows Admin Center SDK? Learn more about Extensions for
Windows Admin Center
Install prerequisites
To begin developing with the SDK, download and install the following prerequisites:
Open your Windows Admin Center instance's [Link] file. This can be
found by default at C:\Program
Files\WindowsAdminCenter\service\[Link] .
7 Note
To develop extensions on versions of Windows Admin Center using .NET 4.6.2, you
need to install and run Windows Admin Center in Dev Mode to follow the steps
below. Dev Mode allows Windows Admin Center to load unsigned extension
packages. Windows Admin Center can only be installed in Dev Mode on a Windows
10 machine.
To enable Dev Mode, install Windows Admin Center from the command line with
the parameter DEV_MODE=1. In the example below, replace <version> with the
version you are installing, i.e. [Link] .
If you have already installed Windows Admin Center without enabling Dev Mode,
you can edit the value of the Dev Mode property using Registry Editor. Properties
for Windows Admin Center can be found under the following path:
Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ServerManagementGateway
7 Note
You can install a later version of @angular/cli, however be aware that if you install a
version greater than 11.2.14, you will receive a warning during the gulp build step
that the local cli version does not match the installed version.
Next steps
Now that your environment is prepared, you are ready to start creating content.
Create a tool extension
Create a solution extension
Create a gateway plugin
Learn more with our guides
Feedback
Was this page helpful? Yes No
A tool extension is the primary way that users interact with Windows Admin Center to
manage a connection, such as a server or cluster. When you click on a connection in the
Windows Admin Center home screen and connect, you will then be presented with a list
of tools in the left navigation pane. When you click on a tool, the tool extension is
loaded and displayed in the right pane.
When a tool extension is loaded, it can execute WMI calls or PowerShell scripts on a
target server or cluster and display information in the UI or execute commands based
on user input. Tool extensions define which solutions it should be displayed for,
resulting in a different set of tools for each solution.
7 Note
Not familiar with the different extension types? Learn more about the extensibility
architecture and extension types.
ノ Expand table
Value Explanation Example
{!Tool Name} Your tool name (with spaces) Manage Foo Works
wac create --company "Contoso Inc" --tool "Manage Foo Works" --version
latest
This creates a new folder inside the current working directory using the name you
specified for your tool, copies all the necessary template files into your project, and
configures the files with your company and tool name.
7 Note
The --version flag in this command specifies which version of the Windows Admin
Center SDK you'd like to target. Read about how to target a different version of
the Windows Admin Center SDK to keep up your extension up to date with the
latest SDK and platform changes.
Next, change directory into the folder just created, then install required local
dependencies by running the following command:
npm install
Once this completes, you've set up everything you need to load your new extension into
Windows Admin Center.
Enable the Developer Guide extension on the Advanced page of your Windows Admin
Center settings.
JSON
"icon": "{!icon-uri}",
ノ Expand table
NOTE: Currently, custom icons aren't visible when side loading your extension in dev
mode. As a workaround, remove the contents of target as follows:
JSON
"target": "",
This configuration is only valid for side loading in dev mode, so it's important to
preserve the value contained in target and then restore it before publishing your
extension.
Note that you need to choose a port that is currently free. Make sure you do not
attempt to use the port that Windows Admin Center is running on.
Your project can be side loaded into a local instance of Windows Admin Center for
testing by attaching the locally served project into Windows Admin Center.
[Link]("[Link]
Your project will now be visible in the Tools list with (side loaded) next to the name.
Feedback
Was this page helpful? Yes No
Solutions primarily define a unique type of object you wish to manage through
Windows Admin Center. These solutions/connection types are included with Windows
Admin Center by default:
When you select a connection from the Windows Admin Center connection page, the
solution extension for that connection's type is loaded, and Windows Admin Center will
attempt to connect to the target node. If the connection is successful, the solution
extension's UI will load, and Windows Admin Center will display the tools for that
solution in the left navigation pane.
If you would like to build a management GUI for services not defined by the default
connection types above, such a network switch, or other hardware not discoverable by
computer name, you may want to create your own solution extension.
7 Note
Not familiar with the different extension types? Learn more about the extensibility
architecture and extension types.
ノ Expand table
{!Solution Name} Your solution name (with spaces) Contoso Foo Works Suite
{!Tool Name} Your tool name (with spaces) Manage Foo Works
wac create --company "Contoso Inc" --solution "Contoso Foo Works Suite" --
tool "Manage Foo Works"
This creates a new folder inside the current working directory using the name you
specified for your solution, copies all the necessary template files into your project, and
configures the files with your company, solution, and tool name.
7 Note
The --version flag in this command specifies which version of the Windows Admin
Center SDK you'd like to target. Read about how to target a different version of
the Windows Admin Center SDK to keep up your extension up to date with the
latest SDK and platform changes.
Next, change directory into the folder just created, then install required local
dependencies by running the following command:
npm install
Once this completes, you've set up everything you need to load your new extension into
Windows Admin Center.
Add content to your extension
Now that you've created an extension with the Windows Admin Center SDK, you are
ready to customize content. See these guides for examples of what you can do:
Even more examples can be found in our Developer Guide. The Developer Guide is a
fully functioning solution extension that can be side-loaded into Windows Admin
Center, and contains a rich collection of sample functionality and tool examples that you
can browse and use in your own extension.
Enable the Developer Guide extension on the Advanced page of your Windows Admin
Center settings.
gulp build
gulp serve --port 4201
Note that you need to choose a port that is currently free. Make sure you do not
attempt to use the port that Windows Admin Center is running on.
Your project can be side loaded into a local instance of Windows Admin Center for
testing by attaching the locally served project into Windows Admin Center.
Your project will now be visible in the Tools list with (side loaded) next to the name.
Feedback
Was this page helpful? Yes No
A Windows Admin Center gateway plugin enables API communication from the UI of
your tool or solution to a target node. Windows Admin Center hosts a gateway service
that relays commands and scripts from gateway plugins to be executed on target nodes.
The gateway service can be extended to include custom gateway plugins that support
protocols other than the default ones.
These gateway plugins are included by default with Windows Admin Center:
If you would like to communicate with a protocol other than PowerShell or WMI, such as
with REST, you can build your own gateway plugin. Gateway plugins are loaded into a
separate AppDomain from the existing gateway process, but use the same level of
elevation for rights.
7 Note
Not familiar with the different extension types? Learn more about the extensibility
architecture and extension types.
) Important
The Windows Admin Center SDK and developer tools have not yet been updated to
support development of gateway plug-ins compatible with the Windows Admin
Center modernized gateway. Following this guide will not result in a .NET 8
extension compatible with the modernized gateway.
Gateway plug-ins developed in .NET 6 while the backend update was in preview
may not function correctly with the latest version of Windows Admin Center due to
breaking changes from .NET 6 to .NET 8. We recommend upgrading your
extension to .NET 8 as soon as possible.
Prepare your environment
If you haven't already, prepare your environment by installing dependencies and global
prerequisites required for all projects.
7 Note
The IFeature interface, available in earlier versions of the SDK, is now flagged as
obsolete. All gateway plugin development should use IPlugIn (or optionally the
HttpPlugIn abstract class).
Add content
Add new content to your cloned copy of the sample C# plugin project project (or your
own project) to contain your custom APIs, then build your custom gateway plugin DLL
file to be used in the next steps.
Windows Admin Center looks for all plugins in a plugins folder in the Application Data
folder of the current machine (using the CommonApplicationData value of the
[Link] enumeration). On Windows 10, this location is
C:\ProgramData\Server Management Experience . If the plugins folder doesn't exist yet,
7 Note
You can override the plugin location in a debug build by updating the
"StaticsFolder" configuration value. If you're debugging locally, this setting is in the
[Link] of the Desktop solution.
Create a new folder with the same name as the Name property value of the Feature
in your custom gateway plugin DLL (in our sample project, the Name is "Sample
Uno")
Copy your custom gateway plugin DLL file to this new folder
Restart the Windows Admin Center process
After the Windows Admin process restarts, you'll be able to exercise the APIs in your
custom gateway plugin DLL by issuing a GET, PUT, PATCH, DELETE, or POST to
http(s)://{domain|localhost}/api/nodes/{node}/features/{feature name}/{identifier}
{!Tool Name} Your tool name (with spaces) Manage Foo Works
This command creates a new folder inside the current working directory using the name
you specified for your tool, copies all the necessary template files into your project, and
configures the files with your company and tool name.
Next, change directory into the folder, then install required local dependencies by
running the following command:
npm install
Once this command completes, you're set up with everything you need to load your
new extension into Windows Admin Center.
gulp build
gulp serve -p 4201
The port you choose must currently be free. Make sure you don't attempt to use the
port that Windows Admin Center is running on.
Your project can be side loaded into a local instance of Windows Admin Center for
testing by attaching the locally served project into Windows Admin Center.
[Link]("[Link]
Your project will now be visible in the Tools list with (side loaded) next to the name.
Feedback
Was this page helpful? Yes No
Keeping your extension up to date with SDK changes and platform changes is easy. We
use NuGet Package Manager tags to organize the release of new features into SDK
versions.
There are two SDK versions you can choose from and three which are deprecated:
latest – this SDK package aligns with the current GA release of Windows Admin
instead
next – this SDK package has been deprecated, use latest or experimental instead
legacy – this SDK package has been deprecated, use latest or experimental
instead
7 Note
Find out more about the different versions of Windows Admin Center that are
available to download.
ノ Expand table
Value Explanation Example
{!Tool Name} Your tool name (with spaces) Manage Foo Works
wac create --company "Contoso Inc" --tool "Manage Foo Works" --version
experimental
7 Note
We recommend developers building new extensions use the latest SDK version
for stability.
"@microsoft/windows-admin-center-sdk": "latest",
In this example, replace latest with your desired SDK version, i.e. experimental :
"@microsoft/windows-admin-center-sdk": "experimental",
Feedback
Was this page helpful?
Yes No
Guides
Here are some guides for developing with the Windows Admin Center SDK:
Feedback
Was this page helpful? Yes No
In this article, add an empty module to a tool extension we've created with the Windows
Admin Center CLI.
To learn more:
Open a command prompt, change directory to .\src\app in your project, and then run
the following commands, replacing {!ModuleName} with your module name (spaces
removed).
cd .\src\app
ng generate module {!ModuleName}
ng generate component {!ModuleName}
ノ Expand table
Example usage:
PowerShell
cd .\src\app
ng generate module ManageFooWorksPortal
ng generate component ManageFooWorksPortal
Use the same module name that you used in the preceding step.
ノ Expand table
ts
@NgModule({
imports: [
[Link](routes)
],
exports: [
RouterModule
]
})
export class Routing { }
ノ Expand table
ノ Expand table
ts
3. Replace values in the content just added with your desired values:
ノ Expand table
Value Explanation Example
ノ Expand table
ノ Expand table
ts
constructor() {
// TODO
}
public ngOnInit() {
// TODO
}
Update [Link]
1. Open file [Link] , and modify the default path so it loads the new
module you created. Find the entry for path: '' , and update loadChildren to load
your module instead of the default module:
ノ Expand table
ts
{
path: '',
loadChildren: 'app/{!module-name}/{!module-name}.module#
{!ModuleName}Module'
},
ts
{
path: '',
loadChildren: 'app/manage-foo-works-portal/manage-foo-works-
[Link]#ManageFooWorksPortalModule'
},
Feedback
Was this page helpful? Yes No
In this article, we will add an iFrame to a new, empty tool extension we have created
with the Windows Admin Center CLI.
In \src\app, browse into your module folder, then open file {!module-
name}.[Link] , found with the following naming convention:
ノ Expand table
HTML
<div>
<iframe style="height: 850px;" src="[Link]
</div>
That's it, you've added an iFrame to your extension. Next, you can build and side load
your extension in Windows Admin Center to see the results.
7 Note
Content Security Policy (CSP) settings could prevent some sites from rendering in
an iFrame within Windows Admin Center. You can learn more about this here .
Feedback
Was this page helpful? Yes No
In this article, we will use a custom gateway plugin in a new, empty tool extension we
have created with the Windows Admin Center CLI.
Create [Link]
Change to the directory of the new tool module created above ( \src\app\{!Module-
Name} ), and create a new file [Link] .
ts
@Injectable()
export class PluginService {
constructor(private appContextService: AppContextService, private http:
Http) {
}
return [Link](callUrl,
'features/Sample%20Uno').map(
(response: any) => {
return response;
}
)
}
}
2 Warning
Modify [Link]
Open the [Link] file of the new module created earlier (i.e. {!Module-
Name}.[Link] ):
ts
ts
,
providers: [
HttpService,
PluginService,
Http
]
Modify [Link]
Open the [Link] file of the new module created earlier (i.e. {!Module-
Name}.[Link] ):
ts
ts
ts
public ngOnInit() {
[Link] = 'click go to do something';
}
public onClick() {
[Link] =
[Link]().subscribe(
(response: any) => {
[Link] = 'response: ' + [Link];
},
(error) => {
[Link](error);
}
);
}
Modify [Link]
Open the [Link] file of the new module created earlier (i.e. {!Module-
Name}.[Link] ):
HTML
Feedback
Was this page helpful? Yes No
Connection Providers play an important role in how Windows Admin Center defines and
communicates with connectable objects, or targets. Primarily, a Connection Provider
performs actions while a connection is being made, such as ensuring that the target is online
and available, and also ensuring that the connecting user has permission to access the
target.
By default, Windows Admin Center ships with the following Connection Providers:
Server
Windows Client
Failover Cluster
HCI Cluster
JSON
{
"entryPointType": "connectionProvider",
"name": "addServer",
"path": "/add",
"displayName": "resources:strings:addServer_displayName",
"icon": "sme-icon:icon-win-server",
"description": "resources:strings:description",
"connectionType": "[Link]",
"connectionTypeName": "resources:strings:addServer_connectionTypeName",
"connectionTypeUrlName": "server",
"connectionTypeDefaultSolution": "[Link]-manager!servers",
"connectionTypeDefaultTool": "[Link]-manager!overview",
"connectionStatusProvider": {
"powerShell": {
"script": "## Get-My-Status ##\nfunction Get-Status()\n{\n# A function
like this would be where logic would exist to identify if a node is
connectable.\n$status = @{label = $null; type = 0; details = $null; }\n$caption
= \"MyConstCaption\"\n$productType = \"MyProductType\"\n# A result object needs
to conform to the following object structure to be interpreted properly by the
Windows Admin Center shell.\n$result = @{ status = $status; caption = $caption;
productType = $productType; version = $version }\n# DO FANCY LOGIC #\n# Once the
logic is complete, the following fields need to be populated:\n$[Link] =
\"Display Thing\"\n$[Link] = 0 # This value needs to conform to the
LiveConnectionStatusType enum. >= 3 represents a failure.\n$[Link] =
\"success stuff\"\nreturn $result}\nGet-Status"
},
"displayValueMap": {
"wmfMissing-label":
"resources:strings:addServer_status_wmfMissing_label",
"wmfMissing-details":
"resources:strings:addServer_status_wmfMissing_details",
"unsupported-label":
"resources:strings:addServer_status_unsupported_label",
"unsupported-details":
"resources:strings:addServer_status_unsupported_details"
}
}
},
An entry point of type "connnectionProvider" indicates to the Windows Admin Center shell
that the item being configured is a provider that will be used by a Solution to validate a
connection state. Connection Provider entry points contains a number of important
properties, defined below:
ノ Expand table
Property Description
entryPointType This is a required property. There are three valid values: "tool", "solution",
and "connectionProvider".
name Identifies the Connection Provider within the scope of a Solution. This value
must be unique inside a full Windows Admin Center instance (not just a
Solution).
path Represents the URL path for the "Add Connection" UI, if it will be configured
by the Solution. This value must map to a route that is configured in app-
[Link] file. When the Solution entry point is configured to use
the connections rootNavigationBehavior, this route will load the module that
Property Description
is used by the Shell to display the Add Connection UI. More information
available in the section on rootNavigationBehavior.
displayName The value entered here is displayed on the right hand side of the shell,
below the black Windows Admin Center bar when a user loads a Solution's
connections page.
icon Represents the icon used in the Solutions drop down menu to represent the
Solution.
connectionType Represents the connection type that the provider will load. The value
entered here will also be used in the Solution entry point to specify that the
Solution can load those connections. The value entered here will also be
used in Tool entry point(s) to indicate that the Tool is compatible with this
type. This value entered here will also be used in the connection object that
is submitted to the RPC call on the "Add window", in the application layer
implementation step.
connectionTypeName Used in the connections table to represent a connection that uses your
Connection Provider. This is expected to be the plural name of the type.
connectionTypeUrlName Used in creating the URL to represent the loaded Solution, after Windows
Admin Center has connected to an instance. This entry is used after
connections, and before the target. In this example, "connectionexample" is
where this value appears in the URL:
[Link]
[Link]
connectionTypeDefaultSolution Represents the default component that should be loaded by the Connection
Provider. This value is a combination of:
[a] The name of the extension package defined at the top of the manifest;
[b] Exclamation point (!);
[c] The Solution entry point name.
For a project with name "[Link]-extension", and a Solution
entry point with name "example", this value would be
"[Link]-extension!example".
Define status
Connection Status Providers are required to return an object with a single property status
that conforms to the following format:
JSON
{
status: {
label: string;
type: int;
details: string;
}
}
Status properties:
Label - A label describing the status return type. Note, values for label can be mapped
in runtime. See entry below for mapping values in runtime.
Type - The status return type. Type has the following enumeration values. For any value
2 or above, the platform will not navigate to the connected object, and an error will be
displayed in the UI.
Types:
ノ Expand table
Value Description
0 Online
1 Warning
Value Description
2 Unauthorized
3 Error
4 Fatal
5 Unknown
PowerShell
## Get-My-Status ##
function Get-Status()
{
# A function like this would be where logic would exist to identify if a
node is connectable.
$status = @{label = $null; type = 0; details = $null; }
$caption = "MyConstCaption"
$productType = "MyProductType"
# DO FANCY LOGIC #
return $result
}
Get-Status
Define RelativeGatewayUrl Connection Status Provider
method
The Connection Status Provider RelativeGatewayUrl method calls a rest API to determine if a
target is online and accessible. The result must be returned in an object with a single
property "status". An example Connection Provider entry in [Link] of a
RelativeGatewayUrl is shown below.
JSON
{
"entryPointType": "connectionProvider",
"name": "addServer",
"path": "/add/server",
"displayName": "resources:strings:addServer_displayName",
"icon": "sme-icon:icon-win-server",
"description": "resources:strings:description",
"connectionType": "[Link]",
"connectionTypeName": "resources:strings:addServer_connectionTypeName",
"connectionTypeUrlName": "server",
"connectionTypeDefaultSolution": "[Link]-manager!servers",
"connectionTypeDefaultTool": "[Link]-manager!overview",
"connectionStatusProvider": {
"relativeGatewayUrl": "<URL here post /api>",
"displayValueMap": {
"wmfMissing-label":
"resources:strings:addServer_status_wmfMissing_label",
"wmfMissing-details":
"resources:strings:addServer_status_wmfMissing_details",
"unsupported-label":
"resources:strings:addServer_status_unsupported_label",
"unsupported-details":
"resources:strings:addServer_status_unsupported_details"
}
}
},
"relativeGatewayUrl" specifies where to get the connection status from a gateway URL.
This URI is relative from /api. If $connectionName is found in the URL, it will be
replaced with the name of the connection.
All relativeGatewayUrl properties must be executed against the host gateway, which
can be accomplished by creating a gateway extension
JSON
"defaultConnection_test":
"resources:strings:addServer_status_defaultConnection_label"
ノ Expand table
Function Description
constructor(private appContextService:
AppContextService, private route: ActivatedRoute)
public ngOnInit()
Define onSubmit
onSubmit issues an RPC call back to the app context to notify the shell of an "Add
ts
[Link](
[Link],
'##',
<RpcUpdateData>{
results: {
connections: connections,
credentials: [Link] ? [Link] : null
}
}
);
The result is a connection property, which is an array of objects that conform to the
following structure:
ts
/**
* The connection attributes class.
*/
export interface ConnectionAttribute {
/**
* The id string of this attribute
*/
id: string;
/**
* The value of the attribute. used for attributes that can have variable
values such as Operating System
*/
value?: string | number;
}
/**
* The connection class.
*/
export interface Connection {
/**
* The id of the connection, this is unique per connection
*/
id: string;
/**
* The type of connection
*/
type: string;
/**
* The name of the connection, this is unique per connection type
*/
name: string;
/**
* The property bag of the connection
*/
properties?: ConnectionProperties;
/**
* The ids of attributes identified for this connection
*/
attributes?: ConnectionAttribute[];
/**
* The tags the user(s) have assigned to this connection
*/
tags?: string[];
}
/**
* Defines connection type strings known by core
* Be careful that these strings match what is defined by the manifest of @msft-
sme/server-manager
*/
export const connectionTypeConstants = {
server: '[Link]',
cluster: '[Link]',
hyperConvergedCluster: '[Link]-converged-cluster',
windowsClient: '[Link]-client',
clusterNodesProperty: 'nodes'
};
Define onCancel
onCancel cancels an "Add Connection" attempt by passing an empty connections array:
ts
[Link]([Link], '##',
<RpcUpdateData>{ results: { connections: [] } });
ts
@Component({
selector: 'add-example',
templateUrl: './[Link]',
styleUrls: ['./[Link]']
})
export class AddExampleComponent implements OnInit {
public newConnectionName: string;
public strings = [Link]<Strings>().SolutionExample;
private connectionType = '[Link]'; // This needs to
match the connectionTypes value used in the [Link].
public ngOnInit() {
// TODO
}
public onSubmit() {
let connections: Connection[] = [];
[Link](connection);
[Link](
[Link],
'##',
<RpcUpdateData> {
results: {
connections: connections,
credentials: null
}
}
);
}
public onCancel() {
[Link](
[Link], '##', <RpcUpdateData>{ results: {
connections: [] } });
}
}
Feedback
Was this page helpful? Yes No
This article provides guidance on how to modify the root navigation behavior for your
solution to have different connection list behavior. You'll also learn how to hide or show
the tools list.
"entryPoints": [
{
"entryPointType": "solution",
"name": "main",
"urlName": "testsln",
"displayName": "resources:strings:displayName",
"description": "resources:strings:description",
"icon": "sme-icon:icon-win-powerShell",
"path": "",
"rootNavigationBehavior": "path"
}
],
Tools built with this kind of structure don't require connections to load, but don't have
node connectivity functionality either.
Setting connections as a rootNavigationBehavior
When you set the rootNavigationBehavior property to connections , you're telling the
Windows Admin Center Shell that there's a connected node (always a server of some
type) that it should connect to verify connection status. There are two steps in verifying
a connection.
1. Windows Admin Center attempts to make an attempt to log into the node with
your credentials (for establishing the remote PowerShell session).
2. Windows Admin Center executes the PowerShell script you provide to verify if the
node is in a connectable state.
JSON
{
"entryPointType": "solution",
"name": "example",
"urlName": "solutionexample",
"displayName": "resources:strings:displayName",
"description": "resources:strings:description",
"icon": "sme-icon:icon-win-powerShell",
"rootNavigationBehavior": "connections",
"connections": {
"header": "resources:strings:connectionsListHeader",
"connectionTypes": [
"[Link]"
]
},
"tools": {
"enabled": false,
"defaultTool": "solution"
}
},
Feedback
Was this page helpful? Yes No
There might be times when you want to exclude (or hide) your extension or tool from
the available tools list. For example, if your tool targets only Windows Server 2016 (not
older versions), you might not want a user who connects to a Windows Server 2012 R2
server to see your tool at all. (Imagine the user experience - they click on it, wait for the
tool to load, only to get a message that its features aren't available for their connection.)
You can define when to show (or hide) your feature in the tool's [Link] file.
localhost
inventory (an array of properties)
script
LocalHost
The localHost property of the Conditions object contains a boolean value that can be
evaluated to infer if the connecting node is localHost (the same computer that Windows
Admin Center is installed on) or not. By passing a value to the property, you indicate
when (the condition) to display the tool. For example if you only want the tool to display
if the user is in fact connecting to the local host, set it up like this:
JSON
"conditions": [
{
"localhost": true
}]
Alternatively, if you only want your tool to display when the connecting node is not
localhost:
JSON
"conditions": [
{
"localhost": false
}]
Here's what the configuration settings look like to only show a tool when the connecting
node is not localhost:
JSON
"entryPoints": [
{
"entryPointType": "tool",
"name": "main",
"urlName": "processes",
"displayName": "resources:strings:displayName",
"description": "resources:strings:description",
"icon": "sme-icon:icon-win-serverProcesses",
"path": "",
"requirements": [
{
"solutionIds": [
"[Link]-manager!windowsClients"
],
"connectionTypes": [
"[Link]-client"
],
"conditions": [
{
"localhost": true
}
]
}
]
}
Inventory properties
The SDK includes a pre-curated set of inventory properties that you can use to build
conditions to determine when your tool should be available or not. There are nine
different properties in the 'inventory' array:
ノ Expand table
computerManufacturer string
operatingSystemSKU number
Property Name Expected Value Type
productType number
clusterFqdn string
isHyperVRoleInstalled boolean
isHyperVPowershellInstalled boolean
isManagementToolsAvailable boolean
isWmfInstalled boolean
Every object in the inventory array must conform to the following json structure:
JSON
"<property name>": {
"type": "<expected type>",
"operator": "<defined operator to use>",
"value": "<expected value to evaluate using the operator>"
}
Operator values
ノ Expand table
Operator Description
gt greater than
lt less than
eq equal to
ne not equal to
Data types
Available options for the 'type' property:
ノ Expand table
Type Description
Value types
The 'value' property accepts these types:
string
number
boolean
JSON
"entryPoints": [
{
"entryPointType": "tool",
"name": "main",
"urlName": "processes",
"displayName": "resources:strings:displayName",
"description": "resources:strings:description",
"icon": "sme-icon:icon-win-serverProcesses",
"path": "",
"requirements": [
{
"solutionIds": [
"[Link]-manager!servers"
],
"connectionTypes": [
"[Link]"
],
"conditions": [
{
"inventory": {
"operatingSystemVersion": {
"type": "version",
"operator": "gt",
"value": "6.3"
},
"operatingSystemSKU": {
"type": "number",
"operator": "eq",
"value": "8"
}
}
}
]
}
]
}
Script
Finally, you can run a custom PowerShell script to identify the availability and state of
the node. All scripts must return an object with the following structure:
ps
@{
State = 'Available' | 'NotSupported' | 'NotConfigured';
Message = '<Message to explain the reason of state such as not supported
and not configured.>';
Properties =
@{ Name = 'Prop1'; Value = 'prop1 data'; Type = 'string' },
@{Name='Prop2'; Value = 12345678; Type='number'; };
}
The State property is the important value that will control the decision to show or hide
your extension in the tools list. The allowed values are:
ノ Expand table
Value Description
NotConfigured This is a placeholder value for future work that will prompt the user for
additional configuration before the tool is made available. Currently this value
will result in the tool being displayed and is the functional equivalent to
'Available'.
For example, if we want a tool to load only if the remote server has BitLocker installed,
the script looks like this:
ps
$response = @{
State = 'NotSupported';
Message = 'Not executed';
Properties = @{ Name = 'Prop1'; Value = 'prop1 data'; Type = 'string' },
@{Name='Prop2'; Value = 12345678; Type='number'; };
}
if($isGood) {
$[Link] = 'Available';
$[Link] = 'Everything should work.';
}
$response
An entry point configuration using the script option looks like this:
JSON
"entryPoints": [
{
"entryPointType": "tool",
"name": "main",
"urlName": "processes",
"displayName": "resources:strings:displayName",
"description": "resources:strings:description",
"icon": "sme-icon:icon-win-serverProcesses",
"path": "",
"requirements": [
{
"solutionIds": [
"[Link]-manager!windowsClients"
],
"connectionTypes": [
"[Link]-client"
],
"conditions": [
{
"localhost": true,
"inventory": {
"operatingSystemVersion": {
"type": "version",
"operator": "eq",
"value": "10.0.*"
},
"operatingSystemSKU": {
"type": "number",
"operator": "eq",
"value": "4"
}
},
"script": "$response = @{ State = 'NotSupported'; Message = 'Not
executed'; Properties = @{ Name = 'Prop1'; Value = 'prop1 data'; Type =
'string' }, @{Name='Prop2'; Value = 12345678; Type='number'; }; }; if (Get-
Module -ListAvailable -Name servermanager) { Import-module servermanager;
$isInstalled = (Get-WindowsFeature -name bitlocker).Installed; $isGood =
$isInstalled; }; if($isGood) { $[Link] = 'Available';
$[Link] = 'Everything should work.'; }; $response"
}
]
}
]
}
For example, to display your tool if "scenario A" OR "scenario B" is true, define two
requirements blocks; if either is true (that is, all conditions within a requirements block
are met), the tool is displayed.
JSON
"entryPoints": [
{
"requirements": [
{
"solutionIds": [
…"scenario A"…
],
"connectionTypes": [
…"scenario A"…
],
"conditions": [
…"scenario A"…
]
},
{
"solutionIds": [
…"scenario B"…
],
"connectionTypes": [
…"scenario B"…
],
"conditions": [
…"scenario B"…
]
}
]
}
When the same property is defined with different operators, the tool is displayed as
long as the value is between the two conditions.
For example, this tool is displayed as long as the operating system is a version between
6.3.0 and 10.0.0:
JSON
"entryPoints": [
{
"entryPointType": "tool",
"name": "main",
"urlName": "processes",
"displayName": "resources:strings:displayName",
"description": "resources:strings:description",
"icon": "sme-icon:icon-win-serverProcesses",
"path": "",
"requirements": [
{
"solutionIds": [
"[Link]-manager!servers"
],
"connectionTypes": [
"[Link]"
],
"conditions": [
{
"inventory": {
"operatingSystemVersion": {
"type": "version",
"operator": "gt",
"value": "6.3.0"
},
}
},
{
"inventory": {
"operatingSystemVersion": {
"type": "version",
"operator": "lt",
"value": "10.0.0"
}
}
}
]
}
]
}
Feedback
Was this page helpful? Yes No
Let's go more in-depth into the Windows Admin Center Extensions SDK and talk about
strings and localization.
To enable localization of all strings that are rendered on the presentation layer, take
advantage of the [Link] file under /src/resources/strings - it's already set up.
When you need to add a new string to your extension, add it to this resjson file as a new
entry. The existing structure follows this format:
ts
You can use any format you like for the strings, but be aware that the generation
process (the process that takes the resjson and outputs the usable TypeScript class)
converts underscore (_) to periods (.).
ts
ts
[Link]<Strings>().[Link];
are:
ノ Expand table
Language Folder
Čeština cs-CZ
Deutsch de-DE
English en-US
Español es-ES
Français fr-FR
Magyar hu-HU
Italiano it-IT
日本語 ja-JP
한국어 ko-KR
Nederlands nl-NL
Polski pl-PL
Русский ru-RU
Svenska sv-SE
Türkçe tr-TR
中文(简体) zh-CN
中文(繁體) zh-TW
7 Note
If your file structure needs are different inside of loc/output, you will need to adjust
the localeOffset for the gulp task ‘generate-resjson-json-localized' that is in the
[Link]. This offset is how deep into the loc folder it should start searching for
[Link] files.
Each [Link] file will be formatted in the same way as previously mentioned at
the top of this guide.
For example, to include a localization for Español include this entry in
\loc\output\HelloWorld\es-ES\[Link] :
JSON
Anytime that you added localized strings, gulp generate must be ran again in order to
have them appear. Run:
gulp generate
if you switch the language option in Windows Admin Center, you will be able to see the
localized strings in your extension.
Feedback
Was this page helpful? Yes No
This topic describes the general approach to writing user interface (UI) text for the
Windows Admin Center, as well as some specific conventions and approaches we're
taking.
Windows Admin Center and any extensions should follow Microsoft's voice principles so
that the experience is easy to use and friendly. This style guide builds on these voice
principles as well as the Microsoft Writing Style Guide, so make sure to check out both
of those resources for info on such things as accessibility, acronyms, and word choice
such as please, and sorry.
Buttons
Buttons should be one word whenever possible, especially if you plan to localize
your tool. Two or three is OK but try to avoid longer. If you have four words or
longer, it'd be better to use a link control.
If a button follows a question, its label should correspond clearly to the question
(typically "Yes" or "No").
ノ Expand table
Button Use
Capitalization
We follow the Microsoft style for Capitalization - use sentence-style capitalization for
pretty much everything.
ノ Expand table
Everything else Sentence-style However, there are a few exceptions where we surface object
properties from WMI or PowerShell that's outside of our
control.
Colons
Use colons to introduce lists. For example:
Cats
Dogs
Quokkas
Don't use colons in UI text when a label is on a different line from the thing it labels or
when there's a clear distinction between the label and the thing it's labeling.
Use colons in UI text when a label is on the same line as the text it labels and you need
to keep the two elements from running together.
Confirmation messages
Confirmation dialogs are useful when continuing might have unexpected results, such as
data loss. They should contain scannable, useful info with a clear outcome, especially for
events that can't be reversed.
Make sure a confirmation is necessary. If there's no new info to offer (for example,
“Are you sure?”) then a confirmation message may not be necessary.
Verify that the customer wants to proceed with the action.
Make sure the main instruction (heading) and explanatory text (body) aren't
redundant.
In the heading, define the possible outcomes as a question or a statement about
what will happen next. For example, “Erase all data on this drive? or “You're about
to erase all your data”.
Add details in the body. If there's a variable, such as the name of the item you're
about change, include it here.
Include a simple question (either in the header or in the body) that frames a clear
choice between two action buttons.
For a complex choice, use Yes/No buttons, which encourage careful reading. For a
simpler choice, use buttons that are specific to the action, such as Delete all or
Cancel.
First-run experiences
The first time a user visits a page, you have an opportunity to help them get started with
your tool. This could be:
A text string in an empty page with short instructions on how to get started - for
example, "Select 'Add' to add an app."
A link to the control that gets the user started - for example, "Add an app to get
started."
A small and short animation or video showing the user how to get started
1. Be helpful
Avoid marketing style and language.
When you demo or suggest something, make sure the end result is clear; just
showing the customer how to do something isn't effective if they don't know why
they are doing it.
Don't present tips if the customer doesn't need them.
3. Don't overwhelm
Limit pop-ups and tips to 4 per usage session combined—including system
notifications and shell notifications.
Make sure the timing of pop-ups is helpful.
Don't prevent the customer from doing something.
Make sure pop-ups are easily dismissed.
4. Keep it contextual
Teaching moments are most effective when presented at the right time.
If you create tutorials or slideshows, keep the info concrete.
No marketing “fluff”—focus on specific tips and tricks.
Provide a way for customers to return to the tutorial later, if relevant (people often
don't retain info the first time, but setup instructions might only be relevant once).
Empty-state messaging is a natural place for learning and/or delight—keep it
simple and informative.
Help links
Here are some tips from our Windows style guide:
There's an obvious and important question that customers are likely to have while
they're in the UI the answer to which will help them succeed at the UI task.
There's not enough room in the UI to provide the amount of information necessary
for users to succeed at the UI task.
Microsoft developers should use an FWLink except when it's a help link that users might
have to manually type, in which case use an [Link] link (as long as the target of the URL
is a website that automatically recognizes the browser locale, such as
[Link] ).
Text guidelines
Use full sentences.
Do not include ending punctuation except for question marks.
You don't need to use the same text as the task title; use text that makes sense in
the context of the UI, but make sure that there's a logical connection between the
two. For example:
Help link: What are the risks of allowing exceptions?
Help topic title: "Allowing a program to communicate through Windows
Firewall"
Be as specific as possible about the content of the help topic.
Our style
How does Windows Firewall help protect my computer?
Why highlights can improve a picture
Not our style
More information about Windows Firewall
Learn more about color management
Learn more
Use the entire sentence for the link text, not just the key words.
Our style
What are the risks of allowing exceptions?
Not our style
What are the risks of allowing exceptions?
In some cases, it's OK to use a "Learn more" link if the context is clear what the
user will be getting when they click the link.
Error messages
Here's some guidance adapted from the Windows Style Guide:
Writing a good message is a balance between providing enough explanation but not
being overly technical; between being casual and personable but not annoying or
offensive.
General guidelines
Use one message per error case.
Headings
Keep it brief and explain concisely what the problem is or ideally what to do.
Some UI surfaces may have headings that truncate instead of wrapping when
they're too long, so keep an eye out for these.
Use the solution in the heading if it's a simple step.
Make sure that the heading relates directly to the button in case the reader
ignores the body text.
Avoid using "There was a problem" in headings, unless you have no other choice.
Be more specific about the problem.
Avoid using variables (such as file, folder, and app names) in headings. Put them in
the body.
Body
If the heading sufficiently explains the problem or solution, you don't need body
text.
Don't repeat the title in the message with slightly different wording.
If there is an error code associated with the error and if you think that including
the error code might help the customer or Microsoft support to research the issue,
include it directly below the body text and write it as follows:
If the customer has all the info necessary to resolve the error without the code, you
don't need to include it.
Buttons
Write button text so that it's a specific response to the main instruction. If that's
not possible, use "Close" for the dismissal button text (instead of "Okay" or
"Done").
If you have more than one button, make the leftmost button the action the user is
encouraged to take. Make the rightmost button the more conservative action, such
as "Cancel."
Help links
Only consider Help links for error messages that you can't make specific and actionable.
Null state occurs when customer data or content is absent from an app or feature, when
no results are returned after a search, or when required information is missing from a
form, such as billing information for a transaction.
Guidelines
If possible, use null state situations as an opportunity to educate people about
how to use the feature (for example, how to add music, where to find pictures, etc.)
If you have a title in your UI, explain the action to take to “fix” the null state (for
example, “Add some music”)
Have fun with the text. This space can be an opportunity to provide delight
since it will probably not be seen several times.
Avoid “It's lonely in here.” This is sad and has been overused.
Avoid questions like “Haven't connected your printer?” Okay to use once, but
this format tends to get overused, and questions put extra burden/pressure on
the customer. It can also feel condescending.
Variety in null state text is a good thing.
Examples
"Add someone as a favorite, and you'll see them here."
"Got any achievements or game clips you're particularly proud of? Add them to
your showcase."
"No one's in a party yet. Start one up!"
"When someone adds you as a friend, you'll see them here."
"When you do stuff like unlock achievements, record game clips, and add friends,
you'll see it all here."
"Your favorite friends will show up here, so you can see when they're online and
what they're up to."
Punctuation
No ending punctuation (periods, question marks) for headings or incomplete
sentences. An exception is in a confirmation dialog where the heading asks the
question
Use Microsoft Style Guide's guidance on periods and question marks.
Status messages
Status messages consist of pop-up (toast) messages and notifications.
ノ Expand table
Toast Sentence case with ending punctuation - ideally with an object variable so
users can understand what object the message applies to in case they've
navigated away from the object
Notification Sentence case without ending punctuation (it's a heading) - ideally with an
heading (title) object variable
Notification Full sentences, ideally with a link to the UI that displays the object
details
ノ Expand table
String Notes
type
Started Omit when possible - usually you can just skip to the in-progress message to
minimize the number of distractions.
In Start with the verb of the action you're performing and end with ellipses to indicate
progress an ongoing operation. Here's an example:
Creating the volume 'Customer data'...
String Notes
type
Success Start with "Successfully" and end with what the software just did. Here's an example:
Successfully created the volume 'Customer data'.
Failure Start with "Couldn't" and end with what the software couldn't do. Here's an example:
Couldn't create the volume 'Customer data'.
Tooltips
Good tooltips briefly describe unlabeled controls or provide a bit of additional info for
labeled controls, when this is useful. They can also help customers navigate the UI by
offering additional—not redundant—information about control labels, icons, links, etc.
Tooltips should be used sparingly or not at all. They can be an interruption to the
customer, so don't include a tooltip that simply repeats a label or states the obvious. It
should always add valuable info.
ノ Expand table
When a control or UI element is Use a simple, descriptive noun phrase. For example:
unlabeled... Highlighting pen
When a UI element is labeled, Briefly describe what you can do with this UI element.
but its purpose needs Use the imperative verb form. For example, "Find text in
clarification… this file" (not "Finds text in this file").
Don't include end punctuation unless there are multiple
complete sentences.
When a text label is truncated Provide the untruncated label in the tooltip.
or likely to truncate in some Optional: On another line, provide a clarifying
languages… description, but only if needed.
Don't provide a tooltip if the untruncated info is
provided elsewhere on the page or flow.
keyboard shortcut.
Feedback
Was this page helpful? Yes No
Let's go more in-depth into the Windows Admin Center Extensions SDK - let's talk about
adding PowerShell commands to your extension.
PowerShell in TypeScript
The gulp build process has a generate step that will take any {!ScriptName}.ps1 that is
placed in the \src\resources\scripts folder and build them into the powershell-
scripts class under the \src\generated folder.
7 Note
Don't manually update the [Link] nor the [Link] files. Any
change you make will be overwritten on the next generate.
) Important
Any changes make in a {!ScriptName}.ps1 file will not be reflected in your project
until gulp generate has been run.
The API works by first creating a PowerShell session on the nodes you are targeting,
creating the PowerShell script with any parameters that need to be passed in, and then
running the script on the sessions that were created.
ps1
Param
(
[String] $stringFormat
)
$nodeName = [string]::Format($stringFormat,$env:COMPUTERNAME)
Write-Output $nodeName
ts
const session =
[Link]('{!TargetNode}');
ts
ts
Now we will need to subscribe to the observable function we just created. Place this
where you need to call the function to run the PowerShell script:
ts
[Link]().subscribe(
response => {
[Link](response)
}
);
By providing the node name to the createSession method, a new PowerShell session is
created, used, and then immediately destroyed upon completion of the PowerShell call.
Key Options
A few options are available when calling the PowerShell API. Each time a session is
created it can be created with or without a key.
Key: This creates a keyed session that can be looked up and reused, even across
components (meaning that Component 1 can create a session with key "SME-ROCKS,"
and Component 2 can use that same session). If a key is provided, the session that is
created must be disposed of by calling dispose() as was done in the example above. A
session should not be kept without being disposed of for more than 5 minutes.
ts
const session =
[Link]('{!TargetNode}', '{!Key}');
Keyless: A key will automatically be created for the session. This session with be
disposed of automatically after 3 minutes. Using keyless allows your extension to recycle
the use of any runspace that is already available at the time of creation of a session. If
no runspace is available then a new one will be created. This functionality is good for
one-off calls, but repeated use can affect performance. A session takes approximately 1
second to create, so continuously recycling sessions can cause slowdowns.
ts
const session =
[Link]('{!TargetNodeName}');
or
ts
const session =
[Link]('{!TargetNodeName}'
);
In most situations, create a keyed session in the ngOnInit() method, and then dispose
of it in ngOnDestroy() . Follow this pattern when there are multiple PowerShell scripts in
a component but the underlying session IS NOT shared across components. For best
results, make sure session creation is managed inside of components rather than
services - this helps ensure that lifetime and cleanup can be managed properly.
For best results, make sure session creation is managed inside of components rather
than services - this helps ensure that lifetime and cleanup can be managed properly.
PowerShell Stream
If you have a long running script and data is outputted progressively, a PowerShell
stream will allow you to process the data without having to wait for the script to finish.
The observable next() will be called as soon as data is received.
ts
[Link](session, script);
ts
//success notification
successTitle: 'Successfully executed a long running script!',
successMessage: '{{objectName}} was successful',
successLinkText: 'Bing',
successLink: '[Link]
successLinkType: [Link],
//error notification
errorTitle: 'Failed to execute long running script',
errorMessage: 'Error: {{ message }}'
nodeRequestOptions: {
logAudit: true,
logTelemetry: true
}
};
7 Note
For progress to be shown, Write-Progress must be included in the script that you
have written. For example:
ps1
WorkItem Options
ノ Expand table
function Explanation
submitAndWait() Submit the work item and wait for the completion of its execution
find() Find and existing work item by the TargetNodeName, ModuleName, or typeId.
ts
PowerShellBatch options
ノ Expand table
option Explanation
runSingleCommand Run a single command against all the nodes in the array
Feedback
Was this page helpful? Yes No
The extension discovery banner feature was introduced in the Windows Admin Center
Preview 1903 release. This feature allows an extension to declare the server hardware
manufacturer and models it supports, and when a user connects to a server or cluster
for which an extension is available, a notification banner will be displayed to easily install
the extension. Extension developers will be able to get more visibility for their
extensions and users will be able to easily discover more management capabilities for
their servers.
Example
Let's say I've developed an extension that supports servers from a company named
Contoso Inc., with model name R3xx and R4xx.
1. The tag for the manufacturer would be "Manufacturer_/Contoso Inc./" . The tag for
the models could be "Model_/^R[34][0-9]{2}$/" . Depending on how strictly you
want to define the matching condition, there will be different ways to define your
regular expression. You can also separate the Manufacturer or Model tags into
multiple tags, for example, the Model tag could also be "Model_/R3../
Model_/R4../" .
2. You can test the regular expression with your web browser's DevTools Console. In
Edge or Chrome, hit F12 to open the DevTools window, and in the Console tab,
type the following and hit Enter:
JavaScript
Then if you type and run the following, it will return 'true'.
JavaScript
[Link]('R300')
JavaScript
[Link]('R500')
3. Once you've verified the regular expression, you can encode it in the DevTools
Console as well, using the following Javascript method:
JavaScript
encodeURI(/^R[34][0-9]{2}$/)
The final format of the tag string to add to your .nuspec file would be:
<tags>Manufacturer_/Contoso%20Inc./ Model_/%5ER%5B34%5D%5B0-
9%5D%7B2%7D$/</tags>
Tip
We understand that a hardware manufacturer may have a very wide range of model
names of which some may be supported while some are not. Keep in mind that this
feature is meant to help with the discovery of your extension, but it does not have
to be a perfectly up-to-date inventory of all your models. You can define your
regular expression to be a simpler expression that matches a subset of your
models. A user might not see the discovery banner if they first connect to a server
model that doesn't match the condition, but sooner or later they will connect to
another server that does and will discover and install the extension. You can also
consider defining a simple regular expression that only matches your manufacturer
name. In some cases, your extension may not actually support a specific model, but
you can use the dynamic tool display feature to define a custom PowerShell script
to check model support and only show your extension when applicable, or provide
limited functionality in your extension for models that don't support all capabilities.
Feedback
Was this page helpful? Yes No
Windows Admin Center is upgrading to Angular 11.0! This upgrade brings in the latest
in features, security, and performance, and we're excited to have it available for you. So
far, the shell of Windows Admin Center has been upgraded and it is your turn to update
your extensions. Follow the steps in this document to get your extension updated.
If you run into any issues during this process, reach out to your Microsoft contact and
they'll assist you in routing the request.
Preliminary steps
Before beginning the upgrade to Angular 11, you need to configure your developer
environment with the latest Windows Admin Center shell and development tools.
Complete the following steps before proceeding to the upgrade process:
1. Install the latest version of Windows Admin Center in dev mode ( msiexec /i
WindowsAdminCenter<version>.msi DEV_MODE=1 ) with the upgraded shell. Reach out
1. At the root level of the repo, run wac upgrade --audit=false --experimental .
3. Open [Link] and change any appRoutes that have the format
./folder-name/file-name#ModuleClass to () => import('./folder-name/file-
4. Remove [Link] file. It's autogenerated for your reference but doesn't
need to go in the repo.
5. Go through the following files and replace all instances of @msft-sme with
@microsoft/windows-admin-center-sdk :
./[Link]
./[Link]/common/[Link]
./[Link]/common/[Link]
./src/[Link]
./src/[Link]
6. There will likely be unresolved errors as a result of the steps you've completed.
Proceed to Build steps.
Build steps
At this point in the upgrade process, your extension repo is ready to be built and the
debugging process can begin. Proceed through the following steps:
This error occurs during the inlineCompile step of "gulp build" and occurs as the
result of a mismatch in versions between the @types/jasmine package
downloaded and what the @types/jasminewd2 package requires. This error can
be resolved by removing the @types/jasminewd2 package.
Output hashing must be enabled. When output hashing is enabled, unique file
names will be generated for every build of the extension. If this is not enabled, you
may be unable to see the changes to your extension when viewing in the browser
due to duplicate file names.
To enable from this field the command line, add the --output-hashing flag to an
ng build command.
To enable this field from your repo directly, navigate to your [Link] file
and look for the outputHashing field under production configurations.
Named chunks must be disabled. When named chunks are enabled, each bundle
file includes its original module file name. While that may seem useful, it often
results in incredibly long file names that can result in errors in the Windows Admin
Center extension feed.
To disable this field from the command line, add the --named-chunks flag to an
ng build command.
To disable this field from your repo directly, navigate to your [Link] file
and look for the namedChunks field under production configurations. Set this
field to false.
Run steps
Now that you've fixed all of the build errors in your extension, you're ready to run your
extension and fix any runtime issues. Follow the steps below to run your extension:
1. Sideload the extension with gulp serve --port <port> --prod --aot .
2. In the browser, look for any runtime issues with the extension, such as:
When you have finished these steps, proceed to Creating a main branch.
1. Ensure that you are ready to complete the upgrade process and everything is
working as expected in the feature branch.
2. Create a new branch named "main" in the repository.
3. Create a PR from the features/ng11 branch that merges into main.
4. When ready, complete the PR.
5. Congratulations, you successfully upgraded an extension!
Once installed, you can prepare your environment by running these commands:
This will set up your Node environment for development with both the new and old
versions of Angular.
The nvm list command can be used to list installed node versions.
The nvm use <version> command can be used to quickly switch between node versions.
You can find a full index list of which Node, Angular, and Typescript versions go together
here: Node - Angular compatibility index .
7 Note
All version numbers in this document are specific to the Windows Admin Center
upgrade from Angular 7 to Angular 11.
Following the process above, you will lose all global node settings including your VSTS
authentication.
To restore VSTS authentication, run this command at the root of any repo: vsts-npm-
auth -config .npmrc
Feedback
Was this page helpful? Yes No
Windows Admin Center has upgraded to Angular 15! This upgrade brings in the latest in
features, security, and performance, and we're excited to have it available for you. So far,
the shell of Windows Admin Center has been upgraded, and it's now your turn to
update your extensions.
Follow the steps in this document to get your extension updated. If you run into any
issues during this process, reach out to your Microsoft contact and they'll assist you in
routing the request.
Preliminary steps
Before beginning the upgrade to Angular 15, it's essential to ensure that your project is
using ESLint and that your environment is set up properly.
7 Note
To determine whether you're using TSLint or ESLint as the linter for your extension,
navigate to the root directory of your extension project:
If there's a file titled .[Link], you're using ESLint. Skip ahead to Configuring
your environment for upgrade.
If there's a file titled [Link], you're using TSLint. Continue on to learn how to
migrate to ESLint.
We've created a command in the SDK to help with automating the transition to ESLint.
To use it, follow these steps:
To manage your versions of Node, we suggest using Node Version Manager . Follow
the instructions to install nvm-windows on your machine. The version should be 1.1.11
or later, as older versions may not support the [Link] versions necessary for this
upgrade.
Once installed, you can prepare your environment by running these commands:
7 Note
If you want to continue to make changes in Angular 11, you'll want to use Node
12.18.3. These versions are incompatible for use at the same time, so you must
toggle your global version to run build commands in each environment.
To change your node version back to the Angular 11 configuration, you can run the
following commands:
nvm install 12.18.3
nvm use 12.18.3
npm i -g gulp-cli
npm i -g @angular/cli@11.2.13
npm i -g vsts-npm-auth
npm i -g typescript@4.1.5
When toggling node versions, you may lose all global node settings, including your
VSTS authentication.
To restore VSTS authentication, run vsts-npm-auth -config .npmrc at the root of your
repository.
Before proceeding with the automatic upgrade steps, make sure your environment is set
up correctly, and you've switched to Angular 15. When you're ready to upgrade, follow
these steps:
1. Make sure you have the latest version of the WAC CLI by running npm install -g
@microsoft/windows-admin-center-sdk@latest .
After running the upgrade command, be sure to stage your changes. This command is
designed to be run multiple times if necessary.
You should now be able to run and test your extension as normal.
Troubleshooting scenarios
Some of the errors you may receive while debugging in the build step may be hard to
diagnose. Here's some of the most common errors and how to mitigate them:
AjaxResponse requires 1 type argument
To fix this issue, try staging your current changes and then rerun the upgrade
command. The upgrade command should've fixed this, but there might be edge
cases. Ensure you manually fix these errors by changing AjaxResponse to
AjaxResponse<any> .
To fix this issue, try staging your current changes and then rerun the upgrade
command. The upgrade command should automatically handle this, but if it
doesn't
Dependency warnings
Warning: C:\Branches\msft-sme-containers\node_modules\@msft-sme\event-
viewer\dist\fesm2020\[Link] depends on 'file-
saver'. CommonJS or AMD dependencies can cause optimization bailouts.
For more info see: [Link]
dependencies
Warning: C:\Branches\msft-sme-containers\node_modules\@msft-
sme\powershell-console\__ivy_ngcc__\dist\fesm2015\msft-sme-powershell-
[Link] depends on 'xterm'. CommonJS or AMD dependencies can
cause optimization bailouts.
For more info see: [Link]
dependencies
Warning: C:\Branches\msft-sme-containers\node_modules\@msft-
sme\powershell-console\__ivy_ngcc__\dist\fesm2015\msft-sme-powershell-
[Link] depends on 'xterm-addon-fit'. CommonJS or AMD
dependencies can cause optimization bailouts.
For more info see: [Link]
dependencies
Support for this management at the platform level doesn't mean extensions built for
Windows Admin Center also support the management of WDAC enforced infrastructure
by default. This guide outlines the requirements for an extension to support the
management of WDAC enforced infrastructure.
JSON
"conditions": [
{
"powerShell": {
"command": "Script-File-Name",
"module": "powerShellModuleName",
"script": "Your script text goes here."
}
}
]
The PowerShell module name already exists in your extension manifest. Its value in
the manifest and in the PowerShell field must match.
4. Identify any other places where PowerShell scripts are being created dynamically.
Creating a PowerShell script dynamically using string concatenation can allow an
attacker to inject arbitrary PowerShell script to be executed. This method can be
used to bypass limitations enforced on a remote user that is using a restricted run
space. It can also be used to achieve standard command injection against any
application that builds PowerShell scripts with user input and executes it.
PowerShell
param($UserInputVar)
$DynamicScript = "Get-ChildItem $UserInputVar"
$ScriptBlock = [ScriptBlock]::Create($DynamicScript)
Invoke-Command $ScriptBlock
PowerShell
param($UserInputVar)
[ScriptBlock]$ScriptBlock = {
Param($SafeUserInput)
Get-ChildItem $ SafeUserInput
}
Invoke-Command -ScriptBlock $ScriptBlock -ArgumentList @($UserInputVar)
# OR, alternatively
param($UserInputVar)
Invoke-Command -ScriptBlock {
param(
[String] $SafeUserInput
)
Get-ChildItem $SafeUserInput
} -ArgumentList $UserInputVar
Script files should also not be constructed using string concatenation. Here's an example
of how not to construct script files:
PowerShell
$Script=@'
Get-ChildItem $UserInputVar
'@
$Script = '$ UserInputVar =' + "'$ UserInputVar;"+$Script
$path = “C:\temp”
$Script | Out-File $path
PowerShell
Function test {
param(
[String] $userInputVar
)
Get-ChildItem $UserInputVar
}
$path = “C:\temp”
(Get-Command test).ScriptBlock | Set-Content -path $path
To make this change, it's highly recommended to create a build pipeline that
incorporates PowerShell signing.
You can validate that your PowerShell is in the proper format in one of two ways:
1. When your extension is installed, you can view the ProgramData\Server Management
Experience\UX\modules directory on your gateway machine (the one on which
Windows Admin Center is running). Here you should see the powershell-module
folder and the signed PowerShell module(s)
2. Extract the contents of your extension’s .nupkg artifact. The powershell-module
folder should be present and contain the signed PowerShell module(s).
In both cases, verifying that the .psd1 and .psm1 files themselves are signed can be
done by running the Get-AuthenticodeSignature command on the file, or by right-
clicking the file itself and validating the digital signature.
To mitigate this behavior, use the powerShellCommand property, along with the
createCommand method, to form a valid command object.
ts
ts
1. If your script files are exported using PowerShell modules, they must explicitly
export the functions by name without the use of wildcard characters. This
requirement is to prevent inadvertently exposing helper functions that may not be
meant to be used publicly.
2. Dot sourcing a script file brings all functions, variables, aliases from that script into
the current scope. This functionality blocks a trusted script from being dot sourced
into an untrusted script and exposing all its internal functions. Similarly, an
untrusted script is prevented from being dot sourced into a trusted script so that it
can't pollute the trusted scope.
3. It's recommended to avoid using the Start-Job command to run script blocks
unless that script block can already be run successfully in Constrained-Language
mode.
“This extension doesn't currently support running on machines with Windows Defender
Application Control (WDAC) enforced.”
This text is only a suggestion. If you’re unsure about the wording you’d like to use, email
the Windows Admin Center team at wacextensionrequests@[Link].
The following TypeScript sample code gives an example of how to use this method:
ts
@Component({
selector: 'default-component',
templateUrl: './[Link]',
styleUrls: ['./[Link]']
})
export class DefaultComponent implements OnInit {
wdacEnforced: boolean;
constructor(private appContextService: AppContextService) {
//
}
[Link]([Link]
eName).subscribe(
(response: PsLanguageModeResult) => {
if ([Link]() ===
PSLanguageMode[[Link]]) {
[Link] = true;
}
else {
[Link] = false;
}
}
);
}
}
Feedback
Was this page helpful? Yes No
After you've developed your extension, you'll want to publish it and make it available to
others to test or use. In this article, we introduce a few publishing options along with the
steps and requirements depending on your audience and purpose of publishing.
Publishing Options
There are three primary options for configurable package sources that Windows Admin
Center supports:
Append "(Preview)" to the end of your extension's title in the .nuspec file
Explain the limitations in your extension's description in the .nuspec file
UI Extensions
To begin the process on gathering all the content needed for a UI extension, run "gulp
build" on your tool and make sure the build is successful. This process packages all the
components together in a folder called "bundle" located in the root directory of your
extension (at the same level of the src directory). Copy this directory and all its contents
into the "NuGet Package" folder.
Gateway Plugins
Using your build infrastructure (which could be as simple as opening Visual Studio and
selecting the Build button), compile and build your plugin. Open up your build output
directory, copy the DLL or DLLs that represent your plugin and put them in a new folder
inside the "NuGet Package" directory called "package". You don't need to copy the
FeatureInterface DLL, only the DLL or DLLs that represent your code.
Here's an example .nuspec file and the list of required or recommended properties. For
the full schema, see the nuspec reference. Save the .nuspec file to your project's root
folder using a file name of your choice.
) Important
The <id> value in the .nuspec file needs to match the "name" value in your
project's [Link] file, or else your published extension won't load
successfully in Windows Admin Center.
XML
<?xml version="1.0">
<package>
<metadata>
<id>[Link]</id>
<version>1.0.0</version>
<title>Contoso Hello Extension</title>
<authors>Contoso</authors>
<owners>Contoso</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<projectUrl>[Link]
feed/package/nuget/[Link]-extension</projectUrl>
<licenseUrl>[Link]
<iconUrl>[Link]
<description>Hello World extension by Contoso</description>
<copyright>(c) Contoso. All rights reserved.</copyright>
<tags></tags>
</metadata>
<files>
<file src="bundle\**\*.*" target="ux" />
<file src="package\**\*.*" target="gateway" />
</files>
</package>
ノ Expand table
title Required for publishing to Friendly name for the package that's displayed in
the Windows Admin Center Windows Admin Center Extension Manager.
feed
iconUrl Recommended when URL for icon to display in the Extension Manager.
publishing to the Windows
Admin Center feed
projectUrl Required for publishing to URL to your extension's website. If you don't have a
the Windows Admin Center separate website, use the URL for the package
feed webpage on the NuGet feed.
licenseUrl Required for publishing to URL to your extension's end user license agreement.
the Windows Admin Center
feed
files Required These two settings set up the folder structure that
Windows Admin Center expects for UI extensions
and Gateway plugins.
7 Note
As of Windows Admin Center 2410, the packageType field has been deprecated and
should not be used. Continued use of this field may result in improper reading of
the NuGet file.
1. Download the [Link] CLI tool from the NuGet client tools website.
2. Run [Link] pack <>.nuspec file name> to create the .nupkg file.
Any Javascript files included in your extension are required to be signed with a
certificate from a trusted Certificate Authority (CA).
The extension NuGet package must also be signed to ensure the integrity of the
package. Windows Admin Center uses a Kestrel server which loads TLS/SSL certificates
by the subject name of certificate. Make sure only one certificate is installed with a
unique subject name and that the certificate is valid.
When you publish an extension to Microsoft's Windows Admin Center extension feed,
Microsoft will sign the package on top of your signature.
Tip
To verify that your package is signed properly, you can use the following command:
Prior to submitting an extension review request to Microsoft, you must send an email to
wacextensionrequest@[Link] expressing the intent to publish an extension to
the public feed. We provide you with copies of the Extension Publisher Agreement and
the Extension Participation Policy to review and acknowledge in writing.
Before releasing the initial version of your extension, we recommend that you submit an
extension review request to Microsoft at least 2-3 weeks before release. Allowing 2-3
weeks before release ensures we have sufficient time to review and for you to make any
changes to your extension if necessary. After your extension is ready to be published,
you'll need to send it to us for review. If your extension is approved, we publish it to the
feed for you. By sending Microsoft your extension package, you agree to be bound by
the terms of the Extension Publisher Agreement and the Extension Participation Policy.
Afterwards, if you want to release an update to your extension, you need to submit
another request for review. Depending on the scope of change, turnaround times for
update reviews are generally shorter.
Feedback
Was this page helpful? Yes No
BiitOps provides operational insights and data to help management and IT Operations
make informed decisions.
About BiitOps
BiitOps is a software company that provides insights through data and has
developed a software solution that works across even the most complex IT
landscapes.
BiitOps DataEngine is the core of BiitOps’ product portfolio, and it collects,
structures, and stores data, identifies changes, and presents data through a high-
performant Rest API.
BiitOps Insights translates data into knowledge through custom-made
visualizations using standard business intelligence tools.
BiitOps Integrations is a solution that integrates data from BiitOps DataEngine
directly into third-party products and solutions.
BiitOps Inventory extension requires a BiitOps DataEngine instance. Visit the BiitOps
website to schedule a free demo.
Learn more by visiting the BiitOps product site or subscribe for a free trial .
Feedback
Was this page helpful? Yes No
DataON's MUST extension for Windows Admin Center is a prime example of the value
that integrating two complementary products can deliver to customers, bringing
monitoring and management and end-to-end insight into hardware and software
together across an entire cluster in a unified experience.
“We've taken our standalone MUST visibility, monitoring, and management tool and
enabled it to work within Windows Admin Center. Customers will benefit from the
expanded capabilities that MUST provides, and the combination of MUST and
Windows Admin Center from a single console will provide the ultimate management
experience for Windows Server-based infrastructure.”
The MUST extension extends the functionality of Windows Admin Center by providing
features such as:
Disk mapping in the DataON MUST extension for Windows Admin Center
“It's great that Windows Admin Center allows for extensions such as DataON MUST so
I can use both tools within the same console, and I like how seamless that integration
is. Windows Admin Center and DataON MUST together really does allow us to be
more efficient and saves our team a ton of time. It allows us to achieve our
administrator tasks a lot quicker than what we had before."
Alert Services in the DataON MUST extension for Windows Admin Center
“MUST has been very valuable and was a big selling point. To us, it demonstrated a
commitment from DataON to support Microsoft hyper-converged infrastructure. The
inclusion of MUST with their S2D appliance is what completes the solution with
Storage Spaces Direct as a viable SAN replacement.”
Feedback
Was this page helpful? Yes No
Fujitsu saw an opportunity to easily integrate with Windows Admin Center as it provided
CIM and PowerShell interfaces that could communicate with the server-side agents. The
development team at Fujitsu was able to easily implement the CIM calls they were
familiar with to the agent and visualize the information within Windows Admin Center
using the available UI components.
Once the team became familiar with the Windows Admin Center SDK, adding UI to
expose additional hardware information was often simply a few more lines of HTML
code and they were quickly able to expand from a single tool to displaying a summary
view of hardware component health, detailed views for system event logs, driver
monitor, separate views for processor, memory, fans, power supplies, temperatures and
voltages, and even an additional tool for RAID management. Using UI controls available
in the SDK such as the tree, grid and detail pane controls enabled the team to quickly
build UI and also achieve a visual and interaction design very similar to the rest of
Windows Admin Center.
The partnership between Fujitsu and the Windows Admin Center team clearly shows the
value of integration within Windows Admin Center, enabling customers to have end-to-
end insight into server roles and services, to the operating system, and to hardware
management.
Feedback
Was this page helpful? Yes No
The solution extension included in the XClarity Integrator extension allows connecting to
a Lenovo XClarity Administrator, Lenovo rack or tower servers, or all the servers in an
entire chassis at once. Once the servers are added, you can see the overall health status
for all added nodes.
By selecting a server, you can view the server's hardware inventory, available firmware
updates, alerts, events, logs, power consumption and temperature. You can also run
operations such as Remote Control and power on/off.
The same tools are available as a tool extension when managing servers within Windows
Admin Center as well, allowing you to seamlessly switch between managing your
infrastructure software and hardware.
The tool extension for failover clusters and hyper-converged clusters provides a
dashboard displaying overall cluster hardware health status, status alerts, firmware
consistency status and report, power consumption and temperature, and fan and power
supply health status.
The solution extension and tool extensions for Windows servers and clusters provide the
rolling (cluster-aware) server update functions. This can help prevent any workload
interruption during server updates. Currently, the extensions support individual firmware
updates and compliance policy firmware updates for any Lenovo servers. They also
support best recipe firmware/driver updates for Lenovo ThinkAgile MX HCI cluster
servers.
The tool extension for hyperconverged clusters provides the disk/storage pool
management functions for Lenovo ThinkAgile MX HCI cluster servers. These functions
include the server rear/front graphic view to present server and disk status. With the
help of both the wizard and graphic view, operations like adding a disk to the storage
pool, removing a disk from the storage pool, replacing a disk, or locating a server/disk
by lighting on the server/disk location LEDs become much easier.
Feedback
Was this page helpful? Yes No
NEC provides products for businesses, ranging from terminals to network and computer
equipment, software products and service platforms, as well as integrated platforms
based on these products and services.
NEC ESMPRO is NEC's server management software to manage NEC Express5800 series
servers, and the NEC ESMPRO extension for Windows Admin Center enables showing
hardware and RAID information of NEC Express5800 series servers in Windows Admin
Center.
The NEC ESMPRO extension requires installing the NEC ESMPRO Manager as it retrieves
server hardware information through the NEC ESMPRO Manager.
The NEC ESMPRO extension has two tabs, the 'System Overview' tab and the 'System
Health' tab. In the System Overview tab, you can easily view the system's basic
information.
In the System Health tab, you can view the detailed information of individual hardware
components, such as processors, memory, power supplies, network adapters,
temperature and fan. The status and configuration for RAID systems, power
consumption and hardware event logs are also available.
The NEC ESMPRO extension for Windows Admin Center brings new experiences of
server management to server administrators with the collaboration of NEC's hardware
technology and Microsoft's software technology.
Feedback
Was this page helpful? Yes No
Early on, when Windows Admin Center was known as “Project Honolulu”, Pure saw the
value of being able to provide customers and partners the ability to manage multiple
Pure Storage FlashArrays from the single pane of glass that Windows Admin Center
provides.
When Pure started researching the use case with “Project Honolulu” they immediately
realized the potential for providing a unified management experience between
Windows Admin Center and FlashArray. Pure closely collaborated with the Windows
Admin Center engineering team, which helped define the implementation details for the
features. Pure was also able to provide feedback at the early stages of Windows Admin
Center and make contributions to the Microsoft team.
“We have integrated a feature set that mimics our FlashArray web interface to enable
direct management from within Windows Admin Center. Our customers and partners
will benefit from a single pane of glass versus needing to work with two different
management tools. In addition to the single point of management benefits customers
will be able to contextually manage Windows Servers that are connected to the
FlashArray.”
The features that are included in the Pure Storage Solution Extension include:
A demonstration video has been created that shows all of the features that the Pure
Storage Solution Extension provides.
The below screenshot illustrates viewing what disks (volumes) are connected to a
specific Windows Server host. In addition to viewing the connectivity detail, we check if
Multipath-IO is configured.
In addition to viewing the disks, new volumes can be created and immediately mounted
to the host without having to use Windows Disk Management tool.
Since releasing our Technical Preview, the customer feedback collected so far has been
very positive and has also provided us insight into different features to add in future
releases.
Additional resources:
Feedback
Was this page helpful? Yes No
Driven by customer pain points around existing monitoring and management, QCT
provides exclusive, complementary features and functions, which includes an overview
of system event logs, monitoring drivers, and hardware component health to enhance
the overall management experience.
The QCT Management Suite extends the functionality of Windows Admin Center with
the key features below:
Easy-to-use monitoring tool for hardware event log and health status.
Predictive disk management - Evaluate the system condition with S.M.A.R.T
information and unhealthy notifications which allow organizations to take action
before total failure occurs.
Learn more about the QCT Management Suite for Windows Admin Center:
Feedback
Was this page helpful? Yes No
Provide product feedback
[Link] Extension
Article • 12/23/2021 • Applies to: ✅ Windows Admin Center, ✅ Windows Admin Center Preview
The extension provides intuitive access to information typically needed for first-level
service and support calls, such as serial numbers, software versions, storage utilization
and more. It is designed to be useful to admins who have no prior experience with
Windows Server hyper-converged infrastructure.
Use the dashboard to determine the cluster's health status and important system
information such as serial numbers, model, OS version and utilization. Additionally, fan,
NIC and overall node hardware health are displayed on the dashboard as well.
You can drill down into storage devices to view serial numbers, SMART-status, and
capacity utilization. Boot devices also show wear out indicators, reallocated sectors and
power on time, which are the best indicators of SSD health.
The cluster status icon expands to show a summary of the cluster's operational details.
After this Micro-Cluster's Azure cloud witness was unavailable for a whole night, one
glance is enough to identify the problem. Clicking on “Notifications” immediately lists
relevant events for quick remediation. Cluster events are localized and determined by
the base OS language. The extension itself supports English and German.
Thomas-Krenn immediately realized that usability and accessibility for untrained admins
would be key to a great customer experience for hyper-converged infrastructure in the
small and mid-sized business market. Thomas-Krenn's Micro-Cluster extension perfectly
complements Windows Admin Center's native HCI management capabilities by
including proprietary hardware information on the dashboard and re-grouping
important cluster health information in a new, human-friendly interface.
During the development process it was decided to deploy Windows Admin Center 1904
in a high-availability configuration on the cluster itself, ensuring manageability even
after node failures. The extension comes pre-installed, just as the entire OS.
The extension was built in parallel with Windows Admin Center 1904 being developed at
Microsoft. Close cooperation and continuous feedback exposed issues on both sides
that were jointly resolved before the product successfully launched in April 2019.
Thomas-Krenn is incredibly proud to be one of the first to fully support and implement
Windows Admin Center 1904's new features.
Feedback
Was this page helpful? Yes No