Add parameter for "License Type" when using an advanced image. (#533)

Author: krische

checkstyle.xml

@@ -31,7 +31,7 @@
     <!-- Checks for Size Violations.                    -->
     <!-- See http://checkstyle.sf.net/config_sizes.html -->
     <module name="FileLength">
-        <property name="max" value="2100"/>
+        <property name="max" value="2200"/>
     </module>
 
     <!-- Checks for whitespace                               -->

src/main/java/com/microsoft/azure/vmagent/AzureVMAgentTemplate.java

@@ -378,6 +378,8 @@ public int hashCode() {
 
     private int maxVirtualMachinesLimit;
 
+    private String licenseType;
+
     // deprecated fields
     private transient boolean isInstallDocker;
     private transient boolean isInstallMaven;
@@ -1365,6 +1367,15 @@ public void setMaximumDeploymentSize(int maximumDeploymentSize) {
         this.maximumDeploymentSize = maximumDeploymentSize;
     }
 
+    public String getLicenseType() {
+        return licenseType;
+    }
+
+    @DataBoundSetter
+    public void setLicenseType(String licenseType) {
+        this.licenseType = licenseType;
+    }
+
     /**
      * Provision new agents using this template.
      *
@@ -1533,6 +1544,15 @@ public ListBoxModel doFillOsTypeItems() throws IOException, ServletException {
             return model;
         }
 
+        @POST
+        public ListBoxModel doFillLicenseTypeItems() {
+            ListBoxModel model = new ListBoxModel();
+            model.add(Constants.LICENSE_TYPE_CLASSIC);
+            model.add(Constants.LICENSE_TYPE_WINDOWS_CLIENT);
+            model.add(Constants.LICENSE_TYPE_WINDOWS_SERVER);
+            return model;
+        }
+
         private String getAzureCredentialsIdFromCloud(String cloudName) {
             AzureVMCloud cloud = getAzureCloud(cloudName);
 

src/main/java/com/microsoft/azure/vmagent/AzureVMManagementServiceDelegate.java

@@ -661,6 +661,10 @@ public AzureVMDeploymentInfo createDeployment(
                 putParameter(parameters, "authenticationType", "key");
             }
 
+            if (!Constants.LICENSE_TYPE_CLASSIC.equals(template.getLicenseType())) {
+                addLicenseType(tmp, template.getLicenseType());
+            }
+
             // Register the deployment for cleanup
             deploymentRegistrar.registerDeployment(
                     cloudName, template.getResourceGroupName(), deploymentName, scriptUri);
@@ -747,6 +751,20 @@ private void addAcceleratedNetworking(JsonNode template) {
         }
     }
 
+    private void addLicenseType(JsonNode template, String licenseType) {
+        if (Constants.LICENSE_TYPE_WINDOWS_CLIENT.equals(licenseType) || Constants.LICENSE_TYPE_WINDOWS_SERVER.equals(licenseType)) {
+            ArrayNode resources = (ArrayNode) template.get("resources");
+            for (JsonNode resource : resources) {
+                String type = resource.get("type").asText();
+                if (type.contains("virtualMachine")) {
+                    ObjectNode properties = (ObjectNode) resource.get("properties");
+                    properties.put("licenseType", licenseType);
+                    return;
+                }
+            }
+        }
+    }
+
     private void injectCustomTag(JsonNode resource, List<AzureTagPair> tags) {
         ObjectNode tagsNode = (ObjectNode) resource.get("tags");
         if (tags != null) {

src/main/java/com/microsoft/azure/vmagent/util/Constants.java

@@ -87,6 +87,15 @@ public final class Constants {
 
     public static final String OS_TYPE_LINUX = "Linux";
 
+    /**
+     * Windows License Types.
+     */
+    public static final String LICENSE_TYPE_CLASSIC = "Classic";
+
+    public static final String LICENSE_TYPE_WINDOWS_CLIENT = "Windows_Client";
+
+    public static final String LICENSE_TYPE_WINDOWS_SERVER = "Windows_Server";
+
     /**
      * Usage types for template names.
      **/

src/main/resources/com/microsoft/azure/vmagent/AzureVMAgentTemplate/config.jelly

@@ -233,6 +233,10 @@
         <f:select/>
       </f:entry>
 
+      <f:entry title="${%License_Type}" field="licenseType">
+        <f:select/>
+      </f:entry>
+
       <f:dropdownDescriptorSelector
           title="${%Launch_Method}"
           field="launcher"

src/main/resources/com/microsoft/azure/vmagent/AzureVMAgentTemplate/config.properties

@@ -27,6 +27,7 @@ Advanced_Image=Use advanced image
 Custom_Image=Custom user image
 Image=Custom image URI
 Os_Type=OS type
+License_Type=License Type
 
 Pre_Installed_Tools=Pre-installed tools
 Image_Reference=Image reference

src/main/resources/com/microsoft/azure/vmagent/AzureVMAgentTemplate/help-licenseType.html

@@ -0,0 +1,8 @@
+<div>
+    For Windows agents, if you want to use <a href="https://learn.microsoft.com/en-us/azure/virtual-machines/windows/hybrid-use-benefit-licensing">Azure Hybrid Benefit</a>, then you can specify one of the following values:
+    <ul>
+        <li>Windows_Client</li>
+        <li>Windows_Server</li>
+    </ul>
+    Otherwise, leaving the value as <code>Classic</code> will not specify any license type.
+</div>