mgmt samples, create trustedlaunch vm from galleryimage (#32264)

XiaofeiCao · web-flow · commit 69cad8cdf3d3 · 2022-11-21T14:25:38.000+08:00
* add gen2 to KnownWindowsVirtualMachineImage

* samples for creating trusted vm from azure image
diff --git a/sdk/resourcemanager/azure-resourcemanager-compute/CHANGELOG.md b/sdk/resourcemanager/azure-resourcemanager-compute/CHANGELOG.md
@@ -9,6 +9,8 @@
 - Supported `copyCompletionPercent` and `copyCompletionError` method in `Snapshot` for retrieving `CopyStart` progress.
 - Supported `withTrustedLaunch`, `withSecureBoot` and `withVTpm` methods in `VirtualMachine`.
 - Supported `UBUNTU_SERVER_18_04_LTS_GEN2`, `UBUNTU_SERVER_20_04_LTS` and `UBUNTU_SERVER_20_04_LTS_GEN2` in `KnownLinuxVirtualMachineImage`.
+- Supported `WINDOWS_SERVER_2019_DATACENTER_GEN2`, `WINDOWS_SERVER_2019_DATACENTER_WITH_CONTAINERS_GEN2`, 
+  `WINDOWS_SERVER_2016_DATACENTER_GEN2` and `WINDOWS_DESKTOP_10_21H2_PRO_GEN2` in `KnownWindowsVirtualMachineImage`.
 - Supported `withTrustedLaunch` and `withHyperVGeneration` methods in `GalleryImage`.
 
 ### Breaking Changes
diff --git a/sdk/resourcemanager/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/implementation/GalleryImageImpl.java b/sdk/resourcemanager/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/implementation/GalleryImageImpl.java
@@ -35,6 +35,8 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 /** The implementation for GalleryImage and its create and update interfaces. */
 class GalleryImageImpl extends CreatableUpdatableImpl<GalleryImage, GalleryImageInner, GalleryImageImpl>
@@ -575,10 +577,16 @@ public GalleryImageImpl withHyperVGeneration(HyperVGeneration hyperVGeneration)
 
     @Override
     public GalleryImageImpl withTrustedLaunch() {
-        ensureFeatures().add(
-            new GalleryImageFeature()
-                .withName(FEATURE_SECURITY_TYPE)
-                .withValue(SecurityTypes.TRUSTED_LAUNCH.toString()));
+        this.innerModel().withFeatures(
+            Stream.concat(
+                ensureFeatures()
+                    .stream()
+                    .filter(feature -> !FEATURE_SECURITY_TYPE.equals(feature.name())),
+                Stream.of(new GalleryImageFeature()
+                    .withName(FEATURE_SECURITY_TYPE)
+                    .withValue(SecurityTypes.TRUSTED_LAUNCH.toString()))
+            ).collect(Collectors.toList())
+        );
         return this;
     }
 
diff --git a/sdk/resourcemanager/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/models/GalleryImage.java b/sdk/resourcemanager/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/models/GalleryImage.java
@@ -83,7 +83,7 @@ public interface GalleryImage
     /** @return the hypervisor generation. */
     HyperVGeneration hyperVGeneration();
 
-    /** @return the security type, whether trusted l. */
+    /** @return the security type, whether trusted launch or confidential VM. */
     SecurityTypes securityType();
 
     /** @return the tags associated with the image. */
diff --git a/sdk/resourcemanager/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/models/KnownWindowsVirtualMachineImage.java b/sdk/resourcemanager/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/models/KnownWindowsVirtualMachineImage.java
@@ -14,7 +14,16 @@ public enum KnownWindowsVirtualMachineImage {
     /** Windows Server 2016 Data center. */
     WINDOWS_SERVER_2016_DATACENTER("MicrosoftWindowsServer", "WindowsServer", "2016-Datacenter"),
     /** Windows Server 2012 R2 Data center. */
-    WINDOWS_SERVER_2012_R2_DATACENTER("MicrosoftWindowsServer", "WindowsServer", "2012-R2-Datacenter");
+    WINDOWS_SERVER_2012_R2_DATACENTER("MicrosoftWindowsServer", "WindowsServer", "2012-R2-Datacenter"),
+    /** Windows Server 2019 Data center gen2. */
+    WINDOWS_SERVER_2019_DATACENTER_GEN2("MicrosoftWindowsServer", "WindowsServer", "2019-datacenter-gensecond"),
+    /** Windows Server 2019 Data center with containers gen2. */
+    WINDOWS_SERVER_2019_DATACENTER_WITH_CONTAINERS_GEN2(
+        "MicrosoftWindowsServer", "WindowsServer", "2019-datacenter-with-containers-g2"),
+    /** Windows Server 2016 Data center gen2. */
+    WINDOWS_SERVER_2016_DATACENTER_GEN2("MicrosoftWindowsServer", "WindowsServer", "2016-datacenter-gensecond"),
+    /** Windows 10 2021 H2 Pro gen2. */
+    WINDOWS_DESKTOP_10_21H2_PRO_GEN2("MicrosoftWindowsDesktop", "Windows-10", "win10-21h2-pro-g2");
 
     private final String publisher;
     private final String offer;
diff --git a/sdk/resourcemanager/azure-resourcemanager-samples/samples.json b/sdk/resourcemanager/azure-resourcemanager-samples/samples.json
@@ -852,6 +852,12 @@
       "filePath": "azure-resourcemanager-samples/src/main/java/com/azure/resourcemanager/compute/samples/CloneVirtualMachineToNewRegion.java",
       "githubPath": "Azure-Samples/compute-java-clone-virtual-machine-to-new-region",
       "description": "Getting started on cloning virtual machine to a new region using Java"
+    },
+    {
+      "owner": "ArthurMa1978",
+      "filePath": "azure-resourcemanager-samples/src/main/java/com/azure/resourcemanager/compute/samples/CreateVirtualMachineWithTrustedLaunchFromGalleryImage.java",
+      "githubPath": "Azure-Samples/compute-java-create-virtual-machine-with-trusted-launch-from-gallery-image",
+      "description": "Getting started on creating virtual machine with trusted launch from gallery image using Java"
     }
   ]
 }
