NoHealthyBackendsBehavior (#25322)

* NoHealthyBackendsBehavior

Added the changes necessary for the NoHealthyBackendsBehavior property inside of probe.

* Updated changelog

* Update LoadBalancerTests.ps1

* Update ChangeLog.md

---------

Co-authored-by: NoriZC <[email protected]>

Author: EugenioPena

src/Network/Network/ChangeLog.md

@@ -19,6 +19,10 @@
 --->
 
 ## Upcoming Release
+* Added NoHealthyBackendsBehavior to PSProbe, and updated corresponding cmdlets.
+	- `New-AzLoadBalancerProbeConfig`
+	- `Add-AzLoadBalancerProbeConfig`
+	- `Set-AzLoadBalancerProbeConfig`
 * Updated Network.Management SDK to consume newer Swagger version
 * Updated cmdlet to add 'Premium' as a valid value for 'Sku' parameter and 'enableSessionRecording' feature for Bastion resources
     - `New-AzBastion`

src/Network/Network/Generated/Models/PSProbe.cs

@@ -53,6 +53,9 @@ public partial class PSProbe : PSChildResource
         public string RequestPath { get; set; }
         [JsonProperty(Order = 1)]
         [Ps1Xml(Target = ViewControl.Table)]
+        public string NoHealthyBackendsBehavior { get; set; }
+        [JsonProperty(Order = 1)]
+        [Ps1Xml(Target = ViewControl.Table)]
         public string ProvisioningState { get; set; }
         [JsonProperty(Order = 1)]
         public List<PSResourceId> LoadBalancingRules { get; set; }

src/Network/Network/LoadBalancer/Probe/AddAzureRmLoadBalancerProbeConfigCommand.cs

@@ -82,6 +82,16 @@ public partial class AddAzureRmLoadBalancerProbeConfigCommand : NetworkBaseCmdle
             ValueFromPipelineByPropertyName = true)]
         public string RequestPath { get; set; }
 
+        [Parameter(
+            Mandatory = false,
+            HelpMessage = "Determines how new connections are handled by the load balancer when all backend instances are probed down.",
+            ValueFromPipelineByPropertyName = true)]
+        [PSArgumentCompleter(
+            "AllProbedDown",
+            "AllProbedUp"
+        )]
+        public string NoHealthyBackendsBehavior { get; set; }
+
 
         public override void Execute()
         {
@@ -107,6 +117,7 @@ public override void Execute()
                 vProbes.NumberOfProbes = this.ProbeCount;
                 vProbes.ProbeThreshold = this.ProbeThreshold;
                 vProbes.RequestPath = this.RequestPath;
+                vProbes.NoHealthyBackendsBehavior = this.NoHealthyBackendsBehavior;
                 vProbes.Name = this.Name;
                 var generatedId = string.Format(
                     "/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.Network/loadBalancers/{2}/{3}/{4}",

src/Network/Network/LoadBalancer/Probe/NewAzureRmLoadBalancerProbeConfigCommand.cs

@@ -75,6 +75,15 @@ public partial class NewAzureRmLoadBalancerProbeConfigCommand : NetworkBaseCmdle
             ValueFromPipelineByPropertyName = true)]
         public string RequestPath { get; set; }
 
+        [Parameter(
+            Mandatory = false,
+            HelpMessage = "Determines how new connections are handled by the load balancer when all backend instances are probed down.",
+            ValueFromPipelineByPropertyName = true)]
+        [PSArgumentCompleter(
+            "AllProbedDown",
+            "AllProbedUp"
+        )]
+        public string NoHealthyBackendsBehavior { get; set; }
 
         public override void Execute()
         {
@@ -86,6 +95,7 @@ public override void Execute()
             vProbes.NumberOfProbes = this.ProbeCount;
             vProbes.ProbeThreshold = this.ProbeThreshold;
             vProbes.RequestPath = this.RequestPath;
+            vProbes.NoHealthyBackendsBehavior = this.NoHealthyBackendsBehavior;
             vProbes.Name = this.Name;
             var generatedId = string.Format(
                 "/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.Network/loadBalancers/{2}/{3}/{4}",

src/Network/Network/LoadBalancer/Probe/SetAzureRmLoadBalancerProbeConfigCommand.cs

@@ -82,6 +82,15 @@ public partial class SetAzureRmLoadBalancerProbeConfigCommand : NetworkBaseCmdle
             ValueFromPipelineByPropertyName = true)]
         public string RequestPath { get; set; }
 
