Skip to content

Commit 6cbf87c

Browse files
Gizachew-EshetieGizachew Eshetiewyunchi-ms
authored
Renamed 'IdentifyTopFatFlow' parameter to EnableFatFlowLogging on AzureFirewall (Azure#19234)
* Renamed 'IdentifyTopFatFlow' parameter to `EnableFatFlowLogging` on `AzureFirewall` * Added CmdletParameterBreakingChange attribute * Adding an alias instead breaking change * suppressed the breaking change static analysis error * Removed blank lines from csv * Revert "Adding an alias instead breaking change" This reverts commit e6adf8a3db4bc0e36d20243b014c4174ed265cbe. * Reverted breaking change suppression * Removed blank lines * Added breaking change attributes * Adding an alias instead breaking change * Revert "Adding an alias instead breaking change" This reverts commit e6adf8a3db4bc0e36d20243b014c4174ed265cbe. * Merged conflicts * Update BreakingChangeIssues.csv Co-authored-by: Gizachew Eshetie <[email protected]> Co-authored-by: Yunchi Wang <[email protected]>
1 parent 3c70692 commit 6cbf87c

File tree

11 files changed

+2321
-2081
lines changed

11 files changed

+2321
-2081
lines changed

‎src/Network/Network.Test/ScenarioTests/AzureFirewallTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,9 @@ public void TestAzureFirewallManagementNICBasicSku()
156156
[Fact]
157157
[Trait(Category.AcceptanceType, Category.CheckIn)]
158158
[Trait(Category.Owner, NrpTeamAlias.azurefirewall)]
159-
public void TestAzureFirewallCRUDIdentifyTopFatFlow()
159+
public void TestAzureFirewallCRUDEnableFatFlowLogging()
160160
{
161-
TestRunner.RunTestScript("Test-AzureFirewallCRUDIdentifyTopFatFlow");
161+
TestRunner.RunTestScript("Test-AzureFirewallCRUDEnableFatFlowLogging");
162162
}
163163

164164
[Fact]

‎src/Network/Network.Test/ScenarioTests/AzureFirewallTests.ps1

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1872,9 +1872,9 @@ function Test-AzureFirewallManagementNICBasicSku {
18721872
}
18731873
<#
18741874
.SYNOPSIS
1875-
Tests AzureFirewall IdentifyTopFatFlow
1875+
Tests AzureFirewall EnableFatFlowLogging
18761876
#>
1877-
function Test-AzureFirewallCRUDIdentifyTopFatFlow {
1877+
function Test-AzureFirewallCRUDEnableFatFlowLogging {
18781878
$rgname = Get-ResourceGroupName
18791879
$azureFirewallName = Get-ResourceName
18801880
$resourceTypeParent = "Microsoft.Network/AzureFirewalls"
@@ -1896,18 +1896,18 @@ function Test-AzureFirewallCRUDIdentifyTopFatFlow {
18961896
$publicip = New-AzPublicIpAddress -ResourceGroupName $rgname -name $publicIpName -location $location -AllocationMethod Static -Sku Standard
18971897

18981898
# Create AzureFirewall
1899-
$azureFirewall = New-AzFirewall -Name $azureFirewallName -ResourceGroupName $rgname -Location $location -IdentifyTopFatFlow
1899+
$azureFirewall = New-AzFirewall -Name $azureFirewallName -ResourceGroupName $rgname -Location $location -EnableFatFlowLogging
19001900

19011901
# Verify
19021902
$azFirewall = Get-AzFirewall -Name $azureFirewallName -ResourceGroupName $rgname
1903-
Assert-AreEqual true $azFirewall.IdentifyTopFatFlow
1903+
Assert-AreEqual true $azFirewall.EnableFatFlowLogging
19041904

1905-
# Reset the IdentifyTopFatFlow flag
1906-
$azFirewall.IdentifyTopFatFlow = $false
1905+
# Reset the EnableFatFlowLogging flag
1906+
$azFirewall.EnableFatFlowLogging = $false
19071907
Set-AzFirewall -AzureFirewall $azFirewall
19081908
$azfw = Get-AzFirewall -Name $azureFirewallName -ResourceGroupName $rgname
19091909

1910-
Assert-AreEqual false $azfw.IdentifyTopFatFlow
1910+
Assert-AreEqual false $azfw.EnableFatFlowLogging
19111911
}
19121912
finally {
19131913
# Cleanup

‎src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.AzureFirewallTests/TestAzureFirewallCRUDEnableFatFlowLogging.json

Lines changed: 2284 additions & 0 deletions
Large diffs are not rendered by default.

‎src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.AzureFirewallTests/TestAzureFirewallCRUDIdentifyTopFatFlow.json

Lines changed: 0 additions & 2056 deletions
This file was deleted.

‎src/Network/Network/AzureFirewall/NewAzureFirewallCommand.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -237,9 +237,9 @@ public class NewAzureFirewallCommand : AzureFirewallBaseCmdlet
237237
[CmdletParameterBreakingChange("IdentifyTopFatFlow", ReplaceMentCmdletParameterName = "EnableFatFlowLogging")]
238238
[Parameter(
239239
Mandatory = false,
240-
HelpMessage = "Identify Top Fat Flows. By default it is false."
240+
HelpMessage = "Enable Fat Flow Logging. By default it is false."
241241
)]
242-
public SwitchParameter IdentifyTopFatFlow { get; set; }
242+
public SwitchParameter EnableFatFlowLogging { get; set; }
243243

244244
[Parameter(
245245
Mandatory = false,
@@ -316,7 +316,7 @@ private PSAzureFirewall CreateAzureFirewall()
316316
FirewallPolicy = FirewallPolicyId != null ? new MNM.SubResource(FirewallPolicyId) : null,
317317
HubIPAddresses = this.HubIPAddress,
318318
Zones = this.Zone == null ? null : this.Zone.ToList(),
319-
IdentifyTopFatFlow = (this.IdentifyTopFatFlow.IsPresent ? "True" : null),
319+
EnableFatFlowLogging = (this.EnableFatFlowLogging.IsPresent ? "True" : null),
320320
EnableUDPLogOptimization = (this.EnableUDPLogOptimization.IsPresent ? "True" : null)
321321
};
322322
}
@@ -338,7 +338,7 @@ private PSAzureFirewall CreateAzureFirewall()
338338
DNSServer = this.DnsServer,
339339
AllowActiveFTP = (this.AllowActiveFTP.IsPresent ? "true" : null),
340340
Sku = sku,
341-
IdentifyTopFatFlow = (this.IdentifyTopFatFlow.IsPresent ? "True" : null),
341+
EnableFatFlowLogging = (this.EnableFatFlowLogging.IsPresent ? "True" : null),
342342
EnableUDPLogOptimization = (this.EnableUDPLogOptimization.IsPresent ? "True" : null)
343343
};
344344

‎src/Network/Network/ChangeLog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222

2323
* Added `EnableUDPLogOptimization` parameter to `AzureFirewall`
2424
- `New-AzFirewall`
25+
* Replaced `IdentifyTopFatFlow` parameter with 'EnableFatFlowLogging' parameter to `AzureFirewall`
26+
- `New-AzFirewall`
2527
* Fixed a bug not able to add MSSQL application rules to an AZURE FIREWALL POLICY
2628

2729
## Version 4.20.1

‎src/Network/Network/Common/NetworkResourceManagerProfile.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1307,7 +1307,7 @@ private static void Initialize()
13071307
{ "Network.FTP.AllowActiveFTP", src.AllowActiveFTP },
13081308
{ "Network.DNS.EnableProxy", src.DNSEnableProxy },
13091309
{ "Network.DNS.Servers", src.DNSServer?.Aggregate((result, item) => result + "," + item) },
1310-
{ "Network.AdditionalLogs.EnableFatFlowLogging", src.IdentifyTopFatFlow },
1310+
{ "Network.AdditionalLogs.EnableFatFlowLogging", src.EnableFatFlowLogging },
13111311
{ "Network.Logging.EnableUDPLogOptimization", src.EnableUDPLogOptimization },
13121312
}.Where(kvp => kvp.Value != null).ToDictionary(key => key.Key, val => val.Value); // TODO: remove after backend code is refactored
13131313
});
@@ -1355,7 +1355,7 @@ private static void Initialize()
13551355
}
13561356
dest.AllowActiveFTP = src.AdditionalProperties?.SingleOrDefault(kvp => kvp.Key.Equals("Network.FTP.AllowActiveFTP", StringComparison.OrdinalIgnoreCase)).Value;
13571357
dest.DNSEnableProxy = src.AdditionalProperties?.SingleOrDefault(kvp => kvp.Key.Equals("Network.DNS.EnableProxy", StringComparison.OrdinalIgnoreCase)).Value;
1358-
dest.IdentifyTopFatFlow = src.AdditionalProperties?.SingleOrDefault(kvp => kvp.Key.Equals("Network.AdditionalLogs.EnableFatFlowLogging", StringComparison.OrdinalIgnoreCase)).Value;
1358+
dest.EnableFatFlowLogging = src.AdditionalProperties?.SingleOrDefault(kvp => kvp.Key.Equals("Network.AdditionalLogs.EnableFatFlowLogging", StringComparison.OrdinalIgnoreCase)).Value;
13591359
dest.EnableUDPLogOptimization = src.AdditionalProperties?.SingleOrDefault(kvp => kvp.Key.Equals("Network.Logging.EnableUDPLogOptimization", StringComparison.OrdinalIgnoreCase)).Value;
13601360
try
13611361
{

‎src/Network/Network/Models/AzureFirewall/PSAzureFirewall.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ public string[] PrivateRange
7979

8080
public string AllowActiveFTP { get; set; }
8181

82-
public string IdentifyTopFatFlow { get; set; }
82+
public string EnableFatFlowLogging { get; set; }
8383

8484
public string EnableUDPLogOptimization { get; set; }
8585

‎src/Network/Network/help/New-AzFirewall.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ New-AzFirewall -Name <String> -ResourceGroupName <String> -Location <String>
2222
[-ThreatIntelWhitelist <PSAzureFirewallThreatIntelWhitelist>] [-PrivateRange <String[]>] [-EnableDnsProxy]
2323
[-DnsServer <String[]>] [-Tag <Hashtable>] [-Force] [-AsJob] [-Zone <String[]>] [-SkuName <String>]
2424
[-SkuTier <String>] [-VirtualHubId <String>] [-HubIPAddress <PSAzureFirewallHubIpAddresses>]
25-
[-FirewallPolicyId <String>] [-AllowActiveFTP] [-IdentifyTopFatFlow] [-EnableUDPLogOptimization]
25+
[-FirewallPolicyId <String>] [-AllowActiveFTP] [-EnableFatFlowLogging] [-EnableUDPLogOptimization]
2626
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2727
```
2828

@@ -35,7 +35,7 @@ New-AzFirewall -Name <String> -ResourceGroupName <String> -Location <String> -Vi
3535
[-ThreatIntelWhitelist <PSAzureFirewallThreatIntelWhitelist>] [-PrivateRange <String[]>] [-EnableDnsProxy]
3636
[-DnsServer <String[]>] [-Tag <Hashtable>] [-Force] [-AsJob] [-Zone <String[]>] [-SkuName <String>]
3737
[-SkuTier <String>] [-VirtualHubId <String>] [-HubIPAddress <PSAzureFirewallHubIpAddresses>]
38-
[-FirewallPolicyId <String>] [-AllowActiveFTP] [-IdentifyTopFatFlow] [-EnableUDPLogOptimization]
38+
[-FirewallPolicyId <String>] [-AllowActiveFTP] [-EnableFatFlowLogging] [-EnableUDPLogOptimization]
3939
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
4040
```
4141

@@ -49,7 +49,7 @@ New-AzFirewall -Name <String> -ResourceGroupName <String> -Location <String> -Vi
4949
[-ThreatIntelWhitelist <PSAzureFirewallThreatIntelWhitelist>] [-PrivateRange <String[]>] [-EnableDnsProxy]
5050
[-DnsServer <String[]>] [-Tag <Hashtable>] [-Force] [-AsJob] [-Zone <String[]>] [-SkuName <String>]
5151
[-SkuTier <String>] [-VirtualHubId <String>] [-HubIPAddress <PSAzureFirewallHubIpAddresses>]
52-
[-FirewallPolicyId <String>] [-AllowActiveFTP] [-IdentifyTopFatFlow] [-EnableUDPLogOptimization]
52+
[-FirewallPolicyId <String>] [-AllowActiveFTP] [-EnableFatFlowLogging] [-EnableUDPLogOptimization]
5353
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
5454
```
5555

@@ -418,8 +418,8 @@ Accept pipeline input: False
418418
Accept wildcard characters: False
419419
```
420420
421-
### -IdentifyTopFatFlow
422-
Identify Top Fat Flows. By default it is false.
421+
### -EnableFatFlowLogging
422+
Enable Fat Flow Logging. By default it is false.
423423
424424
```yaml
425425
Type: System.Management.Automation.SwitchParameter

‎src/Network/Network/help/Set-AzFirewall.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,10 @@ to the virtual hub but preserves the firewall's configuration. For changes to be
173173
The Allocate method assigns the virtual hub reference to the firewall. Again, for changes to be reflected in cloud,
174174
Set-AzFirewall must be called.
175175

176-
### 13: Identify Top Fat Flows on Azure Firewall
176+
### 13: Enable Fat Flow Logging on Azure Firewall
177177
```powershell
178178
$azFw = Get-AzFirewall -Name "ps184" -ResourceGroupName "ps774"
179-
$azFw.IdentifyTopFatFlow = $true
179+
$azFw.EnableFatFlowLogging = $true
180180
181181
$azFw | Set-AzFirewall
182182
```
@@ -192,7 +192,7 @@ $azFw | Set-AzFirewall
192192
FirewallPolicy : null
193193
HubIPAddresses : null
194194
Id : "/subscriptions/aeb5b02a-0f18-45a4-86d6-81808115cacf/resourceGroups/ps774/providers/Microsoft.Network/azureFirewalls/ps184"
195-
IdentifyTopFatFlow : "true"
195+
EnableFatFlowLogging : "true"
196196
IpConfigurations : Count = 0
197197
IpConfigurationsText : "[]"
198198
Location : "eastus"
@@ -221,7 +221,7 @@ $azFw | Set-AzFirewall
221221
222222
```
223223

224-
In this example, Identify Top Fat Flows is enabled on the Firewall.
224+
In this example, Enable Fat Flow Logging is enabled on the Firewall.
225225

226226
## PARAMETERS
227227

0 commit comments

Comments
 (0)