azure-native.securityinsights.Bookmark
Explore with Pulumi AI
Represents a bookmark in Azure Security Insights. API Version: 2020-01-01.
Example Usage
Creates or updates a bookmark.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var bookmark = new AzureNative.SecurityInsights.Bookmark("bookmark", new()
{
BookmarkId = "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
Created = "2019-01-01T13:15:30Z",
CreatedBy = new AzureNative.SecurityInsights.Inputs.UserInfoArgs
{
ObjectId = "2046feea-040d-4a46-9e2b-91c2941bfa70",
},
DisplayName = "My bookmark",
Labels = new[]
{
"Tag1",
"Tag2",
},
Notes = "Found a suspicious activity",
Query = "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)",
QueryResult = "Security Event query result",
ResourceGroupName = "myRg",
Updated = "2019-01-01T13:15:30Z",
UpdatedBy = new AzureNative.SecurityInsights.Inputs.UserInfoArgs
{
ObjectId = "2046feea-040d-4a46-9e2b-91c2941bfa70",
},
WorkspaceName = "myWorkspace",
});
});
package main
import (
securityinsights "github.com/pulumi/pulumi-azure-native-sdk/securityinsights"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := securityinsights.NewBookmark(ctx, "bookmark", &securityinsights.BookmarkArgs{
BookmarkId: pulumi.String("73e01a99-5cd7-4139-a149-9f2736ff2ab5"),
Created: pulumi.String("2019-01-01T13:15:30Z"),
CreatedBy: &securityinsights.UserInfoArgs{
ObjectId: pulumi.String("2046feea-040d-4a46-9e2b-91c2941bfa70"),
},
DisplayName: pulumi.String("My bookmark"),
Labels: pulumi.StringArray{
pulumi.String("Tag1"),
pulumi.String("Tag2"),
},
Notes: pulumi.String("Found a suspicious activity"),
Query: pulumi.String("SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)"),
QueryResult: pulumi.String("Security Event query result"),
ResourceGroupName: pulumi.String("myRg"),
Updated: pulumi.String("2019-01-01T13:15:30Z"),
UpdatedBy: &securityinsights.UserInfoArgs{
ObjectId: pulumi.String("2046feea-040d-4a46-9e2b-91c2941bfa70"),
},
WorkspaceName: pulumi.String("myWorkspace"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.Bookmark;
import com.pulumi.azurenative.securityinsights.BookmarkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var bookmark = new Bookmark("bookmark", BookmarkArgs.builder()
.bookmarkId("73e01a99-5cd7-4139-a149-9f2736ff2ab5")
.created("2019-01-01T13:15:30Z")
.createdBy(Map.of("objectId", "2046feea-040d-4a46-9e2b-91c2941bfa70"))
.displayName("My bookmark")
.labels(
"Tag1",
"Tag2")
.notes("Found a suspicious activity")
.query("SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)")
.queryResult("Security Event query result")
.resourceGroupName("myRg")
.updated("2019-01-01T13:15:30Z")
.updatedBy(Map.of("objectId", "2046feea-040d-4a46-9e2b-91c2941bfa70"))
.workspaceName("myWorkspace")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
bookmark = azure_native.securityinsights.Bookmark("bookmark",
bookmark_id="73e01a99-5cd7-4139-a149-9f2736ff2ab5",
created="2019-01-01T13:15:30Z",
created_by=azure_native.securityinsights.UserInfoArgs(
object_id="2046feea-040d-4a46-9e2b-91c2941bfa70",
),
display_name="My bookmark",
labels=[
"Tag1",
"Tag2",
],
notes="Found a suspicious activity",
query="SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)",
query_result="Security Event query result",
resource_group_name="myRg",
updated="2019-01-01T13:15:30Z",
updated_by=azure_native.securityinsights.UserInfoArgs(
object_id="2046feea-040d-4a46-9e2b-91c2941bfa70",
),
workspace_name="myWorkspace")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const bookmark = new azure_native.securityinsights.Bookmark("bookmark", {
bookmarkId: "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
created: "2019-01-01T13:15:30Z",
createdBy: {
objectId: "2046feea-040d-4a46-9e2b-91c2941bfa70",
},
displayName: "My bookmark",
labels: [
"Tag1",
"Tag2",
],
notes: "Found a suspicious activity",
query: "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)",
queryResult: "Security Event query result",
resourceGroupName: "myRg",
updated: "2019-01-01T13:15:30Z",
updatedBy: {
objectId: "2046feea-040d-4a46-9e2b-91c2941bfa70",
},
workspaceName: "myWorkspace",
});
resources:
bookmark:
type: azure-native:securityinsights:Bookmark
properties:
bookmarkId: 73e01a99-5cd7-4139-a149-9f2736ff2ab5
created: 2019-01-01T13:15:30Z
createdBy:
objectId: 2046feea-040d-4a46-9e2b-91c2941bfa70
displayName: My bookmark
labels:
- Tag1
- Tag2
notes: Found a suspicious activity
query: SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)
queryResult: Security Event query result
resourceGroupName: myRg
updated: 2019-01-01T13:15:30Z
updatedBy:
objectId: 2046feea-040d-4a46-9e2b-91c2941bfa70
workspaceName: myWorkspace
Create Bookmark Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Bookmark(name: string, args: BookmarkArgs, opts?: CustomResourceOptions);
@overload
def Bookmark(resource_name: str,
args: BookmarkArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Bookmark(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
query: Optional[str] = None,
workspace_name: Optional[str] = None,
display_name: Optional[str] = None,
labels: Optional[Sequence[str]] = None,
incident_info: Optional[IncidentInfoArgs] = None,
created: Optional[str] = None,
notes: Optional[str] = None,
event_time: Optional[str] = None,
query_end_time: Optional[str] = None,
query_result: Optional[str] = None,
query_start_time: Optional[str] = None,
bookmark_id: Optional[str] = None,
updated: Optional[str] = None,
updated_by: Optional[UserInfoArgs] = None,
created_by: Optional[UserInfoArgs] = None)
func NewBookmark(ctx *Context, name string, args BookmarkArgs, opts ...ResourceOption) (*Bookmark, error)
public Bookmark(string name, BookmarkArgs args, CustomResourceOptions? opts = null)
public Bookmark(String name, BookmarkArgs args)
public Bookmark(String name, BookmarkArgs args, CustomResourceOptions options)
type: azure-native:securityinsights:Bookmark
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args BookmarkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args BookmarkArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args BookmarkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BookmarkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BookmarkArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var bookmarkResource = new AzureNative.Securityinsights.Bookmark("bookmarkResource", new()
{
ResourceGroupName = "string",
Query = "string",
WorkspaceName = "string",
DisplayName = "string",
Labels = new[]
{
"string",
},
IncidentInfo =
{
{ "incidentId", "string" },
{ "relationName", "string" },
{ "severity", "string" },
{ "title", "string" },
},
Created = "string",
Notes = "string",
EventTime = "string",
QueryEndTime = "string",
QueryResult = "string",
QueryStartTime = "string",
BookmarkId = "string",
Updated = "string",
UpdatedBy =
{
{ "objectId", "string" },
},
CreatedBy =
{
{ "objectId", "string" },
},
});
example, err := securityinsights.NewBookmark(ctx, "bookmarkResource", &securityinsights.BookmarkArgs{
ResourceGroupName: "string",
Query: "string",
WorkspaceName: "string",
DisplayName: "string",
Labels: []string{
"string",
},
IncidentInfo: map[string]interface{}{
"incidentId": "string",
"relationName": "string",
"severity": "string",
"title": "string",
},
Created: "string",
Notes: "string",
EventTime: "string",
QueryEndTime: "string",
QueryResult: "string",
QueryStartTime: "string",
BookmarkId: "string",
Updated: "string",
UpdatedBy: map[string]interface{}{
"objectId": "string",
},
CreatedBy: map[string]interface{}{
"objectId": "string",
},
})
var bookmarkResource = new Bookmark("bookmarkResource", BookmarkArgs.builder()
.resourceGroupName("string")
.query("string")
.workspaceName("string")
.displayName("string")
.labels("string")
.incidentInfo(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.created("string")
.notes("string")
.eventTime("string")
.queryEndTime("string")
.queryResult("string")
.queryStartTime("string")
.bookmarkId("string")
.updated("string")
.updatedBy(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.createdBy(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
bookmark_resource = azure_native.securityinsights.Bookmark("bookmarkResource",
resource_group_name=string,
query=string,
workspace_name=string,
display_name=string,
labels=[string],
incident_info={
incidentId: string,
relationName: string,
severity: string,
title: string,
},
created=string,
notes=string,
event_time=string,
query_end_time=string,
query_result=string,
query_start_time=string,
bookmark_id=string,
updated=string,
updated_by={
objectId: string,
},
created_by={
objectId: string,
})
const bookmarkResource = new azure_native.securityinsights.Bookmark("bookmarkResource", {
resourceGroupName: "string",
query: "string",
workspaceName: "string",
displayName: "string",
labels: ["string"],
incidentInfo: {
incidentId: "string",
relationName: "string",
severity: "string",
title: "string",
},
created: "string",
notes: "string",
eventTime: "string",
queryEndTime: "string",
queryResult: "string",
queryStartTime: "string",
bookmarkId: "string",
updated: "string",
updatedBy: {
objectId: "string",
},
createdBy: {
objectId: "string",
},
});
type: azure-native:securityinsights:Bookmark
properties:
bookmarkId: string
created: string
createdBy:
objectId: string
displayName: string
eventTime: string
incidentInfo:
incidentId: string
relationName: string
severity: string
title: string
labels:
- string
notes: string
query: string
queryEndTime: string
queryResult: string
queryStartTime: string
resourceGroupName: string
updated: string
updatedBy:
objectId: string
workspaceName: string
Bookmark Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Bookmark resource accepts the following input properties:
- Display
Name string - The display name of the bookmark
- Query string
- The query of the bookmark.
- Resource
Group stringName - The name of the resource group within the user's subscription. The name is case insensitive.
- Workspace
Name string - The name of the workspace.
- Bookmark
Id string - Bookmark ID
- Created string
- The time the bookmark was created
- Created
By Pulumi.Azure Native. Security Insights. Inputs. User Info - Describes a user that created the bookmark
- Event
Time string - The bookmark event time
- Incident
Info Pulumi.Azure Native. Security Insights. Inputs. Incident Info - Describes an incident that relates to bookmark
- Labels List<string>
- List of labels relevant to this bookmark
- Notes string
- The notes of the bookmark
- Query
End stringTime - The end time for the query
- Query
Result string - The query result of the bookmark.
- Query
Start stringTime - The start time for the query
- Updated string
- The last time the bookmark was updated
- Updated
By Pulumi.Azure Native. Security Insights. Inputs. User Info - Describes a user that updated the bookmark
- Display
Name string - The display name of the bookmark
- Query string
- The query of the bookmark.
- Resource
Group stringName - The name of the resource group within the user's subscription. The name is case insensitive.
- Workspace
Name string - The name of the workspace.
- Bookmark
Id string - Bookmark ID
- Created string
- The time the bookmark was created
- Created
By UserInfo Args - Describes a user that created the bookmark
- Event
Time string - The bookmark event time
- Incident
Info IncidentInfo Args - Describes an incident that relates to bookmark
- Labels []string
- List of labels relevant to this bookmark
- Notes string
- The notes of the bookmark
- Query
End stringTime - The end time for the query
- Query
Result string - The query result of the bookmark.
- Query
Start stringTime - The start time for the query
- Updated string
- The last time the bookmark was updated
- Updated
By UserInfo Args - Describes a user that updated the bookmark
- display
Name String - The display name of the bookmark
- query String
- The query of the bookmark.
- resource
Group StringName - The name of the resource group within the user's subscription. The name is case insensitive.
- workspace
Name String - The name of the workspace.
- bookmark
Id String - Bookmark ID
- created String
- The time the bookmark was created
- created
By UserInfo - Describes a user that created the bookmark
- event
Time String - The bookmark event time
- incident
Info IncidentInfo - Describes an incident that relates to bookmark
- labels List<String>
- List of labels relevant to this bookmark
- notes String
- The notes of the bookmark
- query
End StringTime - The end time for the query
- query
Result String - The query result of the bookmark.
- query
Start StringTime - The start time for the query
- updated String
- The last time the bookmark was updated
- updated
By UserInfo - Describes a user that updated the bookmark
- display
Name string - The display name of the bookmark
- query string
- The query of the bookmark.
- resource
Group stringName - The name of the resource group within the user's subscription. The name is case insensitive.
- workspace
Name string - The name of the workspace.
- bookmark
Id string - Bookmark ID
- created string
- The time the bookmark was created
- created
By UserInfo - Describes a user that created the bookmark
- event
Time string - The bookmark event time
- incident
Info IncidentInfo - Describes an incident that relates to bookmark
- labels string[]
- List of labels relevant to this bookmark
- notes string
- The notes of the bookmark
- query
End stringTime - The end time for the query
- query
Result string - The query result of the bookmark.
- query
Start stringTime - The start time for the query
- updated string
- The last time the bookmark was updated
- updated
By UserInfo - Describes a user that updated the bookmark
- display_
name str - The display name of the bookmark
- query str
- The query of the bookmark.
- resource_
group_ strname - The name of the resource group within the user's subscription. The name is case insensitive.
- workspace_
name str - The name of the workspace.
- bookmark_
id str - Bookmark ID
- created str
- The time the bookmark was created
- created_
by UserInfo Args - Describes a user that created the bookmark
- event_
time str - The bookmark event time
- incident_
info IncidentInfo Args - Describes an incident that relates to bookmark
- labels Sequence[str]
- List of labels relevant to this bookmark
- notes str
- The notes of the bookmark
- query_
end_ strtime - The end time for the query
- query_
result str - The query result of the bookmark.
- query_
start_ strtime - The start time for the query
- updated str
- The last time the bookmark was updated
- updated_
by UserInfo Args - Describes a user that updated the bookmark
- display
Name String - The display name of the bookmark
- query String
- The query of the bookmark.
- resource
Group StringName - The name of the resource group within the user's subscription. The name is case insensitive.
- workspace
Name String - The name of the workspace.
- bookmark
Id String - Bookmark ID
- created String
- The time the bookmark was created
- created
By Property Map - Describes a user that created the bookmark
- event
Time String - The bookmark event time
- incident
Info Property Map - Describes an incident that relates to bookmark
- labels List<String>
- List of labels relevant to this bookmark
- notes String
- The notes of the bookmark
- query
End StringTime - The end time for the query
- query
Result String - The query result of the bookmark.
- query
Start StringTime - The start time for the query
- updated String
- The last time the bookmark was updated
- updated
By Property Map - Describes a user that updated the bookmark
Outputs
All input properties are implicitly available as output properties. Additionally, the Bookmark resource produces the following output properties:
Supporting Types
IncidentInfo, IncidentInfoArgs
- Incident
Id string - Incident Id
- Relation
Name string - Relation Name
- Severity
string | Pulumi.
Azure Native. Security Insights. Incident Severity - The severity of the incident
- Title string
- The title of the incident
- Incident
Id string - Incident Id
- Relation
Name string - Relation Name
- Severity
string | Incident
Severity - The severity of the incident
- Title string
- The title of the incident
- incident
Id String - Incident Id
- relation
Name String - Relation Name
- severity
String | Incident
Severity - The severity of the incident
- title String
- The title of the incident
- incident
Id string - Incident Id
- relation
Name string - Relation Name
- severity
string | Incident
Severity - The severity of the incident
- title string
- The title of the incident
- incident_
id str - Incident Id
- relation_
name str - Relation Name
- severity
str | Incident
Severity - The severity of the incident
- title str
- The title of the incident
- incident
Id String - Incident Id
- relation
Name String - Relation Name
- severity String | "High" | "Medium" | "Low" | "Informational"
- The severity of the incident
- title String
- The title of the incident
IncidentInfoResponse, IncidentInfoResponseArgs
- Incident
Id string - Incident Id
- Relation
Name string - Relation Name
- Severity string
- The severity of the incident
- Title string
- The title of the incident
- Incident
Id string - Incident Id
- Relation
Name string - Relation Name
- Severity string
- The severity of the incident
- Title string
- The title of the incident
- incident
Id String - Incident Id
- relation
Name String - Relation Name
- severity String
- The severity of the incident
- title String
- The title of the incident
- incident
Id string - Incident Id
- relation
Name string - Relation Name
- severity string
- The severity of the incident
- title string
- The title of the incident
- incident_
id str - Incident Id
- relation_
name str - Relation Name
- severity str
- The severity of the incident
- title str
- The title of the incident
- incident
Id String - Incident Id
- relation
Name String - Relation Name
- severity String
- The severity of the incident
- title String
- The title of the incident
IncidentSeverity, IncidentSeverityArgs
- High
- HighHigh severity
- Medium
- MediumMedium severity
- Low
- LowLow severity
- Informational
- InformationalInformational severity
- Incident
Severity High - HighHigh severity
- Incident
Severity Medium - MediumMedium severity
- Incident
Severity Low - LowLow severity
- Incident
Severity Informational - InformationalInformational severity
- High
- HighHigh severity
- Medium
- MediumMedium severity
- Low
- LowLow severity
- Informational
- InformationalInformational severity
- High
- HighHigh severity
- Medium
- MediumMedium severity
- Low
- LowLow severity
- Informational
- InformationalInformational severity
- HIGH
- HighHigh severity
- MEDIUM
- MediumMedium severity
- LOW
- LowLow severity
- INFORMATIONAL
- InformationalInformational severity
- "High"
- HighHigh severity
- "Medium"
- MediumMedium severity
- "Low"
- LowLow severity
- "Informational"
- InformationalInformational severity
UserInfo, UserInfoArgs
- Object
Id string - The object id of the user.
- Object
Id string - The object id of the user.
- object
Id String - The object id of the user.
- object
Id string - The object id of the user.
- object_
id str - The object id of the user.
- object
Id String - The object id of the user.
UserInfoResponse, UserInfoResponseArgs
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:securityinsights:Bookmark 73e01a99-5cd7-4139-a149-9f2736ff2ab5 /subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0