IF-Match/IF-NOT-MATCH header support for VMSS creation/update (#24657)

* Autogen code

* fix change log

* fix etag adding to PS objects

* unchange PSAzureOperationResponse

* undo config cmdlts

* new-azvmss, update-azvmss

* update azvm

* New-AzVm

* new-azvm

* add ValueFromPipelineByPropertyName

* new-azvmss

* md files

* fix unnecessary syntax changes

* example issues suppression for New-AzResourceGroup cmdlet use

* undo NewAzureVMCommand format change

* isolate changes to NewAzureVmCommand.cs file without format change

* re-recorded vmss tests for regression test

* improve helpmessages

* fix changelog

---------

Co-authored-by: github-actions <[email protected]>

Author: grizzlytheodore

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineScaleSetTests/TestVirtualMachineScaleSetDefaultToFlexibleOrchestrationMode.json

@@ -20,6 +20,8 @@
 
 -->
 ## Upcoming Release
+* Added `Etag` property to PSVirtualMachine and PSVirtualMachineScaleSet objects.   
+* Added parameters `-IfMatch` and `-IfNoneMatch` to `Update-AzVM`, `Update-AzVmss`, `New-AzVm`, `New-AzVmss`, `New-AzVmConfig`, and `New-AzVmssConfig` cmdlets.
 
 ## Version 7.3.0
 * Added cmdlet `Invoke-AzSpotPlacementRecommender`.

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineScaleSetTests/TestVirtualMachineScaleSetEdgeZone.json

@@ -9,6 +9,8 @@ namespace Microsoft.Azure.Management.Compute.Models
     static class VirtualMachineExtensions
     {
         private static IDictionary<VirtualMachine, Dictionary<string, List<string>>> mapping = new ConcurrentDictionary<VirtualMachine, Dictionary<string, List<string>>>();
+        private static string ifMatchProperty = null;
+        private static string ifNoneMatchProperty = null;
 
         public static void SetAuxAuthHeader(this VirtualMachine vm, Dictionary<string, List<string>> auxAuthHeader)
         {
@@ -27,5 +29,21 @@ public static void RemoveAuxAuthHeader(this VirtualMachine vm)
             mapping.Remove(vm);
         }
 
+        public static void SetIfMatchIfNoneMatch(this VirtualMachine vm, string ifMatch, string ifNoneMatch)
+        {
+            ifMatchProperty = ifMatch;
+            ifNoneMatchProperty = ifNoneMatch;
+        }
+        public static Tuple<string,string> GetIfMatchIfNoneMatch(this VirtualMachine vm)
+        {
+            return Tuple.Create(ifMatchProperty, ifNoneMatchProperty);    
+        }
+
+        public static void RemoveIfMatchIfNoneMatch(this VirtualMachine vm)
+        {
+            ifMatchProperty = null;
+            ifNoneMatchProperty = null;
+        }
+
     }
 }

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineScaleSetTests/TestVirtualMachineScaleSetSecurityTypeAndFlexDefaults.json

@@ -9,6 +9,8 @@ namespace Microsoft.Azure.Management.Compute.Models
     static class VirtualMachineScaleSetExtensions
     {
         private static IDictionary<VirtualMachineScaleSet, Dictionary<string, List<string>>> mapping = new ConcurrentDictionary<VirtualMachineScaleSet, Dictionary<string, List<string>>>();
+        private static string ifMatchProperty = null;
+        private static string ifNoneMatchProperty = null;
 
         public static void SetAuxAuthHeader(this VirtualMachineScaleSet vmss, Dictionary<string, List<string>> auxAuthHeader)
         {
@@ -27,5 +29,21 @@ public static void RemoveAuxAuthHeader(this VirtualMachineScaleSet vmss)
             mapping.Remove(vmss);
         }
 
+        public static void SetIfMatchIfNoneMatch(this VirtualMachineScaleSet vmss, string ifMatch, string ifNoneMatch)
+        {
+            ifMatchProperty = ifMatch;
+            ifNoneMatchProperty = ifNoneMatch;
+        }
+        public static Tuple<string, string> GetIfMatchIfNoneMatch(this VirtualMachineScaleSet vmss)
+        {
+            return Tuple.Create(ifMatchProperty, ifNoneMatchProperty);
+        }
+
+        public static void RemoveIfMatchIfNoneMatch(this VirtualMachineScaleSet vmss)
+        {
+            ifMatchProperty = null;
+            ifNoneMatchProperty = null;
+        }
+
     }
 }

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineScaleSetTests/TestVirtualMachineScaleSetSecurityTypeNoVMProfile.json

