Note: We are creating a new api-version with this change. Watchlists.…

…json 2022-01-01-preview parameter name changes (#17848) * changed source to sourceType and watchlistAlias to alias * Update CreateWatchlistAndWatchlistItems.json * Update CreateWatchlistItem.json * Update DeleteWatchlist.json * Update DeleteWatchlistItem.json * Update GetWatchlistByAlias.json * Update GetWatchlistItemById.json * Update GetWatchlistItems.json * Update GetWatchlistByAlias.json * added missing params to match stable version * Revert "added missing params to match stable version" This reverts commit a30a709. Reverting by 1 commit * refreshing pipeline * reverting lint diff change * attempting to fix RemovedPath breaking changes * Revert "attempting to fix RemovedPath breaking changes" This reverts commit 2f96ee3. reverting attempt at correcting breaking changes. cannot match preview to stable without breaking everything. * adding back source type for backwards compatibility, added response descriptions, corrected PR comments * adding missing bracket * ran npm run prettier-fix to correct style issues * resolving model/definition errors * Revert "resolving model/definition errors" This reverts commit fd67a4f. Reverting prettier changes made to other branches * Revert "ran npm run prettier-fix to correct style issues" This reverts commit 3055791. * update * Update DeleteWatchlist.json * Update Watchlists.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * fixing styling issues on Delete example * Update DeleteWatchlist.json * Update DeleteWatchlist.json * ran npm run prettier on DeleteWatchlist.json * Update Watchlists.json * reverting alias to watchlistAlias Co-authored-by: Hassan Chawiche <hassanc@microsoft.com>
Azure · Mar 2, 2022 · c206825 · c206825
1 parent 97875d5
commit c206825
Show file tree

Hide file tree

Showing 10 changed files with 64 additions and 20 deletions.
diff --git a/...ts/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json b/...ts/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json
@@ -58,6 +58,9 @@
           },
           {
             "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
+          },
+          {
+            "$ref": "../../../common/1.0/types.json#/parameters/ODataSkipToken"
           }
         ],
         "responses": {
@@ -155,6 +158,18 @@
           "200": {
             "description": "OK"
           },
+          "202": {
+            "description": "Accepted",
+            "schema": {
+              "$ref": "#/definitions/Watchlist"
+            },
+            "headers": {
+              "Azure-AsyncOperation": {
+                "description": "Contains the status URL on which clients are expected to poll the status of the delete operation.",
+                "type": "string"
+              }
+            }
+          },
           "204": {
             "description": "No Content"
           },
@@ -178,7 +193,7 @@
         "tags": [
           "Watchlists"
         ],
-        "description": "Creates or updates a watchlist and its watchlist items (bulk creation, e.g. through text/csv content type). To create a Watchlist and its items, we should call this endpoint with rawContent and contentType properties.",
+        "description": "Create or update a Watchlist and its Watchlist Items (bulk creation, e.g. through text/csv content type). To create a Watchlist and its Items, we should call this endpoint with either rawContent or a valid SAR URI and contentType properties. The rawContent is mainly used for small watchlist (content size below 3.8 MB). The SAS URI enables the creation of large watchlist, where the content size can go up to 500 MB. The status of processing such large file can be polled through the URL returned in Azure-AsyncOperation header.",
         "operationId": "Watchlists_CreateOrUpdate",
         "parameters": [
           {
@@ -208,9 +223,15 @@
             }
           },
           "201": {
-            "description": "Created",
+            "description": "Created. The response includes the Provisioning State and the Azure-AsyncOperation header. To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field.",
             "schema": {
               "$ref": "#/definitions/Watchlist"
+            },
+            "headers": {
+              "Azure-AsyncOperation": {
+                "description": "Contains the status URL on which clients are expected to poll the status of the operation.",
+                "type": "string"
+              }
             }
           },
           "default": {
@@ -247,6 +268,9 @@
           {
             "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
           },
+          {
+            "$ref": "../../../common/1.0/types.json#/parameters/ODataSkipToken"
+          },
           {
             "$ref": "#/parameters/WatchlistAlias"
           }
@@ -423,6 +447,7 @@
   "definitions": {
     "WatchlistList": {
       "description": "List all the watchlists.",
+      "type": "object",
       "properties": {
         "nextLink": {
           "description": "URL to fetch the next set of watchlists.",
@@ -437,7 +462,6 @@
           "type": "array"
         }
       },
-      "type": "object",
       "required": [
         "value"
       ]
@@ -474,15 +498,19 @@
           "type": "string"
         },
         "source": {
-          "description": "The source of the watchlist",
+          "description": "The filename of the watchlist, called 'source'",
+          "type": "string"
+        },
+        "sourceType": {
+          "description": "The sourceType of the watchlist",
           "enum": [
             "Local file",
             "Remote storage"
           ],
           "type": "string",
           "x-ms-enum": {
             "modelAsString": true,
-            "name": "source"
+            "name": "sourceType"
           }
         },
         "created": {
@@ -557,16 +585,10 @@
         "uploadStatus": {
           "description": "The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted",
           "type": "string"
-        },
-        "watchlistItemsCount": {
-          "description": "The number of Watchlist Items in the Watchlist",
-          "type": "integer",
-          "format": "int32"
         }
       },
       "required": [
         "displayName",
-        "source",
         "provider",
         "itemsSearchKey"
       ],

diff --git a/...soft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/CreateWatchlist.json b/...soft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/CreateWatchlist.json
@@ -9,7 +9,8 @@
       "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
       "properties": {
         "displayName": "High Value Assets Watchlist",
-        "source": "Local file",
+        "source": "watchlist.csv",
+        "sourceType": "Local file",
         "provider": "Microsoft",
         "description": "Watchlist from CSV content",
         "itemsSearchKey": "header1"
@@ -27,7 +28,8 @@
           "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
           "displayName": "High Value Assets Watchlist",
           "provider": "Microsoft",
-          "source": "Local file",
+          "source": "watchlist.csv",
+          "sourceType": "Local file",
           "created": "2020-09-28T00:26:54.7746089+00:00",
           "updated": "2020-09-28T00:26:57+00:00",
           "createdBy": {
@@ -59,7 +61,8 @@
           "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
           "displayName": "High Value Assets Watchlist",
           "provider": "Microsoft",
-          "source": "Local file",
+          "source": "watchlist.csv",
+          "sourceType": "Local file",
           "created": "2020-09-28T00:26:54.7746089+00:00",
           "updated": "2020-09-28T00:26:57+00:00",
           "createdBy": {

diff --git a/...ghts/preview/2022-01-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json b/...ghts/preview/2022-01-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json
@@ -4,12 +4,14 @@
     "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
     "resourceGroupName": "myRg",
     "workspaceName": "myWorkspace",
+    "operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
     "watchlistAlias": "highValueAsset",
     "watchlist": {
       "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
       "properties": {
         "displayName": "High Value Assets Watchlist",
-        "source": "Local file",
+        "source": "watchlist.csv",
+        "sourceType": "Local file",
         "provider": "Microsoft",
         "description": "Watchlist from CSV content",
         "numberOfLinesToSkip": 1,
@@ -30,7 +32,8 @@
           "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
           "displayName": "High Value Assets Watchlist",
           "provider": "Microsoft",
-          "source": "Local file",
+          "source": "watchlist.csv",
+          "sourceType": "Local file",
           "created": "2020-09-28T00:26:54.7746089+00:00",
           "updated": "2020-09-28T00:26:57+00:00",
           "createdBy": {
@@ -62,7 +65,8 @@
           "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
           "displayName": "High Value Assets Watchlist",
           "provider": "Microsoft",
-          "source": "Local file",
+          "source": "watchlist.csv",
+          "sourceType": "Local file",
           "created": "2020-09-28T00:26:54.7746089+00:00",
           "updated": "2020-09-28T00:26:57+00:00",
           "createdBy": {

diff --git a/....SecurityInsights/preview/2022-01-01-preview/examples/watchlists/CreateWatchlistItem.json b/....SecurityInsights/preview/2022-01-01-preview/examples/watchlists/CreateWatchlistItem.json
@@ -4,6 +4,7 @@
     "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
     "resourceGroupName": "myRg",
     "workspaceName": "myWorkspace",
+    "operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
     "watchlistAlias": "highValueAsset",
     "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842",
     "watchlistItem": {

diff --git a/...soft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/DeleteWatchlist.json b/...soft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/DeleteWatchlist.json
@@ -4,10 +4,17 @@
     "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
     "resourceGroupName": "myRg",
     "workspaceName": "myWorkspace",
+    "operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
     "watchlistAlias": "highValueAsset"
   },
   "responses": {
     "200": {},
+    "202": {
+      "headers": {
+        "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SecurityInsights/watchlists/1011-01/watchlistStatuses/00000000-0000-0000-0000-000000000000?api-version=2022-01-01-preview"
+      },
+      "body": {}
+    },
     "204": {}
   }
 }
diff --git a/....SecurityInsights/preview/2022-01-01-preview/examples/watchlists/DeleteWatchlistItem.json b/....SecurityInsights/preview/2022-01-01-preview/examples/watchlists/DeleteWatchlistItem.json
@@ -4,6 +4,7 @@
     "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
     "resourceGroupName": "myRg",
     "workspaceName": "myWorkspace",
+    "operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
     "watchlistAlias": "highValueAsset",
     "watchlistItemId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea"
   },

diff --git a/....SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlistByAlias.json b/....SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlistByAlias.json
@@ -4,6 +4,7 @@
     "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
     "resourceGroupName": "myRg",
     "workspaceName": "myWorkspace",
+    "operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
     "watchlistAlias": "highValueAsset"
   },
   "responses": {
@@ -17,7 +18,8 @@
           "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
           "displayName": "High Value Assets Watchlist",
           "provider": "Microsoft",
-          "source": "Local file",
+          "source": "watchlist.csv",
+          "sourceType": "Local file",
           "created": "2020-09-28T00:26:54.7746089+00:00",
           "updated": "2020-09-28T00:26:57+00:00",
           "createdBy": {

diff --git a/...SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlistItemById.json b/...SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlistItemById.json
@@ -4,6 +4,7 @@
     "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
     "resourceGroupName": "myRg",
     "workspaceName": "myWorkspace",
+    "operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
     "watchlistAlias": "highValueAsset",
     "watchlistItemId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797"
   },

diff --git a/...ft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlistItems.json b/...ft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlistItems.json
@@ -4,6 +4,7 @@
     "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
     "resourceGroupName": "myRg",
     "workspaceName": "myWorkspace",
+    "operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
     "watchlistAlias": "highValueAsset"
   },
   "responses": {

diff --git a/...rosoft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlists.json b/...rosoft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlists.json
@@ -3,7 +3,8 @@
     "api-version": "2022-01-01-preview",
     "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
     "resourceGroupName": "myRg",
-    "workspaceName": "myWorkspace"
+    "workspaceName": "myWorkspace",
+    "operationalInsightsResourceProvider": "Microsoft.OperationalInsights"
   },
   "responses": {
     "200": {
@@ -18,7 +19,8 @@
               "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
               "displayName": "High Value Assets Watchlist",
               "provider": "Microsoft",
-              "source": "Local file",
+              "source": "watchlist.csv",
+              "sourceType": "Local file",
               "created": "2020-09-28T00:26:54.7746089+00:00",
               "updated": "2020-09-28T00:26:57+00:00",
               "createdBy": {