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

Adding Expand to Bookmark #8238

Merged
merged 1 commit into from
Mar 4, 2020
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
Original file line number Diff line number Diff line change
Expand Up @@ -1443,6 +1443,57 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/expand": {
"post": {
"x-ms-examples": {
"Expand an bookmark": {
"$ref": "./examples/bookmarks/expand/PostExpandBookmark.json"
}
},
"description": "Expand an bookmark",
"operationId": "Bookmark_Expand",
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/SubscriptionId"
},
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/OperationalInsightsResourceProvider"
},
{
"$ref": "#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/BookmarkId"
},
{
"$ref": "#/parameters/BookmarkExpandRequestBody"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BookmarkExpandResponse"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"tags": [
"Bookmark"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations/{relationName}": {
"get": {
"x-ms-examples": {
Expand Down Expand Up @@ -3487,6 +3538,48 @@
],
"type": "object"
},
"BookmarkExpandParameters": {
"description": "The parameters required to execute an expand operation on the given bookmark.",
"properties": {
"endTime": {
"description": "The end date filter, so the only expansion results returned are before this date.",
"format": "date-time",
"type": "string"
},
"expansionId": {
"description": "The Id of the expansion to perform.",
"format": "uuid",
"type": "string"
},
"startTime": {
"description": "The start date filter, so the only expansion results returned are after this date.",
"format": "date-time",
"type": "string"
}
}
},
"BookmarkExpandResponse": {
"description": "The entity expansion result operation response.",
"properties": {
"metaData": {
"$ref": "#/definitions/ExpansionResultsMetadata",
"description": "The metadata from the expansion operation results."
},
"value": {
"description": "The expansion result values.",
"properties": {
"entities": {
"description": "Array of the expansion result entities.",
"items": {
"$ref": "#/definitions/Entity"
},
"type": "array"
}
},
"type": "object"
}
}
},
"Case": {
"allOf": [
{
Expand Down Expand Up @@ -6916,6 +7009,16 @@
},
"x-ms-parameter-location": "method"
},
"BookmarkExpandRequestBody": {
"description": "The parameters required to execute an expand operation on the given bookmark.",
"in": "body",
"name": "parameters",
"required": true,
"schema": {
"$ref": "#/definitions/BookmarkExpandParameters"
},
"x-ms-parameter-location": "method"
},
"EntityId": {
"description": "entity ID",
"in": "path",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"parameters": {
"api-version": "2019-01-01-preview",
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalIinsights",
"bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
"parameters": {
"expansionId": "27f76e63-c41b-480f-bb18-12ad2e011d49",
"startTime": "2019-12-25T17:21:00.000Z",
"endTime": "2020-01-24T17:21:00.000Z"
}
},
"responses": {
"200": {
"body": {
"value": {
"entities": [
{
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/fe4ddab5-8cea-eca3-c8b8-9e92e830a387",
"name": "fe4ddab5-8cea-eca3-c8b8-9e92e830a387",
"type": "Microsoft.SecurityInsights/entities",
"kind": "Account",
"properties": {
"friendlyName": "administrator",
"accountName": "administrator",
"ntDomain": "domain"
}
}
]
},
"metaData": {
"aggregations": [
{
"entityKind": "Account",
"count": 1
}
]
}
}
}
}
}