@@ -13,12 +13,16 @@ public static partial class VirtualMachineScaleSetsOperationsExtensions
         public static async Task<VirtualMachineScaleSet> CreateOrUpdateWithCustomHeaderAsync(this IVirtualMachineScaleSetsOperations operations, string resourceGroupName, string vmssName, VirtualMachineScaleSet virtualMachineScaleSet, CancellationToken cancellationToken = default(CancellationToken))
         {
             var auxAuthHeader = virtualMachineScaleSet.GetAuxAuthHeader();
+            var ifMatchResult = virtualMachineScaleSet.GetIfMatchIfNoneMatch();
+            var ifMatch = ifMatchResult.Item1;
+            var ifNoneMatch = ifMatchResult.Item2;
             if (auxAuthHeader == null)
             {
-                return operations.CreateOrUpdate(resourceGroupName, vmssName, virtualMachineScaleSet);
+                return operations.CreateOrUpdate(resourceGroupName, vmssName, virtualMachineScaleSet, ifMatch, ifNoneMatch);
             }
             virtualMachineScaleSet.RemoveAuxAuthHeader();
-            using (var _result = await operations.CreateOrUpdateWithHttpMessagesAsync(resourceGroupName, vmssName, virtualMachineScaleSet, null,null,auxAuthHeader, cancellationToken).ConfigureAwait(false))
+            virtualMachineScaleSet.RemoveIfMatchIfNoneMatch();
+            using (var _result = await operations.CreateOrUpdateWithHttpMessagesAsync(resourceGroupName, vmssName, virtualMachineScaleSet, ifMatch ,ifNoneMatch,auxAuthHeader, cancellationToken).ConfigureAwait(false))
             {
                 return _result.Body;
             }

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineScaleSetTests/TestVirtualMachineScaleSetSecurityTypeStandard.json

@@ -13,12 +13,16 @@ public static partial class VirtualMachinesOperationsExtensions
         public static async Task<VirtualMachine> CreateOrUpdateWithCustomHeaderAsync(this IVirtualMachinesOperations operations, string resourceGroupName, string vmName, VirtualMachine virtualMachine, CancellationToken cancellationToken = default(CancellationToken))
         {
             var auxAuthHeader = virtualMachine.GetAuxAuthHeader();
+            var ifMatchResult = virtualMachine.GetIfMatchIfNoneMatch();
+            var ifMatch = ifMatchResult.Item1;
+            var ifNoneMatch = ifMatchResult.Item2;
             if(auxAuthHeader == null)
             {
-                return operations.CreateOrUpdate(resourceGroupName, vmName, virtualMachine);
+                return operations.CreateOrUpdate(resourceGroupName, vmName, virtualMachine, ifMatch, ifNoneMatch);
             }
             virtualMachine.RemoveAuxAuthHeader();
-            using (var _result = await operations.CreateOrUpdateWithHttpMessagesAsync(resourceGroupName, vmName, virtualMachine, null,null,auxAuthHeader, cancellationToken).ConfigureAwait(false))
+            virtualMachine.RemoveIfMatchIfNoneMatch();
+            using (var _result = await operations.CreateOrUpdateWithHttpMessagesAsync(resourceGroupName, vmName, virtualMachine, ifMatch, ifNoneMatch, auxAuthHeader, cancellationToken).ConfigureAwait(false))
             {
                 return _result.Body;
             }

src/Compute/Compute/ChangeLog.md

@@ -73,5 +73,6 @@ public string ResourceGroupName
         //     Gets specifies the time at which the Virtual Machine Scale Set resource was created.<br><br>Minimum
         //     api-version: 2022-03-01.
         public DateTime? TimeCreated { get; private set; }
+        public string Etag { get; private set; }
     }
 }

src/Compute/Compute/Custom/VirtualMachineExtensions.cs

