Removing and updating broken Image aliases used in VM creation (#21012)

Sandido · web-flow · commit b8de959bb62f · 2023-03-09T14:06:19.000+08:00
* test play

* test good going

* dev and test and haiders dev

* changelog

* example and help doc

* Update ChangeLog.md

* clean

* clean

* clean

* versioned linux aliases except rhel

* versioned tests and cleanup

* clean

* breaking change update

* breaking update

* clean breaking

* break change update

* break

* test cleanup

* Update NewAzureVMCommand.cs

* Update NewAzureVMCommand.cs

* Update New-AzVM.md

* Update New-AzVM.md

* Update Images.json

* rhel versioned alias

* ubuntu22 test

* Update ChangeLog.md

* Update New-AzVM.md

* Update NewAzureVMCommand.cs

* Update ExampleIssues.csv
diff --git a/src/Compute/Compute.Test/ScenarioTests/ImageTests.cs b/src/Compute/Compute.Test/ScenarioTests/ImageTests.cs
@@ -37,5 +37,12 @@ public void TestImageCapture()
         {
             TestRunner.RunTestScript("Test-ImageCapture $null");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestDefaultImagesExistManual()
+        {
+            TestRunner.RunTestScript("Test-DefaultImagesExistManual");
+        }
     }
 }
diff --git a/src/Compute/Compute.Test/ScenarioTests/ImageTests.ps1 b/src/Compute/Compute.Test/ScenarioTests/ImageTests.ps1
@@ -312,3 +312,154 @@ function Test-ImageCapture
     }
 }
 
