Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Note: We are creating a new api-version with this change. Watchlists.json 2022-01-01-preview parameter name changes #17848

Merged
merged 37 commits into from
Mar 2, 2022
Merged

Note: We are creating a new api-version with this change. Watchlists.json 2022-01-01-preview parameter name changes #17848

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
366c79d
changed source to sourceType and watchlistAlias to alias
ushasan Feb 14, 2022
fa33c67
Update CreateWatchlistAndWatchlistItems.json
ushasan Feb 14, 2022
272963c
Update CreateWatchlistItem.json
ushasan Feb 14, 2022
fdbd91c
Update DeleteWatchlist.json
ushasan Feb 14, 2022
92a17ac
Update DeleteWatchlistItem.json
ushasan Feb 14, 2022
4518eb9
Update GetWatchlistByAlias.json
ushasan Feb 14, 2022
b3d96d5
Update GetWatchlistItemById.json
ushasan Feb 14, 2022
3ca7776
Update GetWatchlistItems.json
ushasan Feb 14, 2022
cb91843
Update GetWatchlistByAlias.json
ushasan Feb 14, 2022
a30a709
added missing params to match stable version
ushasan Feb 15, 2022
d98df0d
Revert "added missing params to match stable version"
ushasan Feb 15, 2022
6d11366
refreshing pipeline
ushasan Feb 16, 2022
b067d90
reverting lint diff change
ushasan Feb 16, 2022
2f96ee3
attempting to fix RemovedPath breaking changes
ushasan Feb 16, 2022
0f322ef
Revert "attempting to fix RemovedPath breaking changes"
ushasan Feb 16, 2022
9040d22
adding back source type for backwards compatibility, added response d…
ushasan Feb 22, 2022
0b61120
adding missing bracket
ushasan Feb 22, 2022
3055791
ran npm run prettier-fix to correct style issues
ushasan Feb 23, 2022
fd67a4f
resolving model/definition errors
ushasan Feb 25, 2022
3294bb5
Revert "resolving model/definition errors"
ushasan Feb 25, 2022
ccc4f7d
Revert "ran npm run prettier-fix to correct style issues"
ushasan Feb 25, 2022
8aed1c7
update
hassanchawiche Feb 25, 2022
f933b0a
Merge branch 'Watchlists.json-2022-01-01-preview-parameterNameChanges…
hassanchawiche Feb 25, 2022
552adf4
Update DeleteWatchlist.json
ushasan Feb 25, 2022
2d370ad
Update Watchlists.json
ushasan Feb 25, 2022
5557a0b
Update DeleteWatchlist.json
ushasan Feb 25, 2022
bddd1a7
Update DeleteWatchlist.json
ushasan Feb 25, 2022
db21ace
Update DeleteWatchlist.json
ushasan Feb 25, 2022
120ad44
Update DeleteWatchlist.json
ushasan Feb 25, 2022
94a5945
Update DeleteWatchlist.json
ushasan Feb 25, 2022
bf77754
Update DeleteWatchlist.json
ushasan Feb 28, 2022
f11e89b
fixing styling issues on Delete example
ushasan Feb 28, 2022
bbcbf77
Update DeleteWatchlist.json
ushasan Feb 28, 2022
9e00156
Update DeleteWatchlist.json
ushasan Feb 28, 2022
c2838a0
ran npm run prettier on DeleteWatchlist.json
ushasan Feb 28, 2022
61599bc
Update Watchlists.json
ushasan Feb 28, 2022
a09df08
reverting alias to watchlistAlias
ushasan Mar 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions ...ts/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{alias}": {
"get": {
"x-ms-examples": {
"Get a watchlist.": {
Expand All @@ -105,7 +105,7 @@
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/WatchlistAlias"
"$ref": "#/parameters/Alias"
}
],
"responses": {
Expand Down Expand Up @@ -148,7 +148,7 @@
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/WatchlistAlias"
"$ref": "#/parameters/Alias"
}
],
"responses": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add 202 status code along with description about the header that can be used to pull out the status of the delete.

Expand Down Expand Up @@ -194,7 +194,7 @@
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 181: Pls add a description like :
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.