+        [Parameter(
+            Mandatory = false,
+            HelpMessage = "Determines how new connections are handled by the load balancer when all backend instances are probed down.",
+            ValueFromPipelineByPropertyName = true)]
+        [PSArgumentCompleter(
+            "AllProbedDown",
+            "AllProbedUp"
+        )]
+        public string NoHealthyBackendsBehavior { get; set; }
 
         public override void Execute()
         {
@@ -101,6 +110,7 @@ public override void Execute()
             vProbes.NumberOfProbes = this.ProbeCount;
             vProbes.ProbeThreshold = this.ProbeThreshold;
             vProbes.RequestPath = this.RequestPath;
+            vProbes.NoHealthyBackendsBehavior = this.NoHealthyBackendsBehavior;
             vProbes.Name = this.Name;
             this.LoadBalancer.Probes[vProbesIndex] = vProbes;
             WriteObject(this.LoadBalancer, true);

src/Network/Network/help/Add-AzLoadBalancerProbeConfig.md

@@ -15,7 +15,7 @@ Adds a probe configuration to a load balancer.
 
 ```
 Add-AzLoadBalancerProbeConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] -Port <Int32>
- -IntervalInSeconds <Int32> -ProbeCount <Int32> [-ProbeThreshold <Int32>] [-RequestPath <String>]
+ -IntervalInSeconds <Int32> -ProbeCount <Int32> [-ProbeThreshold <Int32>] [-RequestPath <String>] [-NoHealthyBackendsBehavior <String>]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -26,7 +26,7 @@ The **Add-AzLoadBalancerProbeConfig** cmdlet adds a probe configuration to an Az
 
 ### Example 1: Add a probe configuration to a load balancer
 ```powershell
-Get-AzLoadBalancer -Name "myLb" -ResourceGroupName "myRg" | Add-AzLoadBalancerProbeConfig -Name "probeName" -RequestPath healthcheck2.aspx -Protocol http -Port 81 -IntervalInSeconds 16 -ProbeCount 3 -ProbeThreshold 3 | Set-AzLoadBalancer
+Get-AzLoadBalancer -Name "myLb" -ResourceGroupName "myRg" | Add-AzLoadBalancerProbeConfig -Name "probeName" -RequestPath healthcheck2.aspx -Protocol http -Port 81 -IntervalInSeconds 16 -ProbeCount 3 -ProbeThreshold 3 -NoHealthyBackendsBehavior "AllProbedUp" | Set-AzLoadBalancer
 ```
 
 This command gets the load balancer named myLb, adds the specified probe configuration to it, and then uses the **Set-AzLoadBalancer** cmdlet to update the load balancer.
@@ -170,6 +170,23 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -NoHealthyBackendsBehavior
+Determines how new connections are handled by the load balancer when all backend instances are probed down.
+The acceptable values for this parameter are: AllProbedDown or AllProbedUp.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+Accepted values: AllProbedDown, AllProbedUp
+
+Required: False
+Position: Named
+Default value: AllProbedDown
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -Confirm
 Prompts you for confirmation before running the cmdlet.
 

src/Network/Network/help/New-AzLoadBalancerProbeConfig.md

@@ -15,7 +15,7 @@ Creates a probe configuration for a load balancer.
 
 ```
 New-AzLoadBalancerProbeConfig -Name <String> [-Protocol <String>] -Port <Int32> -IntervalInSeconds <Int32>
- -ProbeCount <Int32> [-ProbeThreshold <Int32>] [-RequestPath <String>]
+ -ProbeCount <Int32> [-ProbeThreshold <Int32>] [-RequestPath <String>] [-NoHealthyBackendsBehavior <String>]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -26,7 +26,7 @@ The **New-AzLoadBalancerProbeConfig** cmdlet creates a probe configuration for a
 
 ### Example 1: Create a probe configuration
 ```powershell
-New-AzLoadBalancerProbeConfig -Name "MyProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 15 -ProbeThreshold 15
+New-AzLoadBalancerProbeConfig -Name "MyProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 15 -ProbeThreshold 15 -NoHealthyBackendsBehavior "AllProbedUp"
 ```
 
 This command creates a probe configuration named MyProbe using the HTTP protocol.
@@ -166,6 +166,23 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -NoHealthyBackendsBehavior
+Determines how new connections are handled by the load balancer when all backend instances are probed down.
+The acceptable values for this parameter are: AllProbedDown or AllProbedUp.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+Accepted values: AllProbedDown, AllProbedUp
+
+Required: False
+Position: Named
+Default value: AllProbedDown
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -Confirm
 Prompts you for confirmation before running the cmdlet.
 

src/Network/Network/help/Set-AzLoadBalancerProbeConfig.md

@@ -15,7 +15,7 @@ Updates a probe configuration for a load balancer.
 
 ```
 Set-AzLoadBalancerProbeConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] -Port <Int32>
- -IntervalInSeconds <Int32> -ProbeCount <Int32> [-ProbeThreshold <Int32>] [-RequestPath <String>]
+ -IntervalInSeconds <Int32> -ProbeCount <Int32> [-ProbeThreshold <Int32>] [-RequestPath <String>] [-NoHealthyBackendsBehavior <String>]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -28,7 +28,7 @@ The **Set-AzLoadBalancerProbeConfig** cmdlet updates a probe configuration for a
 ```powershell
 $slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup"
 $slb | Add-AzLoadBalancerProbeConfig -Name "NewProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -ProbeThreshold 2 -RequestPath "healthcheck.aspx" 
-$slb | Set-AzLoadBalancerProbeConfig -Name "NewProbe" -Port 80 -IntervalInSeconds 15 -ProbeCount 2
+$slb | Set-AzLoadBalancerProbeConfig -Name "NewProbe" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -NoHealthyBackendsBehavior "AllProbedUp"
 ```
 
 The first command gets the loadbalancer named MyLoadBalancer, and then stores it in the $slb variable.
@@ -186,6 +186,23 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -NoHealthyBackendsBehavior
+Determines how new connections are handled by the load balancer when all backend instances are probed down.
+The acceptable values for this parameter are: AllProbedDown or AllProbedUp.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+Accepted values: AllProbedDown, AllProbedUp
+
+Required: False
+Position: Named
+Default value: AllProbedDown
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -Confirm
 Prompts you for confirmation before running the cmdlet.