Prepare your development environment
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.
Note
New to the Windows Admin Center SDK? Learn more about Extensions for Windows Admin Center
To prepare your development environment, perform the following steps:
Install prerequisites
To begin developing with the SDK, download and install the following prerequisites:
- Windows Admin Center (GA or preview version)
- Visual Studio or Visual Studio Code
- Node.js (download and install the .msi file for version 16.20.2)
- Node Package Manager (6.14.5 or later)
- NuGet (for publishing extensions)
To bypass signature validation which occurs during extension installation in Windows Admin Center versions running with .NET 8, you should also switch your Windows Admin Center operation mode to "Development." To configure development mode, you must:
- Open your Windows Admin Center instance's
appsettings.json
file. This can be found by default atC:\Program Files\WindowsAdminCenter\service\appsettings.json
. - Modify the
OperationMode
field under theWindowsAdminCenter/System
section to read "Development" instead of "Production."
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. WindowsAdminCenter1809.msi
.
msiexec /i WindowsAdminCenter<version>.msi DEV_MODE=1
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
Install global dependencies
Next, install or update dependencies required for your projects, with Node Package Manager. These dependencies will be installed globally, and will be available for all projects.
npm install -g @angular/cli@11.2.14
npm install -g gulp
npm install -g typescript
npm install -g tslint
npm install -g @microsoft/windows-admin-center-sdk@latest
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
SDK design toolkit
Check out our Windows Admin Center SDK design toolkit! This toolkit is designed 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!