{
"$ref": "#/parameters/WatchlistAlias"
"$ref": "#/parameters/Alias"
},
{
"$ref": "#/parameters/Watchlist"
Expand Down Expand Up @@ -222,7 +222,7 @@
}
ushasan marked this conversation as resolved.
Show resolved Hide resolved
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{alias}/watchlistItems": {
"get": {
"x-ms-examples": {
"Get all watchlist Items.": {
Expand All @@ -248,7 +248,7 @@
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/WatchlistAlias"
"$ref": "#/parameters/Alias"
}
],
"responses": {
Expand All @@ -270,7 +270,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{alias}/watchlistItems/{watchlistItemId}": {
"get": {
"x-ms-examples": {
"Get a watchlist item.": {
Expand All @@ -296,7 +296,7 @@
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/WatchlistAlias"
"$ref": "#/parameters/Alias"
},
{
"$ref": "#/parameters/WatchlistItemId"
Expand Down Expand Up @@ -342,7 +342,7 @@
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/WatchlistAlias"
"$ref": "#/parameters/Alias"
},
{
"$ref": "#/parameters/WatchlistItemId"
Expand Down Expand Up @@ -388,7 +388,7 @@
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/WatchlistAlias"
"$ref": "#/parameters/Alias"
},
{
"$ref": "#/parameters/WatchlistItemId"
Expand Down Expand Up @@ -473,16 +473,16 @@
"description": "The provider of the watchlist",
"type": "string"
},
"source": {
"description": "The source of the watchlist",
"sourceType": {
ushasan marked this conversation as resolved.
Show resolved Hide resolved
"description": "The sourceType of the watchlist",
"enum": [
"Local file",
"Remote storage"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "source"
"name": "sourceType"
}
},
"created": {
Expand Down Expand Up @@ -513,7 +513,7 @@
"description": "The type of the watchlist",
"type": "string"
},
"watchlistAlias": {
"alias": {
"description": "The alias of the watchlist",
"type": "string"
},
Expand Down Expand Up @@ -566,7 +566,7 @@
},
"required": [
ushasan marked this conversation as resolved.
Show resolved Hide resolved
"displayName",
"source",
"sourceType",
"provider",
"itemsSearchKey"
],
Expand Down Expand Up @@ -663,10 +663,10 @@
}
},
"parameters": {
"WatchlistAlias": {
"Alias": {
"description": "Watchlist Alias",
"in": "path",
"name": "watchlistAlias",
"name": "alias",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
Expand Down
12 changes: 6 additions & 6 deletions ...soft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/CreateWatchlist.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"watchlistAlias": "highValueAsset",
"alias": "highValueAsset",
"watchlist": {
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"displayName": "High Value Assets Watchlist",
"source": "Local file",
"sourceType": "Local file",
ushasan marked this conversation as resolved.
Show resolved Hide resolved
"provider": "Microsoft",
"description": "Watchlist from CSV content",
"itemsSearchKey": "header1"
Expand All @@ -27,7 +27,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "Local file",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
"createdBy": {
Expand All @@ -42,7 +42,7 @@
},
"description": "Watchlist from CSV content",
"watchlistType": "watchlist",
"watchlistAlias": "highValueAsset",
"alias": "highValueAsset",
"itemsSearchKey": "header1",
"isDeleted": false,
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
Expand All @@ -59,7 +59,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "Local file",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
"createdBy": {
Expand All @@ -74,7 +74,7 @@
},
"description": "Watchlist from CSV content",
"watchlistType": "watchlist",
"watchlistAlias": "highValueAsset",
"alias": "highValueAsset",
"itemsSearchKey": "header1",
"isDeleted": false,
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
Expand Down
12 changes: 6 additions & 6 deletions ...ghts/preview/2022-01-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"watchlistAlias": "highValueAsset",
"alias": "highValueAsset",
"watchlist": {
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"displayName": "High Value Assets Watchlist",
"source": "Local file",
"sourceType": "Local file",
"provider": "Microsoft",
"description": "Watchlist from CSV content",
"numberOfLinesToSkip": 1,
Expand All @@ -30,7 +30,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "Local file",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
"createdBy": {
Expand All @@ -45,7 +45,7 @@
},
"description": "Watchlist from CSV content",
"watchlistType": "watchlist",
"watchlistAlias": "highValueAsset",
"alias": "highValueAsset",
"itemsSearchKey": "header1",
"isDeleted": false,
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
Expand All @@ -62,7 +62,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "Local file",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
"createdBy": {
Expand All @@ -77,7 +77,7 @@
},
"description": "Watchlist from CSV content",
"watchlistType": "watchlist",
"watchlistAlias": "highValueAsset",
"alias": "highValueAsset",
"itemsSearchKey": "header1",
"isDeleted": false,
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
Expand Down
2 changes: 1 addition & 1 deletion ....SecurityInsights/preview/2022-01-01-preview/examples/watchlists/CreateWatchlistItem.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"watchlistAlias": "highValueAsset",
"alias": "highValueAsset",
"watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842",
"watchlistItem": {
"etag": "0300bf09-0000-0000-0000-5c37296e0000",
Expand Down
2 changes: 1 addition & 1 deletion ...soft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/DeleteWatchlist.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"watchlistAlias": "highValueAsset"
"alias": "highValueAsset"
},
"responses": {
"200": {},
Expand Down
2 changes: 1 addition & 1 deletion ....SecurityInsights/preview/2022-01-01-preview/examples/watchlists/DeleteWatchlistItem.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"watchlistAlias": "highValueAsset",
"alias": "highValueAsset",
"watchlistItemId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea"
},
"responses": {
Expand Down
6 changes: 3 additions & 3 deletions ....SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlistByAlias.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"watchlistAlias": "highValueAsset"
"alias": "highValueAsset"
},
"responses": {
"200": {
Expand All @@ -17,7 +17,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "Local file",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
"createdBy": {
Expand All @@ -32,7 +32,7 @@
},
"description": "Watchlist from CSV content",
"watchlistType": "watchlist",
"watchlistAlias": "highValueAsset",
"alias": "highValueAsset",
"itemsSearchKey": "header1",
"isDeleted": false,
"labels": [
Expand Down
2 changes: 1 addition & 1 deletion ...SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlistItemById.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"watchlistAlias": "highValueAsset",
"alias": "highValueAsset",
"watchlistItemId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797"
},
"responses": {
Expand Down
2 changes: 1 addition & 1 deletion ...ft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlistItems.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"watchlistAlias": "highValueAsset"
"alias": "highValueAsset"
},
"responses": {
"200": {
Expand Down
4 changes: 2 additions & 2 deletions ...rosoft.SecurityInsights/preview/2022-01-01-preview/examples/watchlists/GetWatchlists.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "Local file",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
"createdBy": {
Expand All @@ -33,7 +33,7 @@
},
"description": "Watchlist from CSV content",
"watchlistType": "watchlist",
"watchlistAlias": "highValueAsset",
"alias": "highValueAsset",
"itemsSearchKey": "header1",
"isDeleted": false,
"labels": [
Expand Down