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.

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

dev-Sentinel-2022-08-01 #20290

Merged
merged 5 commits into from
Aug 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,355 @@
{
"swagger": "2.0",
"info": {
"title": "Security Insights",
"description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider",
"version": "2022-08-01"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks": {
"get": {
"x-ms-examples": {
"Get all bookmarks.": {
"$ref": "./examples/bookmarks/GetBookmarks.json"
}
},
"tags": [
"Bookmarks"
],
"description": "Gets all bookmarks.",
"operationId": "Bookmarks_List",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
}
],
"responses": {
"200": {
"description": "OK, Operation successfully completed",
"schema": {
"$ref": "#/definitions/BookmarkList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/2.0/types.json#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}": {
"get": {
"x-ms-examples": {
"Get a bookmark.": {
"$ref": "./examples/bookmarks/GetBookmarkById.json"
}
},
"tags": [
"Bookmarks"
],
"description": "Gets a bookmark.",
"operationId": "Bookmarks_Get",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/BookmarkId"
}
],
"responses": {
"200": {
"description": "OK, Operation successfully completed",
"schema": {
"$ref": "#/definitions/Bookmark"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/2.0/types.json#/definitions/CloudError"
}
}
}
},
"put": {
"x-ms-examples": {
"Creates or updates a bookmark.": {
"$ref": "./examples/bookmarks/CreateBookmark.json"
}
},
"tags": [
"Bookmarks"
],
"description": "Creates or updates the bookmark.",
"operationId": "Bookmarks_CreateOrUpdate",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/BookmarkId"
},
{
"$ref": "#/parameters/Bookmark"
}
],
"responses": {
"200": {
"description": "OK, Operation successfully completed",
"schema": {
"$ref": "#/definitions/Bookmark"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/Bookmark"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/2.0/types.json#/definitions/CloudError"
}
}
}
},
"delete": {
"x-ms-examples": {
"Delete a bookmark.": {
"$ref": "./examples/bookmarks/DeleteBookmark.json"
}
},
"tags": [
"Bookmarks"
],
"description": "Delete the bookmark.",
"operationId": "Bookmarks_Delete",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/BookmarkId"
}
],
"responses": {
"200": {
"description": "OK, Operation successfully completed"
},
"204": {
"description": "No Content"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/2.0/types.json#/definitions/CloudError"
}
}
}
}
}
},
"definitions": {
"Bookmark": {
"allOf": [
{
"$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag"
}
],
"description": "Represents a bookmark in Azure Security Insights.",
"properties": {
"properties": {
"$ref": "#/definitions/BookmarkProperties",
"description": "Bookmark properties",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"BookmarkList": {
"description": "List all the bookmarks.",
"properties": {
"nextLink": {
"description": "URL to fetch the next set of cases.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Array of bookmarks.",
"items": {
"$ref": "#/definitions/Bookmark"
},
"type": "array"
}
},
"type": "object",
"required": [
"value"
]
},
"BookmarkProperties": {
"description": "Describes bookmark properties",
"properties": {
"created": {
"description": "The time the bookmark was created",
"format": "date-time",
"type": "string"
},
"createdBy": {
"$ref": "../../../common/2.0/types.json#/definitions/UserInfo",
"description": "Describes a user that created the bookmark",
"type": "object"
},
"displayName": {
"description": "The display name of the bookmark",
"type": "string"
},
"labels": {
"description": "List of labels relevant to this bookmark",
"items": {
"$ref": "../../../common/2.0/types.json#/definitions/Label"
},
"type": "array"
},
"notes": {
"description": "The notes of the bookmark",
"type": "string"
},
"query": {
"description": "The query of the bookmark.",
"type": "string"
},
"queryResult": {
"description": "The query result of the bookmark.",
"type": "string"
},
"updated": {
"description": "The last time the bookmark was updated",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"$ref": "../../../common/2.0/types.json#/definitions/UserInfo",
"description": "Describes a user that updated the bookmark",
"type": "object"
},
"eventTime": {
"description": "The bookmark event time",
"format": "date-time",
"type": "string"
},
"queryStartTime": {
"description": "The start time for the query",
"format": "date-time",
"type": "string"
},
"queryEndTime": {
"description": "The end time for the query",
"format": "date-time",
"type": "string"
},
"incidentInfo": {
"$ref": "./common/IncidentTypes.json#/definitions/IncidentInfo",
"description": "Describes an incident that relates to bookmark",
"type": "object"
}
},
"required": [
"displayName",
"query"
],
"type": "object"
}
},
"parameters": {
"Bookmark": {
"description": "The bookmark",
"in": "body",
"name": "bookmark",
"required": true,
"schema": {
"$ref": "#/definitions/Bookmark"
},
"x-ms-parameter-location": "method"
},
"BookmarkId": {
"description": "Bookmark ID",
"in": "path",
"name": "bookmarkId",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
}
}
Loading