@@ -937,10 +937,11 @@ private void Run()
                 Identity = vIdentity,
                 OrchestrationMode = this.IsParameterBound(c => c.OrchestrationMode) ? this.OrchestrationMode : null,
                 SpotRestorePolicy = this.IsParameterBound(c => c.EnableSpotRestore) ? new SpotRestorePolicy(true, this.SpotRestoreTimeout) : null,
-                PriorityMixPolicy = vPriorityMixPolicy 
+                PriorityMixPolicy = vPriorityMixPolicy
             };
 
             WriteObject(vVirtualMachineScaleSet);
         }
     }
 }
+

src/Compute/Compute/Custom/VirtualMachineScaleSetExtensions.cs

@@ -176,14 +176,14 @@ public override void ExecuteCmdlet()
                                 var res = VirtualMachineScaleSetsClient.CreateOrUpdateWithHttpMessagesAsync(
                                         resourceGroupName,
                                         vmScaleSetName,
-                                        parameters,null,null,
+                                        parameters, this.IfMatch, this.IfNoneMatch,
                                         auxAuthHeader).GetAwaiter().GetResult();
 
                                 result = res.Body;
                             }
                             else
                             {
-                                result = VirtualMachineScaleSetsClient.CreateOrUpdate(resourceGroupName, vmScaleSetName, parameters);
+                                result = VirtualMachineScaleSetsClient.CreateOrUpdate(resourceGroupName, vmScaleSetName, parameters, this.IfMatch, this.IfNoneMatch);
                             }
 
                             var psObject = new PSVirtualMachineScaleSet();
@@ -401,5 +401,16 @@ private int convertAPIVersionToInt(string networkAPIVersion)
             ParameterSetName = SimpleParameterSet,
             HelpMessage = "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available.")]
         public SwitchParameter EnableAutomaticOSUpgrade{ get; set; }
+
+        [Parameter(
+            Mandatory = false,
+            HelpMessage = "used to make a request conditional for the PUT and other non-safe methods. The server will only return the requested resources if the resource matches one of the listed ETag values. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.")]
+        public string IfMatch { get; set; }
+
+        [Parameter(
+            Mandatory = false,
+            HelpMessage = "Used to make a request conditional for the GET and HEAD methods. The server will only return the requested resources if none of the listed ETag values match the current entity. Used to make a request conditional for the GET and HEAD methods. The server will only return the requested resources if none of the listed ETag values match the current entity. Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported.")]
+        public string IfNoneMatch { get; set; }
     }
 }
+

src/Compute/Compute/Custom/VirtualMachineScaleSetsOperationsExtensions.cs

@@ -81,8 +81,8 @@ public override void ExecuteCmdlet()
                     ComputeAutomationAutoMapperProfile.Mapper.Map<PSVirtualMachineScaleSet, VirtualMachineScaleSet>(this.VirtualMachineScaleSet, parameters);
 
                     var result = (this.VirtualMachineScaleSetUpdate == null)
-                                 ? VirtualMachineScaleSetsClient.CreateOrUpdate(resourceGroupName, vmScaleSetName, parameters)
-                                 : VirtualMachineScaleSetsClient.Update(resourceGroupName, vmScaleSetName, parametersupdate);
+                                 ? VirtualMachineScaleSetsClient.CreateOrUpdate(resourceGroupName, vmScaleSetName, parameters, this.IfMatch, this.IfNoneMatch)
+                                 : VirtualMachineScaleSetsClient.Update(resourceGroupName, vmScaleSetName, parametersupdate, this.IfMatch, this.IfNoneMatch);
                     var psObject = new PSVirtualMachineScaleSet();
                     ComputeAutomationAutoMapperProfile.Mapper.Map<VirtualMachineScaleSet, PSVirtualMachineScaleSet>(result, psObject);
                     WriteObject(psObject);
@@ -409,6 +409,18 @@ public override void ExecuteCmdlet()
            Mandatory = false)]
         public bool? EnableSecureBoot { get; set; } = null;
 
