|
| 1 | +{ |
| 2 | + "swagger": "2.0", |
| 3 | + "info": { |
| 4 | + "title": "Security Insights", |
| 5 | + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", |
| 6 | + "version": "2021-10-01" |
| 7 | + }, |
| 8 | + "host": "management.azure.com", |
| 9 | + "schemes": [ |
| 10 | + "https" |
| 11 | + ], |
| 12 | + "consumes": [ |
| 13 | + "application/json" |
| 14 | + ], |
| 15 | + "produces": [ |
| 16 | + "application/json" |
| 17 | + ], |
| 18 | + "security": [ |
| 19 | + { |
| 20 | + "azure_auth": [ |
| 21 | + "user_impersonation" |
| 22 | + ] |
| 23 | + } |
| 24 | + ], |
| 25 | + "securityDefinitions": { |
| 26 | + "azure_auth": { |
| 27 | + "type": "oauth2", |
| 28 | + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", |
| 29 | + "flow": "implicit", |
| 30 | + "description": "Azure Active Directory OAuth2 Flow", |
| 31 | + "scopes": { |
| 32 | + "user_impersonation": "impersonate your user account" |
| 33 | + } |
| 34 | + } |
| 35 | + }, |
| 36 | + "paths": { |
| 37 | + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks": { |
| 38 | + "get": { |
| 39 | + "x-ms-examples": { |
| 40 | + "Get all bookmarks.": { |
| 41 | + "$ref": "./examples/bookmarks/GetBookmarks.json" |
| 42 | + } |
| 43 | + }, |
| 44 | + "tags": [ |
| 45 | + "Bookmarks" |
| 46 | + ], |
| 47 | + "description": "Gets all bookmarks.", |
| 48 | + "operationId": "Bookmarks_List", |
| 49 | + "parameters": [ |
| 50 | + { |
| 51 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" |
| 52 | + }, |
| 53 | + { |
| 54 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" |
| 55 | + }, |
| 56 | + { |
| 57 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" |
| 58 | + }, |
| 59 | + { |
| 60 | + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" |
| 61 | + } |
| 62 | + ], |
| 63 | + "responses": { |
| 64 | + "200": { |
| 65 | + "description": "OK, Operation successfully completed", |
| 66 | + "schema": { |
| 67 | + "$ref": "#/definitions/BookmarkList" |
| 68 | + } |
| 69 | + }, |
| 70 | + "default": { |
| 71 | + "description": "Error response describing why the operation failed.", |
| 72 | + "schema": { |
| 73 | + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" |
| 74 | + } |
| 75 | + } |
| 76 | + }, |
| 77 | + "x-ms-pageable": { |
| 78 | + "nextLinkName": "nextLink" |
| 79 | + } |
| 80 | + } |
| 81 | + }, |
| 82 | + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}": { |
| 83 | + "get": { |
| 84 | + "x-ms-examples": { |
| 85 | + "Get a bookmark.": { |
| 86 | + "$ref": "./examples/bookmarks/GetBookmarkById.json" |
| 87 | + } |
| 88 | + }, |
| 89 | + "tags": [ |
| 90 | + "Bookmarks" |
| 91 | + ], |
| 92 | + "description": "Gets a bookmark.", |
| 93 | + "operationId": "Bookmarks_Get", |
| 94 | + "parameters": [ |
| 95 | + { |
| 96 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" |
| 97 | + }, |
| 98 | + { |
| 99 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" |
| 100 | + }, |
| 101 | + { |
| 102 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" |
| 103 | + }, |
| 104 | + { |
| 105 | + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" |
| 106 | + }, |
| 107 | + { |
| 108 | + "$ref": "#/parameters/BookmarkId" |
| 109 | + } |
| 110 | + ], |
| 111 | + "responses": { |
| 112 | + "200": { |
| 113 | + "description": "OK, Operation successfully completed", |
| 114 | + "schema": { |
| 115 | + "$ref": "#/definitions/Bookmark" |
| 116 | + } |
| 117 | + }, |
| 118 | + "default": { |
| 119 | + "description": "Error response describing why the operation failed.", |
| 120 | + "schema": { |
| 121 | + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" |
| 122 | + } |
| 123 | + } |
| 124 | + } |
| 125 | + }, |
| 126 | + "put": { |
| 127 | + "x-ms-examples": { |
| 128 | + "Creates or updates a bookmark.": { |
| 129 | + "$ref": "./examples/bookmarks/CreateBookmark.json" |
| 130 | + } |
| 131 | + }, |
| 132 | + "tags": [ |
| 133 | + "Bookmarks" |
| 134 | + ], |
| 135 | + "description": "Creates or updates the bookmark.", |
| 136 | + "operationId": "Bookmarks_CreateOrUpdate", |
| 137 | + "parameters": [ |
| 138 | + { |
| 139 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" |
| 140 | + }, |
| 141 | + { |
| 142 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" |
| 143 | + }, |
| 144 | + { |
| 145 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" |
| 146 | + }, |
| 147 | + { |
| 148 | + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" |
| 149 | + }, |
| 150 | + { |
| 151 | + "$ref": "#/parameters/BookmarkId" |
| 152 | + }, |
| 153 | + { |
| 154 | + "$ref": "#/parameters/Bookmark" |
| 155 | + } |
| 156 | + ], |
| 157 | + "responses": { |
| 158 | + "200": { |
| 159 | + "description": "OK, Operation successfully completed", |
| 160 | + "schema": { |
| 161 | + "$ref": "#/definitions/Bookmark" |
| 162 | + } |
| 163 | + }, |
| 164 | + "201": { |
| 165 | + "description": "Created", |
| 166 | + "schema": { |
| 167 | + "$ref": "#/definitions/Bookmark" |
| 168 | + } |
| 169 | + }, |
| 170 | + "default": { |
| 171 | + "description": "Error response describing why the operation failed.", |
| 172 | + "schema": { |
| 173 | + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" |
| 174 | + } |
| 175 | + } |
| 176 | + } |
| 177 | + }, |
| 178 | + "delete": { |
| 179 | + "x-ms-examples": { |
| 180 | + "Delete a bookmark.": { |
| 181 | + "$ref": "./examples/bookmarks/DeleteBookmark.json" |
| 182 | + } |
| 183 | + }, |
| 184 | + "tags": [ |
| 185 | + "Bookmarks" |
| 186 | + ], |
| 187 | + "description": "Delete the bookmark.", |
| 188 | + "operationId": "Bookmarks_Delete", |
| 189 | + "parameters": [ |
| 190 | + { |
| 191 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" |
| 192 | + }, |
| 193 | + { |
| 194 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" |
| 195 | + }, |
| 196 | + { |
| 197 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" |
| 198 | + }, |
| 199 | + { |
| 200 | + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" |
| 201 | + }, |
| 202 | + { |
| 203 | + "$ref": "#/parameters/BookmarkId" |
| 204 | + } |
| 205 | + ], |
| 206 | + "responses": { |
| 207 | + "200": { |
| 208 | + "description": "OK, Operation successfully completed" |
| 209 | + }, |
| 210 | + "204": { |
| 211 | + "description": "No Content" |
| 212 | + }, |
| 213 | + "default": { |
| 214 | + "description": "Error response describing why the operation failed.", |
| 215 | + "schema": { |
| 216 | + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" |
| 217 | + } |
| 218 | + } |
| 219 | + } |
| 220 | + } |
| 221 | + } |
| 222 | + }, |
| 223 | + "definitions": { |
| 224 | + "Bookmark": { |
| 225 | + "allOf": [ |
| 226 | + { |
| 227 | + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" |
| 228 | + } |
| 229 | + ], |
| 230 | + "description": "Represents a bookmark in Azure Security Insights.", |
| 231 | + "properties": { |
| 232 | + "properties": { |
| 233 | + "$ref": "#/definitions/BookmarkProperties", |
| 234 | + "description": "Bookmark properties", |
| 235 | + "x-ms-client-flatten": true |
| 236 | + } |
| 237 | + }, |
| 238 | + "type": "object" |
| 239 | + }, |
| 240 | + "BookmarkList": { |
| 241 | + "description": "List all the bookmarks.", |
| 242 | + "properties": { |
| 243 | + "nextLink": { |
| 244 | + "description": "URL to fetch the next set of cases.", |
| 245 | + "readOnly": true, |
| 246 | + "type": "string" |
| 247 | + }, |
| 248 | + "value": { |
| 249 | + "description": "Array of bookmarks.", |
| 250 | + "items": { |
| 251 | + "$ref": "#/definitions/Bookmark" |
| 252 | + }, |
| 253 | + "type": "array" |
| 254 | + } |
| 255 | + }, |
| 256 | + "type": "object", |
| 257 | + "required": [ |
| 258 | + "value" |
| 259 | + ] |
| 260 | + }, |
| 261 | + "BookmarkProperties": { |
| 262 | + "description": "Describes bookmark properties", |
| 263 | + "properties": { |
| 264 | + "created": { |
| 265 | + "description": "The time the bookmark was created", |
| 266 | + "format": "date-time", |
| 267 | + "type": "string" |
| 268 | + }, |
| 269 | + "createdBy": { |
| 270 | + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", |
| 271 | + "description": "Describes a user that created the bookmark", |
| 272 | + "type": "object" |
| 273 | + }, |
| 274 | + "displayName": { |
| 275 | + "description": "The display name of the bookmark", |
| 276 | + "type": "string" |
| 277 | + }, |
| 278 | + "labels": { |
| 279 | + "description": "List of labels relevant to this bookmark", |
| 280 | + "items": { |
| 281 | + "$ref": "../../../common/2.0/types.json#/definitions/Label" |
| 282 | + }, |
| 283 | + "type": "array" |
| 284 | + }, |
| 285 | + "notes": { |
| 286 | + "description": "The notes of the bookmark", |
| 287 | + "type": "string" |
| 288 | + }, |
| 289 | + "query": { |
| 290 | + "description": "The query of the bookmark.", |
| 291 | + "type": "string" |
| 292 | + }, |
| 293 | + "queryResult": { |
| 294 | + "description": "The query result of the bookmark.", |
| 295 | + "type": "string" |
| 296 | + }, |
| 297 | + "updated": { |
| 298 | + "description": "The last time the bookmark was updated", |
| 299 | + "format": "date-time", |
| 300 | + "type": "string" |
| 301 | + }, |
| 302 | + "updatedBy": { |
| 303 | + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", |
| 304 | + "description": "Describes a user that updated the bookmark", |
| 305 | + "type": "object" |
| 306 | + }, |
| 307 | + "eventTime": { |
| 308 | + "description": "The bookmark event time", |
| 309 | + "format": "date-time", |
| 310 | + "type": "string" |
| 311 | + }, |
| 312 | + "queryStartTime": { |
| 313 | + "description": "The start time for the query", |
| 314 | + "format": "date-time", |
| 315 | + "type": "string" |
| 316 | + }, |
| 317 | + "queryEndTime": { |
| 318 | + "description": "The end time for the query", |
| 319 | + "format": "date-time", |
| 320 | + "type": "string" |
| 321 | + }, |
| 322 | + "incidentInfo": { |
| 323 | + "$ref": "./common/IncidentTypes.json#/definitions/IncidentInfo", |
| 324 | + "description": "Describes an incident that relates to bookmark", |
| 325 | + "type": "object" |
| 326 | + } |
| 327 | + }, |
| 328 | + "required": [ |
| 329 | + "displayName", |
| 330 | + "query" |
| 331 | + ], |
| 332 | + "type": "object" |
| 333 | + } |
| 334 | + }, |
| 335 | + "parameters": { |
| 336 | + "Bookmark": { |
| 337 | + "description": "The bookmark", |
| 338 | + "in": "body", |
| 339 | + "name": "bookmark", |
| 340 | + "required": true, |
| 341 | + "schema": { |
| 342 | + "$ref": "#/definitions/Bookmark" |
| 343 | + }, |
| 344 | + "x-ms-parameter-location": "method" |
| 345 | + }, |
| 346 | + "BookmarkId": { |
| 347 | + "description": "Bookmark ID", |
| 348 | + "in": "path", |
| 349 | + "name": "bookmarkId", |
| 350 | + "required": true, |
| 351 | + "type": "string", |
| 352 | + "x-ms-parameter-location": "method" |
| 353 | + } |
| 354 | + } |
| 355 | +} |
0 commit comments