Skip to content

Commit 4fd254a

Browse files
sayghoshsergey-shandar
authored andcommitted
Adding optional traffic analytics config fields to network watcher config object for enhancing the Network Watcher cmdlets (#3023)
* Adding optional traffic analytics parameters with existing network watched flowlog configuration * Updating the version * Updating latest versoin in readme.md
1 parent b3f5a7a commit 4fd254a

File tree

2 files changed

+53
-11
lines changed

2 files changed

+53
-11
lines changed

specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/networkWatcher.json

Lines changed: 53 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -895,11 +895,12 @@
895895
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog": {
896896
"post": {
897897
"tags": [
898-
"NetworkWatchers"
898+
"NetworkWatchers",
899+
"TrafficAnalytics"
899900
],
900901
"operationId": "NetworkWatchers_SetFlowLogConfiguration",
901902
"x-ms-long-running-operation": true,
902-
"description": "Configures flow log on a specified resource.",
903+
"description": "Configures flow log and traffic analytics (optional) on a specified resource.",
903904
"parameters": [
904905
{
905906
"name": "resourceGroupName",
@@ -933,7 +934,7 @@
933934
],
934935
"responses": {
935936
"200": {
936-
"description": "Successful request for setting flow log configuration.",
937+
"description": "Successful request for setting flow log and traffic analytics (optional) configuration.",
937938
"schema": {
938939
"$ref": "#/definitions/FlowLogInformation"
939940
}
@@ -950,11 +951,12 @@
950951
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus": {
951952
"post": {
952953
"tags": [
953-
"NetworkWatchers"
954+
"NetworkWatchers",
955+
"TrafficAnalytics"
954956
],
955957
"operationId": "NetworkWatchers_GetFlowLogStatus",
956958
"x-ms-long-running-operation": true,
957-
"description": "Queries status of flow log on a specified resource.",
959+
"description": "Queries status of flow log and traffic analytics (optional) on a specified resource.",
958960
"parameters": [
959961
{
960962
"name": "resourceGroupName",
@@ -977,7 +979,7 @@
977979
"schema": {
978980
"$ref": "#/definitions/FlowLogStatusParameters"
979981
},
980-
"description": "Parameters that define a resource to query flow log status."
982+
"description": "Parameters that define a resource to query flow log and traffic analytics (optional) status."
981983
},
982984
{
983985
"$ref": "#/parameters/ApiVersionParameter"
@@ -988,7 +990,7 @@
988990
],
989991
"responses": {
990992
"200": {
991-
"description": "Successful request for query flow log status.",
993+
"description": "Successful request for query flow log and traffic analytics (optional) status.",
992994
"schema": {
993995
"$ref": "#/definitions/FlowLogInformation"
994996
}
@@ -2252,13 +2254,13 @@
22522254
}
22532255
},
22542256
"FlowLogStatusParameters": {
2255-
"description": "Parameters that define a resource to query flow log status.",
2257+
"description": "Parameters that define a resource to query flow log and traffic analytics (optional) status.",
22562258
"required": [
22572259
"targetResourceId"
22582260
],
22592261
"properties": {
22602262
"targetResourceId": {
2261-
"description": "The target resource where getting the flow logging status.",
2263+
"description": "The target resource where getting the flow log and and traffic analytics (optional) status.",
22622264
"type": "string"
22632265
}
22642266
}
@@ -2279,7 +2281,7 @@
22792281
}
22802282
},
22812283
"FlowLogInformation": {
2282-
"description": "Information on the configuration of flow log.",
2284+
"description": "Information on the configuration of flow log and traffic analytics (optional) .",
22832285
"required": [
22842286
"targetResourceId",
22852287
"properties"
@@ -2292,6 +2294,47 @@
22922294
"properties": {
22932295
"x-ms-client-flatten": true,
22942296
"$ref": "#/definitions/FlowLogProperties"
2297+
},
2298+
"flowAnalyticsConfiguration": {
2299+
"$ref": "#/definitions/TrafficAnalyticsProperties"
2300+
}
2301+
}
2302+
},
2303+
"TrafficAnalyticsProperties": {
2304+
"description": "Parameters that define the configuration of traffic analytics.",
2305+
"required": [
2306+
"networkWatcherFlowAnalyticsConfiguration"
2307+
],
2308+
"properties": {
2309+
"networkWatcherFlowAnalyticsConfiguration": {
2310+
"$ref": "#/definitions/TrafficAnalyticsConfigurationProperties"
2311+
}
2312+
}
2313+
},
2314+
"TrafficAnalyticsConfigurationProperties": {
2315+
"description": "Parameters that define the configuration of traffic analytics.",
2316+
"required": [
2317+
"enabled",
2318+
"workspaceId",
2319+
"workspaceRegion",
2320+
"workspaceResourceId"
2321+
],
2322+
"properties": {
2323+
"enabled": {
2324+
"description": "Flag to enable/disable traffic analytics.",
2325+
"type": "boolean"
2326+
},
2327+
"workspaceId": {
2328+
"description": "The resource guid of the attached workspace",
2329+
"type": "string"
2330+
},
2331+
"workspaceRegion": {
2332+
"description": "The location of the attached workspace",
2333+
"type": "string"
2334+
},
2335+
"workspaceResourceId": {
2336+
"description": "Resource Id of the attached workspace ",
2337+
"type": "string"
22952338
}
22962339
}
22972340
},

specification/network/resource-manager/readme.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ These are the global settings for the Network API.
2828
title: NetworkManagementClient
2929
description: Network Client
3030
openapi-type: arm
31-
3231
tag: package-2018-05
3332
```
3433

0 commit comments

Comments
 (0)