Skip to content

Commit 5c1eee0

Browse files
committed
Adding help generation text
1 parent 4aa6eb0 commit 5c1eee0

File tree

1 file changed

+145
-8
lines changed

1 file changed

+145
-8
lines changed

src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkWatcherConfigFlowLog.md

Lines changed: 145 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,72 @@ Configures flow logging for a target resource.
1212

1313
## SYNTAX
1414

15-
### SetByResource (Default)
15+
### SetFlowlogByResourceWithoutTA (Default)
1616
```
1717
Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String>
1818
-EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>]
1919
[-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2020
```
2121

22-
### SetByName
22+
### SetFlowlogByResourceWithTAByResource
23+
```
24+
Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String>
25+
-EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>]
26+
[-AsJob] [-EnableTrafficAnalytics] -Workspace <IOperationalInsightWorkspace>
27+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
28+
```
29+
30+
### SetFlowlogByResourceWithTAByDetails
31+
```
32+
Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String>
33+
-EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>]
34+
[-AsJob] [-EnableTrafficAnalytics] -WorkspaceResourceId <String> -WorkspaceGUID <String>
35+
-WorkspaceLocation <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
36+
[<CommonParameters>]
37+
```
38+
39+
### SetFlowlogByNameWithTAByResource
40+
```
41+
Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcherName <String> -ResourceGroupName <String>
42+
-TargetResourceId <String> -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>]
43+
[-RetentionInDays <Int32>] [-AsJob] [-EnableTrafficAnalytics] -Workspace <IOperationalInsightWorkspace>
44+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
45+
```
46+
47+
### SetFlowlogByNameWithTAByDetails
48+
```
49+
Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcherName <String> -ResourceGroupName <String>
50+
-TargetResourceId <String> -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>]
51+
[-RetentionInDays <Int32>] [-AsJob] [-EnableTrafficAnalytics] -WorkspaceResourceId <String>
52+
-WorkspaceGUID <String> -WorkspaceLocation <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
53+
[-Confirm] [<CommonParameters>]
54+
```
55+
56+
### SetFlowlogByNameWithoutTA
2357
```
2458
Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcherName <String> -ResourceGroupName <String>
2559
-TargetResourceId <String> -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>]
2660
[-RetentionInDays <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
2761
[<CommonParameters>]
2862
```
2963

30-
### SetByLocation
64+
### SetFlowlogByLocationWithTAByResource
65+
```
66+
Set-AzureRmNetworkWatcherConfigFlowLog -Location <String> -TargetResourceId <String> -EnableFlowLog <Boolean>
67+
-StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] [-AsJob]
68+
[-EnableTrafficAnalytics] -Workspace <IOperationalInsightWorkspace> [-DefaultProfile <IAzureContextContainer>]
69+
[-WhatIf] [-Confirm] [<CommonParameters>]
70+
```
71+
72+
### SetFlowlogByLocationWithTAByDetails
73+
```
74+
Set-AzureRmNetworkWatcherConfigFlowLog -Location <String> -TargetResourceId <String> -EnableFlowLog <Boolean>
75+
-StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] [-AsJob]
76+
[-EnableTrafficAnalytics] -WorkspaceResourceId <String> -WorkspaceGUID <String> -WorkspaceLocation <String>
77+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
78+
```
79+
80+
### SetFlowlogByLocationWithoutTA
3181
```
3282
Set-AzureRmNetworkWatcherConfigFlowLog -Location <String> -TargetResourceId <String> -EnableFlowLog <Boolean>
3383
-StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] [-AsJob]
@@ -123,18 +173,33 @@ Accept pipeline input: True (ByPropertyName)
123173
Accept wildcard characters: False
124174
```
125175
176+
### -EnableTrafficAnalytics
177+
Flag to enable/disable retention.
178+
179+
```yaml
180+
Type: SwitchParameter
181+
Parameter Sets: SetFlowlogByResourceWithTAByResource, SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByResource, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByResource, SetFlowlogByLocationWithTAByDetails
182+
Aliases: EnableTA
183+
184+
Required: False
185+
Position: Named
186+
Default value: None
187+
Accept pipeline input: False
188+
Accept wildcard characters: False
189+
```
190+
126191
### -Location
127192
Location of the network watcher.
128193
129194
```yaml
130195
Type: String
131-
Parameter Sets: SetByLocation
196+
Parameter Sets: SetFlowlogByLocationWithTAByResource, SetFlowlogByLocationWithTAByDetails, SetFlowlogByLocationWithoutTA
132197
Aliases:
133198

134199
Required: True
135200
Position: Named
136201
Default value: None
137-
Accept pipeline input: False
202+
Accept pipeline input: True (ByPropertyName)
138203
Accept wildcard characters: False
139204
```
140205
@@ -143,7 +208,7 @@ The network watcher resource.
143208
144209
```yaml
145210
Type: PSNetworkWatcher
146-
Parameter Sets: SetByResource
211+
Parameter Sets: SetFlowlogByResourceWithoutTA, SetFlowlogByResourceWithTAByResource, SetFlowlogByResourceWithTAByDetails
147212
Aliases:
148213

149214
Required: True
@@ -158,7 +223,7 @@ The name of network watcher.
158223
159224
```yaml
160225
Type: String
161-
Parameter Sets: SetByName
226+
Parameter Sets: SetFlowlogByNameWithTAByResource, SetFlowlogByNameWithTAByDetails, SetFlowlogByNameWithoutTA
162227
Aliases: Name
163228

