[Compute] GalleryImageVersion Powershell commands to support BlockDeletionBeforeEndOfLife parameter (#27224)

Co-authored-by: PSCmdAssistant <[email protected]>
Co-authored-by: Yash <[email protected]>

Author: 3 people

src/Compute/Compute.Test/ScenarioTests/GalleryTests.cs

@@ -1,4 +1,4 @@
-// ----------------------------------------------------------------------------------
+// ----------------------------------------------------------------------------------
 //
 // Copyright Microsoft Corporation
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -71,5 +71,12 @@ public void TestGalleryImageDefinitionDefaults()
         {
             TestRunner.RunTestScript("Test-GalleryImageDefinitionDefaults");
         }
+
+        [Fact(Skip = "Cannot test EOD as it prevents deletion")]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestGalleryBlockDeletionBeforeEndOfLife()
+        {
+            TestRunner.RunTestScript("TestGen-BlockDeletionBeforeEndOfLife");
+        }
     }
 }

src/Compute/Compute.Test/ScenarioTests/GalleryTests.ps1

@@ -990,3 +990,63 @@ function Test-GalleryImageDefinitionDefaults
     }
 }
 
+function TestGen-BlockDeletionBeforeEndOfLife
+{
+    # Setup
+    $rgname = Get-ComputeTestResourceName;
+    $galleryName = 'gallery' + $rgname;
+    $imageDefinitionName = 'imageDef' + $rgname;
+    $imageVersionName = '1.0.0';
+    $loc = "eastus2"
+    $vmname = "testvmgallery"
+
+    try
+    {
+
+        New-AzResourceGroup -Name $rgname -Location $loc -Force;
+
+        # SimpleParameterSet, no config, scenario.
+        # create credential 
+        $password = Get-PasswordForVM;
+        $user = Get-ComputeTestResourceName;
+        $securePassword = $password | ConvertTo-SecureString -AsPlainText -Force;  
+        $cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword);
+
+        # Step 1: Create a new virtual machine in Azure
+        New-AzVM -ResourceGroupName $rgname -Location $loc -Name $vmname -Credential $cred -Size "Standard_D2s_v3" -Image "Win2022AzureEdition" -SecurityType "TrustedLaunch"
+        $vm = get-azvm -ResourceGroupName $rgname -Name $vmname
+
+        # Create a gallery
+        $gallery = New-AzGallery -ResourceGroupName $rgname -Location $loc -Name $galleryName 
+
+        # Create a gallery image definition
+        $imageDef = New-AzGalleryImageDefinition -ResourceGroupName $rgname -GalleryName $galleryName -Location $loc -Name $imageDefinitionName -OsType 'Windows' -OsState 'Specialized' -Publisher 'Contoso' -Offer 'OfferName' -Sku 'SkuName' -Feature @{Name='SecurityType';Value='TrustedLaunch'}
+
+        # Test creating a gallery image version with BlockDeletionBeforeEndOfLife set to true
+        $imagever = New-AzGalleryImageVersion `
+            -GalleryImageDefinitionName $imageDef.Name `
+            -GalleryImageVersionName $imageVersionName `
+            -GalleryName $gallery.Name  `
+            -ResourceGroupName $rgname `
+            -Location $loc `
+            -SourceImageVMId $vm.Id.ToString() `
+            -PublishingProfileEndOfLifeDate '2024-12-01' `
+            -BlockDeletionBeforeEndOfLife 
+
+        Assert-AreEqual $imagever.SafetyProfile.BlockDeletionBeforeEndOfLife $True
+        
+        $imagever = Update-AzGalleryImageVersion `
+            -GalleryImageDefinitionName $imageDef.Name `
+            -GalleryImageVersionName $imageVersionName `
+            -GalleryName $gallery.Name  `
+            -ResourceGroupName $rgname `
+            -BlockDeletionBeforeEndOfLife $False
+        Assert-AreEqual $imagever.SafetyProfile.BlockDeletionBeforeEndOfLife $False
+
+    }
+    finally
+    {
+        # Cleanup
+        Remove-AzResourceGroup -Name $rgname -Force -ErrorAction SilentlyContinue;
+    }
+}

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.GalleryTests/TestGalleryBlockDeletionBeforeEndOfLife.json

@@ -20,6 +20,7 @@
 
 -->
 ## Upcoming Release
+* Added new parameter `BlockDeletionBeforeEndOfLife` parameter to `New-AzGalleryImageVersion` and `Update-AzGalleryImageVersion` cmdlets.
 * Updated `New-AzVM`, `New-AzVmss`, `Update-AzVM`, and `Update-AzVmss` to pass `Standard` as an input of `-SecurityType` parameter.
 * Added breaking change message for `Get-AzVMSize`.
 

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.GalleryTests/testgenupdateazgalleryimageversion.json

@@ -1,4 +1,4 @@
-//
+ //
 // Copyright (c) Microsoft and contributors.  All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -101,6 +101,14 @@ public override void ExecuteCmdlet()
                         }
                         galleryImageVersion.PublishingProfile.EndOfLifeDate = this.PublishingProfileEndOfLifeDate;
                     }
+                    if (this.IsParameterBound(c => c.BlockDeletionBeforeEndOfLife))
+                    {
+                        if (galleryImageVersion.SafetyProfile == null)
+                        {
+                            galleryImageVersion.SafetyProfile = new GalleryImageVersionSafetyProfile();
+                        }
+                        galleryImageVersion.SafetyProfile.BlockDeletionBeforeEndOfLife = this.BlockDeletionBeforeEndOfLife.IsPresent;
+                    }
 
                     if (this.IsParameterBound(c => c.StorageAccountType))
                     {
@@ -410,6 +418,12 @@ public override void ExecuteCmdlet()
             ValueFromPipelineByPropertyName = true,
             HelpMessage = "The target extended locations where the Image Version is going to be replicated to. This property is updatable.")]
         public Hashtable[] TargetExtendedLocation { get; set; }
+
+        [Parameter(
+            Mandatory = false,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "This boolean will be passed by the customers to enable their GalleryImageVersion resources from accidental deletions. If this boolean is set to true, the image deletions will be blocked before its EndOfLife date.")]
+        public SwitchParameter BlockDeletionBeforeEndOfLife { get; set; }
     }
 
     [Cmdlet(VerbsData.Update, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "GalleryImageVersion", DefaultParameterSetName = "DefaultParameter", SupportsShouldProcess = true)]
@@ -492,6 +506,15 @@ public override void ExecuteCmdlet()
                         galleryImageVersion.PublishingProfile.EndOfLifeDate = this.PublishingProfileEndOfLifeDate;
                     }
 
+                    if (this.IsParameterBound(c => c.BlockDeletionBeforeEndOfLife))
+                    {
+                        if (galleryImageVersion.SafetyProfile == null)
+                        {
+                            galleryImageVersion.SafetyProfile = new GalleryImageVersionSafetyProfile();
+                        }
+                        galleryImageVersion.SafetyProfile.BlockDeletionBeforeEndOfLife = this.BlockDeletionBeforeEndOfLife;
+                    }
+
                     if (this.IsParameterBound(c => c.TargetRegion))
                     {
                         if (galleryImageVersion.PublishingProfile == null)
@@ -714,5 +737,11 @@ public override void ExecuteCmdlet()
             ValueFromPipelineByPropertyName = true,
             HelpMessage = "Indicates whether or not removing this Gallery Image Version from replicated regions is allowed.")]
         public bool AllowDeletionOfReplicatedLocation { get; set; }
+
+        [Parameter(
+            Mandatory = false,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "This boolean will be passed by the customers to enable their GalleryImageVersion resources from accidental deletions. If this boolean is set to true, the image deletions will be blocked before its EndOfLife date.")]
+        public bool? BlockDeletionBeforeEndOfLife { get; set; }
     }
 }

src/Compute/Compute/ChangeLog.md

@@ -44,11 +44,12 @@ public string ResourceGroupName
         public string ProvisioningState { get; set; }
         public GalleryImageVersionStorageProfile StorageProfile { get; set; }
         public ReplicationStatus ReplicationStatus { get; set; }
+        public GalleryImageVersionSafetyProfile SafetyProfile { get; set; }
         public string Id { get; set; }
         public string Name { get; set; }
         public string Type { get; set; }
         public string Location { get; set; }
         public IDictionary<string, string> Tags { get; set; }
 
     }
-}
+}