Added information on how to find VM Images when using New-AzVM with -…

…Image parameter. (Azure#25779) * write information when -image is used * change --------- Co-authored-by: Theodore Chang <[email protected]> Co-authored-by: Xiaogang <[email protected]>
azure-sdk · Aug 12, 2024 · 6de23b6 · 6de23b6
1 parent c6bff79
commit 6de23b6
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/src/Compute/Compute/ChangeLog.md b/src/Compute/Compute/ChangeLog.md
@@ -20,6 +20,7 @@
 
 -->
 ## Upcoming Release
+* Added information on how to find VM Images when using `New-AzVM` with `-Image` parameter.
 * Added `TimeCreated` read-only field to `PSVirtualMachineScaleSetVMProfile` object.
 * Added  parameter `-ResourceIdsOnly` to `Get-AzCapacityReservationGroup` cmdlet.
 * Changed the `Set-AzVMOperatingSystem` cmdlet when the `-VM` parameter is used without an OSProfile. Now it will not throw a null reference exception when `-Credential` is not provided.

diff --git a/src/Compute/Compute/Common/ConstantStringTypes.cs b/src/Compute/Compute/Common/ConstantStringTypes.cs
@@ -71,6 +71,7 @@ public static class HelpMessages
         public const string VMPlanPublisher = "The publisher ID";
 
         public const string TrustedLaunchUpgradeMessage = "Consider upgrading security for your workloads using Azure Trusted Launch VMs. To know more about Trusted Launch, please visit https://aka.ms/TrustedLaunch";
+        public const string PSVMImageMessage = "You can reference https://aka.ms/findImagePS on how to find VM Images using PowerShell.";
     }
 
     public static class ValidateSetValues

diff --git a/src/Compute/Compute/VirtualMachine/Operation/NewAzureVMCommand.cs b/src/Compute/Compute/VirtualMachine/Operation/NewAzureVMCommand.cs
@@ -770,6 +770,11 @@ async Task StrategyExecuteCmdletAsync(IAsyncCmdlet asyncCmdlet)
             PublicIpAddressName = PublicIpAddressName;
             SecurityGroupName = SecurityGroupName ?? Name;
 
+            if (this.IsParameterBound(c => c.Image))
+            {
+                WriteInformation(HelpMessages.PSVMImageMessage, new string[] { "PSHOST" });
+            }
+
             // Check TrustedLaunch UEFI values defaulting
             if (this.IsParameterBound(c => c.SecurityType)
                 && this.SecurityType != null)