164229
Required: True
@@ -173,7 +238,7 @@ The name of the network watcher resource group.
173238
174239
```yaml
175240
Type: String
176-
Parameter Sets: SetByName
241+
Parameter Sets: SetFlowlogByNameWithTAByResource, SetFlowlogByNameWithTAByDetails, SetFlowlogByNameWithoutTA
177242
Aliases:
178243

179244
Required: True
@@ -228,6 +293,78 @@ Accept pipeline input: True (ByPropertyName)
228293
Accept wildcard characters: False
229294
```
230295
296+
### -Workspace
297+
The WS object which is used to store the traffic analytics data.
298+
299+
```yaml
300+
Type: IOperationalInsightWorkspace
301+
Parameter Sets: SetFlowlogByResourceWithTAByResource
302+
Aliases:
303+
304+
Required: True
305+
Position: Named
306+
Default value: None
307+
Accept pipeline input: True (ByPropertyName)
308+
Accept wildcard characters: False
309+
```
310+
311+
```yaml
312+
Type: IOperationalInsightWorkspace
313+
Parameter Sets: SetFlowlogByNameWithTAByResource, SetFlowlogByLocationWithTAByResource
314+
Aliases:
315+
316+
Required: True
317+
Position: Named
318+
Default value: None
319+
Accept pipeline input: True (ByPropertyName)
320+
Accept wildcard characters: False
321+
```
322+
323+
### -WorkspaceGUID
324+
GUID of the WS which is used to store the traffic analytics data.
325+
326+
```yaml
327+
Type: String
328+
Parameter Sets: SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByDetails
329+
Aliases:
330+
331+
Required: True
332+
Position: Named
333+
Default value: None
334+
Accept pipeline input: True (ByPropertyName)
335+
Accept wildcard characters: False
336+
```
337+
338+
### -WorkspaceLocation
339+
Azure Region of the WS which is used to store the traffic analytics data.
340+
341+
```yaml
342+
Type: String
343+
Parameter Sets: SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByDetails
344+
Aliases:
345+
346+
Required: True
347+
Position: Named
348+
Default value: None
349+
Accept pipeline input: True (ByPropertyName)
350+
Accept wildcard characters: False
351+
```
352+
353+
### -WorkspaceResourceId
354+
Subscription of the WS which is used to store the traffic analytics data.
355+
356+
```yaml
357+
Type: String
358+
Parameter Sets: SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByDetails
359+
Aliases:
360+
361+
Required: True
362+
Position: Named
363+
Default value: None
364+
Accept pipeline input: True (ByPropertyName)
365+
Accept wildcard characters: False
366+
```
367+
231368
### -Confirm
232369
Prompts you for confirmation before running the cmdlet.
233370

0 commit comments

Comments
 (0)