+        [Parameter(
+            Mandatory = false,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "used to make a request conditional for the PUT and other non-safe methods. The server will only return the requested resources if the resource matches one of the listed ETag values. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.")]
+        public string IfMatch { get; set; }
+
+        [Parameter(
+            Mandatory = false,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "Used to make a request conditional for the GET and HEAD methods. The server will only return the requested resources if none of the listed ETag values match the current entity. Used to make a request conditional for the GET and HEAD methods. The server will only return the requested resources if none of the listed ETag values match the current entity. Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported.")]
+        public string IfNoneMatch { get; set; }
+
         private void BuildPatchObject()
         {
             if (this.IsParameterBound(c => c.AutomaticOSUpgrade))

src/Compute/Compute/Custom/VirtualMachinesOperationsExtensions.cs

@@ -465,7 +465,9 @@ private async Task<ResourceConfig<VirtualMachineScaleSet>> SimpleParameterSetNor
                     securityType: _cmdlet.SecurityType,
                     enableVtpm: _cmdlet.EnableVtpm,
                     enableSecureBoot: _cmdlet.EnableSecureBoot,
-                    enableAutomaticOSUpgradePolicy:  _cmdlet.EnableAutomaticOSUpgrade == true ? true : (bool?)null
+                    enableAutomaticOSUpgradePolicy:  _cmdlet.EnableAutomaticOSUpgrade == true ? true : (bool?)null,
+                    ifMatch: _cmdlet.IfMatch,
+                    ifNoneMatch: _cmdlet.IfNoneMatch
                     );
             }
 
@@ -561,6 +563,25 @@ private async Task<ResourceConfig<VirtualMachineScaleSet>> SimpleParameterSetOrc
 
                 var hostGroup = resourceGroup.CreateDedicatedHostGroupSubResourceFunc(_cmdlet.HostGroupId);
 
+                Dictionary<string, List<string>> auxAuthHeader = null;
+                if (!string.IsNullOrEmpty(_cmdlet.ImageReferenceId))
+                {
+                    var resourceId = ResourceId.TryParse(_cmdlet.ImageReferenceId);
+
+                    if (string.Equals(ComputeStrategy.Namespace, resourceId?.ResourceType?.Namespace, StringComparison.OrdinalIgnoreCase)
+                     && string.Equals("galleries", resourceId?.ResourceType?.Provider, StringComparison.OrdinalIgnoreCase)
+                     && !string.Equals(_cmdlet.ComputeClient?.ComputeManagementClient?.SubscriptionId, resourceId?.SubscriptionId, StringComparison.OrdinalIgnoreCase))
+                    {
+                        List<string> resourceIds = new List<string>();
+                        resourceIds.Add(_cmdlet.ImageReferenceId);
+                        var auxHeaderDictionary = _cmdlet.GetAuxilaryAuthHeaderFromResourceIds(resourceIds);
+                        if (auxHeaderDictionary != null && auxHeaderDictionary.Count > 0)
+                        {
+                            auxAuthHeader = new Dictionary<string, List<string>>(auxHeaderDictionary);
+                        }
+                    }
+                }
+
                 return resourceGroup.CreateVirtualMachineScaleSetConfigOrchestrationModeFlexible(
                     name: _cmdlet.VMScaleSetName,
                     subnet: subnet,
@@ -591,7 +612,10 @@ private async Task<ResourceConfig<VirtualMachineScaleSet>> SimpleParameterSetOrc
                     securityType: _cmdlet.SecurityType,
                     enableVtpm: _cmdlet.EnableVtpm,
                     enableSecureBoot: _cmdlet.EnableSecureBoot,
-                    enableAutomaticOSUpgradePolicy: _cmdlet.EnableAutomaticOSUpgrade == true ? true : (bool?)null
+                    enableAutomaticOSUpgradePolicy: _cmdlet.EnableAutomaticOSUpgrade == true ? true : (bool?)null,
+                    auxAuthHeader: auxAuthHeader,
+                    ifMatch: _cmdlet.IfMatch,
+                    ifNoneMatch: _cmdlet.IfNoneMatch
                     );
             }
         }

src/Compute/Compute/Generated/Models/PSVirtualMachineScaleSet.cs

@@ -154,5 +154,6 @@ public string ResourceGroupName
         //     Gets specifies the time at which the Virtual Machine resource was created.<br><br>Minimum
         //     api-version: 2022-03-01.
         public DateTime? TimeCreated { get; private set; }
+        public string Etag { get; private set; }
     }
 }