Skip to content

Commit fcfb55c

Browse files
author
Riddhi Nilawar
committed
Help generation
1 parent 611f010 commit fcfb55c

File tree

2 files changed

+76
-49
lines changed

2 files changed

+76
-49
lines changed

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

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,58 +15,58 @@ Create or update a flow log resource for the specified network security group.
1515
### SetByName (Default)
1616
```
1717
New-AzNetworkWatcherFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String>
18-
-TargetResourceId <String> -StorageId <String> [-EnabledFilteringCriteria <String>] -Enabled <Boolean>
19-
[-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>]
20-
[-Tag <Hashtable>] [-UserAssignedIdentityId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>]
21-
[-WhatIf] [-Confirm] [<CommonParameters>]
18+
-TargetResourceId <String> -StorageId <String> [-EnabledFilteringCriteria <String>] [-RecordType <String>]
19+
-Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>]
20+
[-FormatVersion <Int32>] [-Tag <Hashtable>] [-UserAssignedIdentityId <String>] [-Force]
21+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2222
```
2323

2424
### SetByResource
2525
```
2626
New-AzNetworkWatcherFlowLog -NetworkWatcher <PSNetworkWatcher> -Name <String> -TargetResourceId <String>
27-
-StorageId <String> [-EnabledFilteringCriteria <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
28-
[-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>] [-Tag <Hashtable>]
29-
[-UserAssignedIdentityId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>]
27+
-StorageId <String> [-EnabledFilteringCriteria <String>] [-RecordType <String>] -Enabled <Boolean>
28+
[-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>]
29+
[-Tag <Hashtable>] [-UserAssignedIdentityId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>]
3030
[-WhatIf] [-Confirm] [<CommonParameters>]
3131
```
3232

3333
### SetByResourceWithTA
3434
```
3535
New-AzNetworkWatcherFlowLog -NetworkWatcher <PSNetworkWatcher> -Name <String> -TargetResourceId <String>
36-
-StorageId <String> [-EnabledFilteringCriteria <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
37-
[-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>] [-EnableTrafficAnalytics]
38-
[-TrafficAnalyticsWorkspaceId <String>] [-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>]
39-
[-UserAssignedIdentityId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>]
36+
-StorageId <String> [-EnabledFilteringCriteria <String>] [-RecordType <String>] -Enabled <Boolean>
37+
[-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>]
38+
[-EnableTrafficAnalytics] [-TrafficAnalyticsWorkspaceId <String>] [-TrafficAnalyticsInterval <Int32>]
39+
[-Tag <Hashtable>] [-UserAssignedIdentityId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>]
4040
[-WhatIf] [-Confirm] [<CommonParameters>]
4141
```
4242

4343
### SetByNameWithTA
4444
```
4545
New-AzNetworkWatcherFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String>
46-
-TargetResourceId <String> -StorageId <String> [-EnabledFilteringCriteria <String>] -Enabled <Boolean>
47-
[-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>]
48-
[-EnableTrafficAnalytics] [-TrafficAnalyticsWorkspaceId <String>] [-TrafficAnalyticsInterval <Int32>]
49-
[-Tag <Hashtable>] [-UserAssignedIdentityId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>]
50-
[-WhatIf] [-Confirm] [<CommonParameters>]
46+
-TargetResourceId <String> -StorageId <String> [-EnabledFilteringCriteria <String>] [-RecordType <String>]
47+
-Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>]
48+
[-FormatVersion <Int32>] [-EnableTrafficAnalytics] [-TrafficAnalyticsWorkspaceId <String>]
49+
[-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-UserAssignedIdentityId <String>] [-Force]
50+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
5151
```
5252

5353
### SetByLocation
5454
```
5555
New-AzNetworkWatcherFlowLog -Location <String> -Name <String> -TargetResourceId <String> -StorageId <String>
56-
[-EnabledFilteringCriteria <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
56+
[-EnabledFilteringCriteria <String>] [-RecordType <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
5757
[-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>] [-Tag <Hashtable>]
58-
[-UserAssignedIdentityId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>]
59-
[-WhatIf] [-Confirm] [<CommonParameters>]
58+
[-UserAssignedIdentityId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
59+
[<CommonParameters>]
6060
```
6161