diff --git a/sdk/resourcemanager/azure-resourcemanager-samples/src/main/java/com/azure/resourcemanager/compute/samples/CreateVirtualMachineWithTrustedLaunchFromGalleryImage.java b/sdk/resourcemanager/azure-resourcemanager-samples/src/main/java/com/azure/resourcemanager/compute/samples/CreateVirtualMachineWithTrustedLaunchFromGalleryImage.java
@@ -0,0 +1,260 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.resourcemanager.compute.samples;
+
+import com.azure.core.credential.TokenCredential;
+import com.azure.core.http.policy.HttpLogDetailLevel;
+import com.azure.core.management.AzureEnvironment;
+import com.azure.core.management.Region;
+import com.azure.core.management.profile.AzureProfile;
+import com.azure.identity.DefaultAzureCredentialBuilder;
+import com.azure.resourcemanager.AzureResourceManager;
+import com.azure.resourcemanager.compute.models.CachingTypes;
+import com.azure.resourcemanager.compute.models.Gallery;
+import com.azure.resourcemanager.compute.models.GalleryDataDiskImage;
+import com.azure.resourcemanager.compute.models.GalleryImage;
+import com.azure.resourcemanager.compute.models.GalleryImageVersion;
+import com.azure.resourcemanager.compute.models.HyperVGeneration;
+import com.azure.resourcemanager.compute.models.HyperVGenerationTypes;
+import com.azure.resourcemanager.compute.models.KnownWindowsVirtualMachineImage;
+import com.azure.resourcemanager.compute.models.OperatingSystemStateTypes;
+import com.azure.resourcemanager.compute.models.RunCommandInput;
+import com.azure.resourcemanager.compute.models.VirtualMachine;
+import com.azure.resourcemanager.compute.models.VirtualMachineCustomImage;
+import com.azure.resourcemanager.compute.models.VirtualMachineDataDisk;
+import com.azure.resourcemanager.compute.models.VirtualMachineSizeTypes;
+import com.azure.resourcemanager.resources.models.ResourceGroup;
+import com.azure.resourcemanager.samples.Utils;
+
+import java.util.Arrays;
+
+/**
+ * Azure Compute sample for creating virtual machine with TrustedLaunch from gallery image.
+ * - Create a managed virtual machine with TrustedLaunch from PIR windows image with two empty data disks
+ * - Prepare virtual machine for generalization
+ * - Deallocate virtual machine
+ * - Generalize virtual machine
+ * - Create a virtual machine custom image from the created virtual machine
+ * - Create a gallery to hold gallery images
+ * - Create a gallery image in the gallery with hypervisor generation 2 and with TrustedLaunch feature
+ * - Create a gallery image version from the virtual machine custom image
+ * - Create a virtual machine with TrustedLaunch from the gallery image version
+ */
+public class CreateVirtualMachineWithTrustedLaunchFromGalleryImage {
+    /**
+     * Main function which runs the actual sample.
+     * @param azure instance of the azure client
+     * @return true if sample runs successfully
+     */
+    public static boolean runSample(AzureResourceManager azure) {
+        final String rgName = Utils.randomResourceName(azure, "rg", 15);
+        final Region region = Region.US_WEST;
+        final String newRgName = Utils.randomResourceName(azure, "rg", 15);
+        final Region newRegion = Region.US_WEST2;
+
+        ResourceGroup resourceGroup = null;
+        ResourceGroup newResourceGroup = null;
+        try {
+            resourceGroup = azure.resourceGroups()
+                .define(rgName)
+                .withRegion(region)
+                .create();
+            newResourceGroup = azure.resourceGroups()
+                .define(newRgName)
+                .withRegion(newRegion)
+                .create();
+
+            //=============================================================
+            // Create a managed virtual machine with TrustedLaunch from PIR image with two empty data disks
+            final String trustedVmName = Utils.randomResourceName(azure, "vm", 15);
+            VirtualMachine trustedVMFromPirImage = azure
+                .virtualMachines()
+                .define(trustedVmName)
+                .withRegion(resourceGroup.region())
+                .withExistingResourceGroup(resourceGroup)
+                .withNewPrimaryNetwork("10.0.0.0/28")
+                .withPrimaryPrivateIPAddressDynamic()
+                .withoutPrimaryPublicIPAddress()
+                .withPopularWindowsImage(KnownWindowsVirtualMachineImage.WINDOWS_SERVER_2016_DATACENTER_GEN2)
+                .withAdminUsername("azureuser")
+                .withAdminPassword(Utils.password())
+                .withNewDataDisk(10)
+                .withNewDataDisk(10, 2, CachingTypes.READ_WRITE)
+                .withSize(VirtualMachineSizeTypes.STANDARD_DS1_V2)
+                // Trusted Launch options start
+                .withTrustedLaunch()
+                .withSecureBoot()
+                .withVTpm()
+                // Trusted Launch options end
+                .create();
+
+            Utils.print(trustedVMFromPirImage);
+
+            //=============================================================
+            // Prepare virtual machine for generalization
+            prepareWindowsVMForGeneralization(trustedVMFromPirImage);
+
+            //=============================================================
+            // Deallocate virtual machine
+            trustedVMFromPirImage.deallocate();
+
+            //=============================================================
+            // Generalize virtual machine
+            trustedVMFromPirImage.generalize();
+
+            //=============================================================
+            // Create a virtual machine custom image
+            final String imageName = Utils.randomResourceName(azure, "img", 20);
+            VirtualMachineCustomImage.DefinitionStages.WithCreateAndDataDiskImageOSDiskSettings creatableDisk =
+                azure.virtualMachineCustomImages()
+                    .define(imageName)
+                    .withRegion(resourceGroup.region())
+                    .withExistingResourceGroup(resourceGroup)
+                    .withHyperVGeneration(HyperVGenerationTypes.V2)
+                    .withWindowsFromDisk(trustedVMFromPirImage.osDiskId(), OperatingSystemStateTypes.GENERALIZED)
+                    .withOSDiskCaching(trustedVMFromPirImage.osDiskCachingType());
+
+            for (VirtualMachineDataDisk dataDisk : trustedVMFromPirImage.dataDisks().values()) {
+                creatableDisk.defineDataDiskImage()
+                    .withLun(dataDisk.lun())
+                    .fromManagedDisk(dataDisk.id())
+                    .withDiskCaching(dataDisk.cachingType())
+                    .withDiskSizeInGB(dataDisk.size())
+                    .attach();
+            }
+
+            VirtualMachineCustomImage customImage = creatableDisk.create();
+            Utils.print(customImage);
+
+            //=============================================================
+            // Create a gallery to hold gallery images
+            final String galleryName = Utils.randomResourceName(azure, "jsim", 15);
+            Gallery gallery = azure
+                .galleries()
+                .define(galleryName)
+                .withRegion(Region.US_WEST_CENTRAL)
+                .withExistingResourceGroup(resourceGroup)
+                .withDescription("java's image gallery")
+                .create();
+
+            //=============================================================
+            // Create a gallery image in the gallery with hypervisor generation 2 and with TrustedLaunch feature
+            final String galleryImageName = "SampleImages";
+            GalleryImage galleryImage = azure
+                .galleryImages()
+                .define(galleryImageName)
+                .withExistingGallery(gallery)
+                .withLocation(resourceGroup.region())
+                .withIdentifier("JavaSDKTeam", "JDK", "Jdk-9")
+                .withGeneralizedWindows()
+                .withHyperVGeneration(HyperVGeneration.V2)
+                .withTrustedLaunch()
+                .create();
+
+            //=============================================================
+            // Create a gallery image version from the virtual machine custom image
+            final String versionName = "0.0.1";
+            GalleryImageVersion imageVersion = azure
+                .galleryImageVersions()
+                .define(versionName)
+                .withExistingImage(resourceGroup.name(), gallery.name(), galleryImage.name())
+                .withLocation(resourceGroup.region())
+                .withSourceCustomImage(customImage)
+                .withRegionAvailability(newRegion, 1)
+                .create();
+
+            //=============================================================
+            // Create a virtual machine with TrustedLaunch from the gallery image version
+            final String vmFromImageName = Utils.randomResourceName(azure, "tlvm", 15);
+            VirtualMachine.DefinitionStages.WithManagedCreate withManagedCreate =
+                azure
+                    .virtualMachines()
+                    .define(vmFromImageName)
+                    .withRegion(newRegion)
+                    .withExistingResourceGroup(newResourceGroup)
+                    .withNewPrimaryNetwork("10.0.1.0/28")
+                    .withPrimaryPrivateIPAddressDynamic()
+                    .withoutPrimaryPublicIPAddress()
+                    .withGeneralizedWindowsGalleryImageVersion(imageVersion.id())
+                    .withAdminUsername("jvuser")
+                    .withAdminPassword(Utils.password());
+
+            for (GalleryDataDiskImage ddi : imageVersion.storageProfile().dataDiskImages()) {
+                withManagedCreate.withNewDataDiskFromImage(
+                    ddi.lun(),
+                    ddi.sizeInGB() + 1,
+                    ddi.hostCaching() == null ? null : CachingTypes.fromString(ddi.hostCaching().toString()));
+            }
+
+            VirtualMachine trustedVMFromGalleryImage = withManagedCreate
+                .withSize(VirtualMachineSizeTypes.STANDARD_DS1_V2)
+                // gallery images with 'TrustedLaunch` feature can only create VMs with 'TrustedLaunch' feature
+                .withTrustedLaunch()
+                .withSecureBoot()
+                .withVTpm()
+                .create();
+            Utils.print(trustedVMFromGalleryImage);
+
+            return true;
+        } catch (Exception e) {
+            e.printStackTrace();
+            return false;
+        } finally {
+            if (resourceGroup != null) {
+                azure.resourceGroups().beginDeleteByName(rgName);
+            }
+            if (newResourceGroup != null) {
+                azure.resourceGroups().beginDeleteByName(newRgName);
+            }
+        }
+    }
+
+    //https://learn.microsoft.com/en-us/azure/virtual-machines/generalize#windows
+    private static void prepareWindowsVMForGeneralization(VirtualMachine virtualMachine) {
+        System.out.println("Trying to de-provision");
+        virtualMachine.manager()
+            .serviceClient()
+            .getVirtualMachines()
+            .beginRunCommand(
+                virtualMachine.resourceGroupName(), virtualMachine.name(),
+                new RunCommandInput()
+                    .withCommandId("RunPowerShellScript")
+                    .withScript(Arrays.asList(
+                        "Remove-Item 'C:\\Windows\\Panther' -Recurse",
+                        "& $env:SystemRoot\\System32\\Sysprep\\Sysprep.exe /oobe /generalize /mode:vm /shutdown"
+                    )))
+            .waitForCompletion();
+        System.out.println("De-provision finished");
+    }
+
+    /**
+     * Main entry point.
+     * @param args the parameters
+     */
+    public static void main(String[] args) {
+        try {
+            //=============================================================
+            // Authenticate
+
+            final AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE);
+            final TokenCredential credential = new DefaultAzureCredentialBuilder()
+                .authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint())
+                .build();
+
+            AzureResourceManager azureResourceManager = AzureResourceManager
+                .configure()
+                .withLogLevel(HttpLogDetailLevel.BASIC)
+                .authenticate(credential, profile)
+                .withDefaultSubscription();
+
+            // Print selected subscription
+            System.out.println("Selected subscription: " + azureResourceManager.subscriptionId());
+
+            runSample(azureResourceManager);
+        } catch (Exception e) {
+            System.out.println(e.getMessage());
+            e.printStackTrace();
+        }
+    }
+}
diff --git a/sdk/resourcemanager/azure-resourcemanager-samples/src/main/java/com/azure/resourcemanager/samples/Utils.java b/sdk/resourcemanager/azure-resourcemanager-samples/src/main/java/com/azure/resourcemanager/samples/Utils.java
@@ -500,6 +500,11 @@ public static void print(VirtualMachine resource) {
         StringBuilder zones = new StringBuilder().append("\n\tZones: ");
         zones.append(resource.availabilityZones());
 
+        StringBuilder securityProfile = new StringBuilder().append("\n\tSecurityProfile: ");
+        securityProfile.append("\n\t\t\tSecurity type: ").append(resource.securityType());
+        securityProfile.append("\n\t\t\tSecure Boot enabled: ").append(resource.isSecureBootEnabled());
+        securityProfile.append("\n\t\t\tvTPM enabled: ").append(resource.isVTpmEnabled());
+
         System.out.println(new StringBuilder().append("Virtual Machine: ").append(resource.id())
                 .append("Name: ").append(resource.name())
                 .append("\n\tResource group: ").append(resource.resourceGroupName())
@@ -513,6 +518,7 @@ public static void print(VirtualMachine resource) {
                 .append(extensions)
                 .append(msi)
                 .append(zones)
+                .append(securityProfile)
                 .toString());
     }
 
diff --git a/sdk/resourcemanager/azure-resourcemanager-samples/src/test/java/com/azure/resourcemanager/samples/ComputeSampleTests.java b/sdk/resourcemanager/azure-resourcemanager-samples/src/test/java/com/azure/resourcemanager/samples/ComputeSampleTests.java
@@ -11,6 +11,7 @@
 import com.azure.resourcemanager.compute.samples.CreateVirtualMachineUsingCustomImageFromVM;
 import com.azure.resourcemanager.compute.samples.CreateVirtualMachineUsingSpecializedDiskFromSnapshot;
 import com.azure.resourcemanager.compute.samples.CreateVirtualMachineUsingSpecializedDiskFromVhd;
+import com.azure.resourcemanager.compute.samples.CreateVirtualMachineWithTrustedLaunchFromGalleryImage;
 import com.azure.resourcemanager.compute.samples.CreateVirtualMachinesAsyncTrackingRelatedResources;
 import com.azure.resourcemanager.compute.samples.CreateVirtualMachinesInParallel;
 import com.azure.resourcemanager.compute.samples.CreateVirtualMachinesUsingCustomImageOrSpecializedVHD;
@@ -198,4 +199,9 @@ public void testCreateVirtualMachineEncryptedUsingCustomerManagedKey() {
     public void testCloneVirtualMachineToNewRegion() {
         Assertions.assertTrue(CloneVirtualMachineToNewRegion.runSample(azureResourceManager));
     }
+
+    @Test
+    public void testCreateVirtualMachineWithTrustedLaunchFromGalleryImage() {
+        Assertions.assertTrue(CreateVirtualMachineWithTrustedLaunchFromGalleryImage.runSample(azureResourceManager));
+    }
 }
diff --git a/sdk/resourcemanager/azure-resourcemanager-samples/src/test/resources/session-records/ComputeSampleTests.testCreateVirtualMachineWithTrustedLaunchFromGalleryImage.json b/sdk/resourcemanager/azure-resourcemanager-samples/src/test/resources/session-records/ComputeSampleTests.testCreateVirtualMachineWithTrustedLaunchFromGalleryImage.json

Original file line number	Diff line number	Diff line change
`@@ -852,6 +852,12 @@`
`852`	`852`	`"filePath": "azure-resourcemanager-samples/src/main/java/com/azure/resourcemanager/compute/samples/CloneVirtualMachineToNewRegion.java",`
`853`	`853`	`"githubPath": "Azure-Samples/compute-java-clone-virtual-machine-to-new-region",`
`854`	`854`	`"description": "Getting started on cloning virtual machine to a new region using Java"`
	`855`	`+ },`
	`856`	`+ {`
	`857`	`+ "owner": "ArthurMa1978",`
	`858`	`+ "filePath": "azure-resourcemanager-samples/src/main/java/com/azure/resourcemanager/compute/samples/CreateVirtualMachineWithTrustedLaunchFromGalleryImage.java",`
	`859`	`+ "githubPath": "Azure-Samples/compute-java-create-virtual-machine-with-trusted-launch-from-gallery-image",`
	`860`	`+ "description": "Getting started on creating virtual machine with trusted launch from gallery image using Java"`
`855`	`861`	`}`
`856`	`862`	`]`
`857`	`863`	`}`