Azure Native

Pulumi Official
Package maintained by Pulumi
v1.67.0 published on Tuesday, Jul 12, 2022 by Pulumi

Bookmark

Represents a bookmark in Azure Security Insights. API Version: 2020-01-01.

Example Usage

Creates or updates a bookmark.

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var bookmark = new AzureNative.SecurityInsights.Bookmark("bookmark", new AzureNative.SecurityInsights.BookmarkArgs
        {
            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 = 
            {
                "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/go/azure/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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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 a Bookmark Resource

new Bookmark(name: string, args: BookmarkArgs, opts?: CustomResourceOptions);
@overload
def Bookmark(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             bookmark_id: Optional[str] = None,
             created: Optional[str] = None,
             created_by: Optional[UserInfoArgs] = None,
             display_name: Optional[str] = None,
             event_time: Optional[str] = None,
             incident_info: Optional[IncidentInfoArgs] = None,
             labels: Optional[Sequence[str]] = None,
             notes: Optional[str] = None,
             query: Optional[str] = None,
             query_end_time: Optional[str] = None,
             query_result: Optional[str] = None,
             query_start_time: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             updated: Optional[str] = None,
             updated_by: Optional[UserInfoArgs] = None,
             workspace_name: Optional[str] = None)
@overload
def Bookmark(resource_name: str,
             args: BookmarkArgs,
             opts: Optional[ResourceOptions] = 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.

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.

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

The Bookmark resource accepts the following input properties:

DisplayName string

The display name of the bookmark

Query string

The query of the bookmark.

ResourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

WorkspaceName string

The name of the workspace.

BookmarkId string

Bookmark ID

Created string

The time the bookmark was created

CreatedBy Pulumi.AzureNative.SecurityInsights.Inputs.UserInfoArgs

Describes a user that created the bookmark

EventTime string

The bookmark event time

IncidentInfo Pulumi.AzureNative.SecurityInsights.Inputs.IncidentInfoArgs

Describes an incident that relates to bookmark

Labels List<string>

List of labels relevant to this bookmark

Notes string

The notes of the bookmark

QueryEndTime string

The end time for the query

QueryResult string

The query result of the bookmark.

QueryStartTime string

The start time for the query

Updated string

The last time the bookmark was updated

UpdatedBy Pulumi.AzureNative.SecurityInsights.Inputs.UserInfoArgs

Describes a user that updated the bookmark

DisplayName string

The display name of the bookmark

Query string

The query of the bookmark.

ResourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

WorkspaceName string

The name of the workspace.

BookmarkId string

Bookmark ID

Created string

The time the bookmark was created

CreatedBy UserInfoArgs

Describes a user that created the bookmark

EventTime string

The bookmark event time

IncidentInfo IncidentInfoArgs

Describes an incident that relates to bookmark

Labels []string

List of labels relevant to this bookmark

Notes string

The notes of the bookmark

QueryEndTime string

The end time for the query

QueryResult string

The query result of the bookmark.

QueryStartTime string

The start time for the query

Updated string

The last time the bookmark was updated

UpdatedBy UserInfoArgs

Describes a user that updated the bookmark

displayName String

The display name of the bookmark

query String

The query of the bookmark.

resourceGroupName String

The name of the resource group within the user's subscription. The name is case insensitive.

workspaceName String

The name of the workspace.

bookmarkId String

Bookmark ID

created String

The time the bookmark was created

createdBy UserInfoArgs

Describes a user that created the bookmark

eventTime String

The bookmark event time

incidentInfo IncidentInfoArgs

Describes an incident that relates to bookmark

labels List<String>

List of labels relevant to this bookmark

notes String

The notes of the bookmark

queryEndTime String

The end time for the query

queryResult String

The query result of the bookmark.

queryStartTime String

The start time for the query

updated String

The last time the bookmark was updated

updatedBy UserInfoArgs

Describes a user that updated the bookmark

displayName string

The display name of the bookmark

query string

The query of the bookmark.

resourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

workspaceName string

The name of the workspace.

bookmarkId string

Bookmark ID

created string

The time the bookmark was created

createdBy UserInfoArgs

Describes a user that created the bookmark

eventTime string

The bookmark event time

incidentInfo IncidentInfoArgs

Describes an incident that relates to bookmark

labels string[]

List of labels relevant to this bookmark

notes string

The notes of the bookmark

queryEndTime string

The end time for the query

queryResult string

The query result of the bookmark.

queryStartTime string

The start time for the query

updated string

The last time the bookmark was updated

updatedBy UserInfoArgs

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_name str

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 UserInfoArgs

Describes a user that created the bookmark

event_time str

The bookmark event time

incident_info IncidentInfoArgs

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_time str

The end time for the query

query_result str

The query result of the bookmark.

query_start_time str

The start time for the query

updated str

The last time the bookmark was updated

updated_by UserInfoArgs

Describes a user that updated the bookmark

displayName String

The display name of the bookmark

query String

The query of the bookmark.

resourceGroupName String

The name of the resource group within the user's subscription. The name is case insensitive.

workspaceName String

The name of the workspace.

bookmarkId String

Bookmark ID

created String

The time the bookmark was created

createdBy Property Map

Describes a user that created the bookmark

eventTime String

The bookmark event time

incidentInfo 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

queryEndTime String

The end time for the query

queryResult String

The query result of the bookmark.

queryStartTime String

The start time for the query

updated String

The last time the bookmark was updated

updatedBy 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:

Id string

The provider-assigned unique ID for this managed resource.

Name string

Azure resource name

Type string

Azure resource type

Etag string

Etag of the azure resource

Id string

The provider-assigned unique ID for this managed resource.

Name string

Azure resource name

Type string

Azure resource type

Etag string

Etag of the azure resource

id String

The provider-assigned unique ID for this managed resource.

name String

Azure resource name

type String

Azure resource type

etag String

Etag of the azure resource

id string

The provider-assigned unique ID for this managed resource.

name string

Azure resource name

type string

Azure resource type

etag string

Etag of the azure resource

id str

The provider-assigned unique ID for this managed resource.

name str

Azure resource name

type str

Azure resource type

etag str

Etag of the azure resource

id String

The provider-assigned unique ID for this managed resource.

name String

Azure resource name

type String

Azure resource type

etag String

Etag of the azure resource

Supporting Types

IncidentInfo

IncidentId string

Incident Id

RelationName string

Relation Name

Severity string | Pulumi.AzureNative.SecurityInsights.IncidentSeverity

The severity of the incident

Title string

The title of the incident

IncidentId string

Incident Id

RelationName string

Relation Name

Severity string | IncidentSeverity

The severity of the incident

Title string

The title of the incident

incidentId String

Incident Id

relationName String

Relation Name

severity String | IncidentSeverity

The severity of the incident

title String

The title of the incident

incidentId string

Incident Id

relationName string

Relation Name

severity string | IncidentSeverity

The severity of the incident

title string

The title of the incident

incident_id str

Incident Id

relation_name str

Relation Name

severity str | IncidentSeverity

The severity of the incident

title str

The title of the incident

incidentId String

Incident Id

relationName String

Relation Name

severity String | "High" | "Medium" | "Low" | "Informational"

The severity of the incident

title String

The title of the incident

IncidentInfoResponse

IncidentId string

Incident Id

RelationName string

Relation Name

Severity string

The severity of the incident

Title string

The title of the incident

IncidentId string

Incident Id

RelationName string

Relation Name

Severity string

The severity of the incident

Title string

The title of the incident

incidentId String

Incident Id

relationName String

Relation Name

severity String

The severity of the incident

title String

The title of the incident

incidentId string

Incident Id

relationName 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

incidentId String

Incident Id

relationName String

Relation Name

severity String

The severity of the incident

title String

The title of the incident

IncidentSeverity

High
High

High severity

Medium
Medium

Medium severity

Low
Low

Low severity

Informational
Informational

Informational severity

IncidentSeverityHigh
High

High severity

IncidentSeverityMedium
Medium

Medium severity

IncidentSeverityLow
Low

Low severity

IncidentSeverityInformational
Informational

Informational severity

High
High

High severity

Medium
Medium

Medium severity

Low
Low

Low severity

Informational
Informational

Informational severity

High
High

High severity

Medium
Medium

Medium severity

Low
Low

Low severity

Informational
Informational

Informational severity

HIGH
High

High severity

MEDIUM
Medium

Medium severity

LOW
Low

Low severity

INFORMATIONAL
Informational

Informational severity

"High"
High

High severity

"Medium"
Medium

Medium severity

"Low"
Low

Low severity

"Informational"
Informational

Informational severity

UserInfo

ObjectId string

The object id of the user.

ObjectId string

The object id of the user.

objectId String

The object id of the user.

objectId string

The object id of the user.

object_id str

The object id of the user.

objectId String

The object id of the user.

UserInfoResponse

Email string

The email of the user.

Name string

The name of the user.

ObjectId string

The object id of the user.

Email string

The email of the user.

Name string

The name of the user.

ObjectId string

The object id of the user.

email String

The email of the user.

name String

The name of the user.

objectId String

The object id of the user.

email string

The email of the user.

name string

The name of the user.

objectId string

The object id of the user.

email str

The email of the user.

name str

The name of the user.

object_id str

The object id of the user.

email String

The email of the user.

name String

The name of the user.

objectId String

The object id of the user.

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 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0