6262
### SetByLocationWithTA
6363
```
6464
New-AzNetworkWatcherFlowLog -Location <String> -Name <String> -TargetResourceId <String> -StorageId <String>
65-
[-EnabledFilteringCriteria <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
65+
[-EnabledFilteringCriteria <String>] [-RecordType <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
6666
[-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>] [-EnableTrafficAnalytics]
6767
[-TrafficAnalyticsWorkspaceId <String>] [-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>]
68-
[-UserAssignedIdentityId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>]
69-
[-WhatIf] [-Confirm] [<CommonParameters>]
68+
[-UserAssignedIdentityId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
69+
[<CommonParameters>]
7070
```
7171

7272
## DESCRIPTION
@@ -338,6 +338,21 @@ Accept pipeline input: False
338338
Accept wildcard characters: False
339339
```
340340
341+
### -RecordType
342+
Optional field to filter network traffic logs based on flow states.
343+
344+
```yaml
345+
Type: System.String
346+
Parameter Sets: (All)
347+
Aliases:
348+
349+
Required: False
350+
Position: Named
351+
Default value: None
352+
Accept pipeline input: False
353+
Accept wildcard characters: False
354+
```
355+
341356
### -ResourceGroupName
342357
The name of the network watcher resource group.
343358

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

Lines changed: 39 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -15,56 +15,54 @@ Updates flow log resource.
1515
### SetByName (Default)
1616
```
1717
Set-AzNetworkWatcherFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String>
18-
-TargetResourceId <String> -StorageId <String> [-EnabledFilteringCriteria <String>] -Enabled <Boolean>
19-
[-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>]
18+
-TargetResourceId <String> -StorageId <String> [-EnabledFilteringCriteria <String>] [-RecordType <String>]
19+
-Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>]
2020
[-UserAssignedIdentityId <String>] [-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force]
21-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
22-
[<CommonParameters>]
21+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2322
```
2423

2524
### SetByResource
2625
```
2726
Set-AzNetworkWatcherFlowLog -NetworkWatcher <PSNetworkWatcher> -Name <String> -TargetResourceId <String>
28-
-StorageId <String> [-EnabledFilteringCriteria <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
29-
[-RetentionPolicyDays <Int32>] [-FormatType <String>] [-UserAssignedIdentityId <String>]
30-
[-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>]
31-
[-WhatIf] [-Confirm] [<CommonParameters>]
27+
-StorageId <String> [-EnabledFilteringCriteria <String>] [-RecordType <String>] -Enabled <Boolean>
28+
[-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>]
29+
[-UserAssignedIdentityId <String>] [-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force]
30+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3231
```
3332

3433
### SetByResourceWithTA
3534
```
3635
Set-AzNetworkWatcherFlowLog -NetworkWatcher <PSNetworkWatcher> -Name <String> -TargetResourceId <String>
37-
-StorageId <String> [-EnabledFilteringCriteria <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
38-
[-RetentionPolicyDays <Int32>] [-FormatType <String>] [-UserAssignedIdentityId <String>]
39-
[-FormatVersion <Int32>] [-EnableTrafficAnalytics] [-TrafficAnalyticsWorkspaceId <String>]
40-
[-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>]
41-
[-WhatIf] [-Confirm] [<CommonParameters>]
36+
-StorageId <String> [-EnabledFilteringCriteria <String>] [-RecordType <String>] -Enabled <Boolean>
37+
[-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>]
38+
[-UserAssignedIdentityId <String>] [-FormatVersion <Int32>] [-EnableTrafficAnalytics]
39+
[-TrafficAnalyticsWorkspaceId <String>] [-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force]
40+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
4241
```
4342

4443
### SetByNameWithTA
4544
```
4645
Set-AzNetworkWatcherFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String>
47-
-TargetResourceId <String> -StorageId <String> [-EnabledFilteringCriteria <String>] -Enabled <Boolean>
48-
[-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>]
46+
-TargetResourceId <String> -StorageId <String> [-EnabledFilteringCriteria <String>] [-RecordType <String>]
47+
-Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>]
4948
[-UserAssignedIdentityId <String>] [-FormatVersion <Int32>] [-EnableTrafficAnalytics]
5049
[-TrafficAnalyticsWorkspaceId <String>] [-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force]
51-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
52-
[<CommonParameters>]
50+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
5351
```
5452

5553
### SetByLocation
5654
```
5755
Set-AzNetworkWatcherFlowLog -Location <String> -Name <String> -TargetResourceId <String> -StorageId <String>
58-
[-EnabledFilteringCriteria <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
56+
[-EnabledFilteringCriteria <String>] [-RecordType <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
5957
[-RetentionPolicyDays <Int32>] [-FormatType <String>] [-UserAssignedIdentityId <String>]
60-
[-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>]
61-
[-WhatIf] [-Confirm] [<CommonParameters>]
58+
[-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
59+
[-Confirm] [<CommonParameters>]
6260
```
6361

6462
### SetByLocationWithTA
6563
```
6664
Set-AzNetworkWatcherFlowLog -Location <String> -Name <String> -TargetResourceId <String> -StorageId <String>
67-
[-EnabledFilteringCriteria <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
65+
[-EnabledFilteringCriteria <String>] [-RecordType <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
6866
[-RetentionPolicyDays <Int32>] [-FormatType <String>] [-UserAssignedIdentityId <String>]
6967
[-FormatVersion <Int32>] [-EnableTrafficAnalytics] [-TrafficAnalyticsWorkspaceId <String>]
7068
[-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>]
@@ -74,16 +72,16 @@ Set-AzNetworkWatcherFlowLog -Location <String> -Name <String> -TargetResourceId
7472
### SetByResourceId
7573
```
7674
Set-AzNetworkWatcherFlowLog -ResourceId <String> -TargetResourceId <String> -StorageId <String>
77-
[-EnabledFilteringCriteria <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
75+
[-EnabledFilteringCriteria <String>] [-RecordType <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
7876
[-RetentionPolicyDays <Int32>] [-FormatType <String>] [-UserAssignedIdentityId <String>]
79-
[-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>]
80-
[-WhatIf] [-Confirm] [<CommonParameters>]
77+
[-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
78+
[-Confirm] [<CommonParameters>]
8179
```
8280

8381
### SetByResourceIdWithTA
8482
```
8583
Set-AzNetworkWatcherFlowLog -ResourceId <String> -TargetResourceId <String> -StorageId <String>
86-
[-EnabledFilteringCriteria <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
84+
[-EnabledFilteringCriteria <String>] [-RecordType <String>] -Enabled <Boolean> [-EnableRetention <Boolean>]
8785
[-RetentionPolicyDays <Int32>] [-FormatType <String>] [-UserAssignedIdentityId <String>]
8886
[-FormatVersion <Int32>] [-EnableTrafficAnalytics] [-TrafficAnalyticsWorkspaceId <String>]
8987
[-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>]
@@ -93,8 +91,7 @@ Set-AzNetworkWatcherFlowLog -ResourceId <String> -TargetResourceId <String> -Sto
9391
### SetByInputObject
9492
```
9593
Set-AzNetworkWatcherFlowLog -InputObject <PSFlowLogResource> [-UserAssignedIdentityId <String>] [-Force]
96-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
97-
[<CommonParameters>]
94+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
9895
```
9996

10097
## DESCRIPTION
@@ -342,6 +339,21 @@ Accept pipeline input: False
342339
Accept wildcard characters: False
343340
```
344341
342+
### -RecordType
343+
Optional field to filter network traffic logs.
344+
345+
```yaml
346+
Type: System.String
347+
Parameter Sets: SetByName, SetByResource, SetByResourceWithTA, SetByNameWithTA, SetByLocation, SetByLocationWithTA, SetByResourceId, SetByResourceIdWithTA
348+
Aliases:
349+
350+
Required: False
351+
Position: Named
352+
Default value: None
353+
Accept pipeline input: False
354+
Accept wildcard characters: False
355+
```
356+
345357
### -ResourceGroupName
346358
The name of the network watcher resource group.
347359

0 commit comments

Comments
 (0)