New-NCAzEnvironment
The New-NCAzEnvironment cmdlet provisions a new NCache environment on Azure. It deploys virtual machines preconfigured with NCache, based on your specified parameters.
Note
You cannot operate on multiple environments simultaneously.
Upon successful execution, the command returns details of the provisioned environment, such as your DashboardNameLinks, VmName, PrivateIp, PublicIp (if applicable), ManagementLink (if public ip enabled), Password, UserName, and EnvironmentLink.
Note
These VMs will also be visible as part of your Azure resources.
New-NCAzEnvironment -Plan -Name -FirstName -LastName -CompanyName -Email -EvalKey -Region [-VMCount] [-Version] [-Password] [-LicenseKey] [-OS] [-Zone] [-User] [-Edition] [-NoPublicIp] [-WhiteListIps] [-PublicIpOps] [-LicenseDuration] [-InstallNCacheDir] [-ImageId] [-EnableDetailMonitoring] [-VNetName] [-SubnetName] [-SetupPath] [-ExistingResourceGroup] [-Cidr] [-PublicIpOp]
Examples
- This command a flexible NCache Environment called "Production", with 2 VMs ("NC-Server-1", "NC-Server-2"), their public IPs, and installs NCache for evaluation using the following command:
New-NCAzEnvironment -Name Production -Plan ENT-16/4 -Email john_smith@alachisoft.com -EvalKey XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -OS Windows-2025 -Region EASTUS -Zone ZONE1
- This command a licensed NCache Environment called "Production", with 2 VMs, their public IPs, and installs NCache using the following command:
New-NCAzEnvironment -Name Production -Plan ENT-16/4 -Email john_smith@alachisoft.com -LicenseKey XXXXXXXX-XXXXXX-XXXXXXXX -LicenseDuration Standard -OS Windows-2025 -Region EASTUS -Zone ZONE1
- This command a flexible NCache Environment called "Production", without any public IPs.
New-NCAzEnvironment -Name Production -Plan ENT-16/4 -Email john_smith@alachisoft.com -EvalKey XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -OS Windows-2025 -Region EASTUS -Zone ZONE1 -NoPublicIp
- This command a flexible NCache Environment called "Production" for evaluation with detailed monitoring using the following command:
New-NCAzEnvironment -Name Production -Plan ENT-16/4 -Email john_smith@alachisoft.com -EvalKey XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -OS Windows-2025 -Region EASTUS -Zone ZONE1 -EnableDetailMonitoring
Note
You can learn more about the Server Profiles available to you from the NCache Azure and AWS pricing pages.
Properties
Note
The parameters with an asterisk (*) are required. All others are optional.
| Parameter | Data Type | Description | Default Value |
|---|---|---|---|
-Name* |
<String> |
The name for the environment being created. | - |
-Plan* |
<String> |
Specifies the server profile (e.g., ENT-1/1 or ENT-256/64) that determines your vCPU-to-RAM ratio. | - |
-Email* |
<String> |
Email address of the user. | - |
-FirstName* |
<String> |
First name of the user. | - |
-LastName* |
<String> |
Last name of the user. | - |
-CompanyName* |
<String> |
Company name to register the environment under. | - |
-EvalKey* |
<String> |
Evaluation license key to provision a trial environment. | - |
-VmCount |
<Int> |
Number of VMs to deploy. Minimum: 2, Maximum: 15. | - |
-Region |
<String> |
Azure region where the environment will be deployed (e.g., EASTUS). | - |
-Version* |
<String> |
Version of NCache to install (e.g., 5.3.6). | 5.3.6 |
-Password |
<SecureString> |
Password for the admin user. | - |
-LicenseKey |
<String> |
License key obtained from Alachisoft Sales. | - |
-OS |
<String> |
Operating system for the VMs. Options: Windows or Linux. |
Windows-2025 |
-Zone |
<String> |
Specifies the availability zone (ZONE1, ZONE2, or ZONE3) depending on your selected region. | - |
-User |
<String> |
Administrator username for the deployed VMs. | ncache |
-Edition |
<String> |
Edition of NCache to deploy. Currently only Enterprise is supported. |
- |
-NoPublicIp |
<SwitchParameter> |
Indicates whether to create public IP addresses for VMs. | False |
-LicenseDuration |
<String> |
Specifies the duration of the license. Accepted values are as follows: |
Hourly |
-WhiteListIps |
<String> |
Specifies IPs allowed to access the VMs (comma-separated or CIDR format). | - |
-InstallNCacheDir |
<String> |
Directory path on the VM where the NCache should be installed. | - |
-ImageId |
<String> |
Specifies the azure image to that you want to use for the environment. | - |
-EnableDetailMonitoringe |
<SwitchParameter> |
Enables detailed monitoring on all VMs inside a environment. | False |
-VNetName |
<String> |
Specifies which virtual network to use. | - |
-SubnetName |
<String> |
Specifies which subnet to use. | - |
-SetupPath |
<String> |
Specifies the path where the setup is located. | - |
-ExistingResourceGroup |
<String> |
Specifies the which resource group to use if you don't want a new one to be created. | - |
-PublicIpOp |
SwitchParameter |
Specifies allowed operations on the public IP such as Data, Management, All, or None. | All |
-Cidr |
<String> |
CIDR block for your virtual network (e.g., 33.5.0.0/24). | 10.0.0.0/24 |