+function Test-DefaultImagesExistManual
+{
+    
+    # Setup
+    #$rgname = Get-ComputeTestResourceName;
+    $loc = Get-ComputeVMLocation;
+
+    try
+    {
+        # assuming the below file path:
+        # C:\repos\ps3\azure-powershell\src\Compute\Compute\Strategies\ComputeRp\Images.json
+        #$imagesFile = Get-Content -Path "..\..\..\..\Compute\Compute\Strategies\ComputeRp\Images.json";
+        $imagesFile = Get-Content -Path "..\..\..\..\Compute\Strategies\ComputeRp\Images.json";
+        $images = $imagesFile | ConvertFrom-Json;
+        
+        # Linux
+        # UbuntuLTS test
+        $publisher = $images.Linux.UbuntuLTS.publisher;
+        $offer = $images.Linux.UbuntuLTS.offer;
+        $sku = $images.Linux.UbuntuLTS.sku;
+        $version = $images.Linux.UbuntuLTS.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # Ubuntu2204 test
+        $publisher = $images.Linux.Ubuntu2204.publisher;
+        $offer = $images.Linux.Ubuntu2204.offer;
+        $sku = $images.Linux.Ubuntu2204.sku;
+        $version = $images.Linux.Ubuntu2204.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+        
+        # CentOS test
+        $publisher = $images.Linux.CentOS.publisher;
+        $offer = $images.Linux.CentOS.offer;
+        $sku = $images.Linux.CentOS.sku;
+        $version = $images.Linux.CentOS.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # CentOS versioned test
+        $publisher = $images.Linux.CentOS85Gen2.publisher;
+        $offer = $images.Linux.CentOS85Gen2.offer;
+        $sku = $images.Linux.CentOS85Gen2.sku;
+        $version = $images.Linux.CentOS85Gen2.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+        
+        # Debian test
+        $publisher = $images.Linux.Debian.publisher;
+        $offer = $images.Linux.Debian.offer;
+        $sku = $images.Linux.Debian.sku;
+        $version = $images.Linux.Debian.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # Debian versioned test
+        $publisher = $images.Linux.Debian9.publisher;
+        $offer = $images.Linux.Debian9.offer;
+        $sku = $images.Linux.Debian9.sku;
+        $version = $images.Linux.Debian9.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # LinOpenSuseLeap154 versioned test
+        $publisher = $images.Linux.OpenSuseLeap154.publisher;
+        $offer = $images.Linux.OpenSuseLeap154.offer;
+        $sku = $images.Linux.OpenSuseLeap154.sku;
+        $version = $images.Linux.OpenSuseLeap154.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # RHEL test
+        $publisher = $images.Linux.RHEL.publisher;
+        $offer = $images.Linux.RHEL.offer;
+        $sku = $images.Linux.RHEL.sku;
+        $version = $images.Linux.RHEL.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # RHELRaw91Gen2 test
+        $publisher = $images.Linux.RHELRaw91Gen2.publisher;
+        $offer = $images.Linux.RHELRaw91Gen2.offer;
+        $sku = $images.Linux.RHELRaw91Gen2.sku;
+        $version = $images.Linux.RHELRaw91Gen2.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # LinSuseSles15SP4 versioned test
+        $publisher = $images.Linux.SuseSles15SP4.publisher;
+        $offer = $images.Linux.SuseSles15SP4.offer;
+        $sku = $images.Linux.SuseSles15SP4.sku;
+        $version = $images.Linux.SuseSles15SP4.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # Windows
+        # Win2022AzureEditionCore test
+        $publisher = $images.Windows.Win2022AzureEditionCore.publisher;
+        $offer = $images.Windows.Win2022AzureEditionCore.offer;
+        $sku = $images.Windows.Win2022AzureEditionCore.sku;
+        $version = $images.Windows.Win2022AzureEditionCore.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # Win2019Datacenter test
+        $publisher = $images.Windows.Win2019Datacenter.publisher;
+        $offer = $images.Windows.Win2019Datacenter.offer;
+        $sku = $images.Windows.Win2019Datacenter.sku;
+        $version = $images.Windows.Win2019Datacenter.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # Win2016Datacenter test
+        $publisher = $images.Windows.Win2016Datacenter.publisher;
+        $offer = $images.Windows.Win2016Datacenter.offer;
+        $sku = $images.Windows.Win2016Datacenter.sku;
+        $version = $images.Windows.Win2016Datacenter.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # Win2012R2Datacenter test
+        $publisher = $images.Windows.Win2012R2Datacenter.publisher;
+        $offer = $images.Windows.Win2012R2Datacenter.offer;
+        $sku = $images.Windows.Win2012R2Datacenter.sku;
+        $version = $images.Windows.Win2012R2Datacenter.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # Win2012Datacenter test
+        $publisher = $images.Windows.Win2012Datacenter.publisher;
+        $offer = $images.Windows.Win2012Datacenter.offer;
+        $sku = $images.Windows.Win2012Datacenter.sku;
+        $version = $images.Windows.Win2012Datacenter.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+
+        # Win10 test
+        $publisher = $images.Windows.Win10.publisher;
+        $offer = $images.Windows.Win10.offer;
+        $sku = $images.Windows.Win10.sku;
+        $version = $images.Windows.Win10.version;
+        $img = Get-AzVMImage -Location $loc -Publisher $publisher -Offer $offer -Sku $sku -Version $version;
+        Assert-NotNull $img;
+    }
+    finally 
+    {
+        # Cleanup
+        Clean-ResourceGroup $rgname
+    }
+}
diff --git a/src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.ImageTests/TestDefaultImagesExistManual.json b/src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.ImageTests/TestDefaultImagesExistManual.json
diff --git a/src/Compute/Compute/ChangeLog.md b/src/Compute/Compute/ChangeLog.md
@@ -27,6 +27,9 @@
 * Added 'MaxSurge' to Set-AzVmssRollingUpgradePolicyCommand
 * Added support for 'latest' in 'Get-AzvmImage' '-Version' parameter
 * Added `CompletionPercent` property to PSDisk object.
+* Removed the image alias `CoreOS` as the publisher CoreOS no longer has any images for Azure. 
+  Updated the names of the `openSUSE-Leap` and `SLES` aliases to `OpenSuseLeap154` and `SuseSles15SP4` respectively. Updated these aliases to point to an image that actually exists and updated the alias names to be descriptive and versioned.
+* Added new descriptive and versioned alias names for the Linux image aliases. 
 
 ## Version 5.4.0
 * Added `-SkipIdentity`, `-PathUserIdentity`, `-IsTest` parameter to `Set-AzVMAEMExtension` 
diff --git a/src/Compute/Compute/Images/GetAzureVMImageCommand.cs b/src/Compute/Compute/Images/GetAzureVMImageCommand.cs
@@ -80,7 +80,7 @@ public class GetAzureVMImageCommand : VirtualMachineImageBaseCmdlet
         [Parameter(ParameterSetName = GetVMImageDetailParamSetName,
             Mandatory = true,
             ValueFromPipelineByPropertyName = true,
-            HelpMessage ="Specifies the version of the image. Use 'latest' to get the latest image")]
+            HelpMessage = "Specifies the version of the image. Use 'latest' to get the latest image")]
         [ValidateNotNullOrEmpty]
         [SupportsWildcards]
         public string Version { get; set; }
diff --git a/src/Compute/Compute/Strategies/ComputeRp/Images.json b/src/Compute/Compute/Strategies/ComputeRp/Images.json
@@ -6,10 +6,10 @@
                                  "sku":  "7.5",
                                  "version":  "latest"
                              },
-                  "CoreOS":  {
-                                 "publisher":  "CoreOS",
-                                 "offer":  "CoreOS",
-                                 "sku":  "Stable",
+                  "CentOS85Gen2":  {
+                                 "publisher":  "OpenLogic",
+                                 "offer":  "CentOS",
+                                 "sku":  "8_5-gen2",
                                  "version":  "latest"
                              },
                   "Debian":  {
@@ -18,10 +18,16 @@
                                  "sku":  "8",
                                  "version":  "latest"
                              },
-                  "openSUSE-Leap":  {
+                  "Debian9":  {
+                                 "publisher":  "credativ",
+                                 "offer":  "Debian",
+                                 "sku":  "9",
+                                 "version":  "latest"
+                             },
+                  "OpenSuseLeap154":  {
                                         "publisher":  "SUSE",
-                                        "offer":  "openSUSE-Leap",
-                                        "sku":  "42.3",
+                                        "offer":  "openSUSE-leap-15-4",
+                                        "sku":  "gen2",
                                         "version":  "latest"
                                     },
                   "RHEL":  {
@@ -30,19 +36,31 @@
                                "sku":  "7-RAW",
                                "version":  "latest"
                            },
-                  "SLES":  {
+                  "RHELRaw91Gen2":  {
+                               "publisher":  "RedHat",
+                               "offer":  "rhel-raw",
+                               "sku":  "91-gen2",
+                               "version":  "latest"
+                           },
+                  "SuseSles15SP4":  {
                                "publisher":  "SUSE",
-                               "offer":  "SLES",
-                               "sku":  "12-SP2",
+                               "offer":  "sles-15-sp4",
+                               "sku":  "gen2",
                                "version":  "latest"
                            },
                   "UbuntuLTS":  {
                                     "publisher":  "Canonical",
                                     "offer":  "UbuntuServer",
                                     "sku":  "16.04-LTS",
                                     "version":  "latest"
+                                },
+                  "Ubuntu2204":  {
+                                    "publisher":  "Canonical",
+                                    "offer":  "0001-com-ubuntu-pro-advanced-sla-ca",
+                                    "sku":  "22_04",
+                                    "version":  "latest"
                                 }
-              },
+    },
     "Windows":  {
                     "Win2022AzureEditionCore": {
                                               "publisher": "MicrosoftWindowsServer",
diff --git a/src/Compute/Compute/VirtualMachine/Operation/NewAzureVMCommand.cs b/src/Compute/Compute/VirtualMachine/Operation/NewAzureVMCommand.cs
@@ -54,7 +54,8 @@
 
 namespace Microsoft.Azure.Commands.Compute
 {
-    [GenericBreakingChange("Starting in May 2023 the \"New-AzVM\" cmdlet will deploy with the Trusted Launch configuration by default. To know more about Trusted Launch, please visit https://learn.microsoft.com/en-us/azure/virtual-machines/trusted-launch")]
+    [GenericBreakingChange("Consider using the image alias including the version of the distribution you want to use in the \"-Image\" parameter of the \"New-AzVM\" cmdlet. On April 30, 2023, the image deployed using `UbuntuLTS` will reach its end of life. ")]
+    [GenericBreakingChange("Starting in May 2023 the \"New-AzVM\" cmdlet will deploy with the Trusted Launch configuration by default. To know more about Trusted Launch, please visit https://docs.microsoft.com/en-us/azure/virtual-machines/trusted-launch")]
     [GenericBreakingChange("It is recommended to use parameter \"-PublicIpSku Standard\" in order to create a new VM with a Standard public IP.Specifying zone(s) using the \"-Zone\" parameter will also result in a Standard public IP.If \"-Zone\" and \"-PublicIpSku\" are not specified, the VM will be created with a Basic public IP instead.Please note that the Standard SKU IPs will become the default behavior for VM creation in the future")]
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VM", SupportsShouldProcess = true, DefaultParameterSetName = "SimpleParameterSet")]
     [OutputType(typeof(PSAzureOperationResponse), typeof(PSVirtualMachine))]
@@ -210,12 +211,15 @@ public class NewAzureVMCommand : VirtualMachineBaseCmdlet
         [Parameter(ParameterSetName = SimpleParameterSet, Mandatory = false)]
         [PSArgumentCompleter(
             "CentOS",
-            "CoreOS",
+            "CentOS85Gen2",
             "Debian",
-            "openSUSE-Leap",
+            "Debian9",
+            "OpenSuseLeap154",
             "RHEL",
-            "SLES",
+            "RHELRaw91Gen2",
+            "SuseSles15SP4",
             "UbuntuLTS",
+            "Ubuntu2204",
             "Win2022AzureEditionCore",
             "Win2019Datacenter",
             "Win2016Datacenter",
diff --git a/src/Compute/Compute/help/New-AzVM.md b/src/Compute/Compute/help/New-AzVM.md
@@ -249,7 +249,7 @@ $vmss = New-AzVmss -ResourceGroupName $resourceGroupName -Name $vmssName -Virtua
 $vm = New-AzVM -ResourceGroupName $resourceGroupName -Name $vmname -Credential $cred -DomainNameLabel $domainNameLabel -PlatformFaultDomain $platformFaultDomainVMDefaultSet -VmssId $vmss.Id
 ```
 
-This example Creates a new VM as part of a VMSS with a PlatformFaultDomain value.
+This example creates a new VM as part of a VMSS with a PlatformFaultDomain value.
 
 ### Example 7: Creating a new VM with the GuestAttestation extension installed by default, then recreating the VM with DisableIntegrityMonitoring to prevent this.
 ```
@@ -315,7 +315,29 @@ New-AzVM -ResourceGroupName $rgname -Location $loc -VM $vmConfig -DisableIntegri
 # This VM does not have the Guest Attestation extension installed on it, and the Identity is not set to SystemAssigned by default.
 ```
 
-This example Creates a new VM with the GuestAttestation extension installed by default, then recreating the VM with DisableIntegrityMonitoring to prevent this.
+This example creates a new VM with the GuestAttestation extension installed by default, then recreating the VM with DisableIntegrityMonitoring to prevent this.
+
+### Example 8: Create a VM using the -Image alias.
+```powershell
+$resourceGroupName= "<Resource Group Name>"
+$loc = "<Azure Region>"
+$domainNameLabel = "<Domain Name Label>"
+$vmname = "<Virtual Machine Name>"
+$securePassword = "<Password>" | ConvertTo-SecureString -AsPlainText -Force
+$user = "<Username>"
+$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword)
+
+New-AzResourceGroup -Name $rgname -Location $loc -Force
+
+# Create a VM using an Image alias.
+$vmname = 'v' + $rgname
+$domainNameLabel = "d" + $rgname
+$vm = New-AzVM -ResourceGroupName $rgname -Name $vmname -Credential $cred -Image LinOpenSuseLeap154 -DomainNameLabel $domainNameLabel
+
+$vm = Get-AzVM -ResourceGroupName $rgname -Name $vmname
+```
+
+This example creates a new VM using the -Image parameter, providing many default values to the VM. 
 
 ## PARAMETERS
 
@@ -664,7 +686,7 @@ Accept wildcard characters: False
 ```
 
 ### -Image
-The friendly image name upon which the VM will be built.  These include: Win2022AzureEditionCore, Win2019Datacenter, Win2016Datacenter, Win2012R2Datacenter, Win2012Datacenter, UbuntuLTS, CentOS, CoreOS, Debian, openSUSE-Leap, RHEL, SLES.
+The friendly image name upon which the VM will be built. The available aliases are: Win2022AzureEditionCore, Win2019Datacenter, Win2016Datacenter, Win2012R2Datacenter, Win2012Datacenter, UbuntuLTS, Ubuntu2204, CentOS, CentOS85Gen2, Debian, Debian9, OpenSuseLeap154, RHEL, RHELRaw91Gen2, SuseSles15SP4.
 
 ```yaml
 Type: System.String
diff --git a/tools/StaticAnalysis/Exceptions/Az.Compute/ExampleIssues.csv b/tools/StaticAnalysis/Exceptions/Az.Compute/ExampleIssues.csv
@@ -17,3 +17,4 @@
 "Az.Compute","Set-AzVMSecurityProfile","2","26","Capitalization_Conventions_Violated","5101","1","Set-AzVmSecurityProfile doesn't follow the Capitalization Conventions.","Set-AzVmSecurityProfile -VM $VirtualMachine -SecurityType $SecurityType","Check the Capitalization Conventions. Suggest format: Set-AzVMSecurityProfile"
 "Az.Compute","Set-AzVMSecurityProfile","2","27","Capitalization_Conventions_Violated","5101","1","Set-AzVmUefi doesn't follow the Capitalization Conventions.","Set-AzVmUefi -VM $VirtualMachine -EnableVtpm $true -EnableSecureBoot $true","Check the Capitalization Conventions. Suggest format: Set-AzVMUefi"
 "Az.Compute","Set-AzVMSecurityProfile","2","33","Capitalization_Conventions_Violated","5101","1","Get-AzVm doesn't follow the Capitalization Conventions.","Get-AzVm -ResourceGroupName $rgname -Name $vmname","Check the Capitalization Conventions. Suggest format: Get-AzVM"
+"Az.Compute","New-AzVM","8","9","Invalid_Cmdlet","5000","1","New-AzResourceGroup is not a valid command name.","New-AzResourceGroup -Name $rgname -Location $loc -Force","Check the spell of New-AzResourceGroup."

Original file line number	Diff line number	Diff line change
`@@ -37,5 +37,12 @@ public void TestImageCapture()`
`37`	`37`	`{`
`38`	`38`	`TestRunner.RunTestScript("Test-ImageCapture $null");`
`39`	`39`	`}`
	`40`	`+`
	`41`	`+ [Fact]`
	`42`	`+ [Trait(Category.AcceptanceType, Category.CheckIn)]`
	`43`	`+ public void TestDefaultImagesExistManual()`
	`44`	`+ {`
	`45`	`+ TestRunner.RunTestScript("Test-DefaultImagesExistManual");`
	`46`	`+ }`
`40`	`47`	`}`
`41`	`48`	`}`