BookmarkArgs

data class BookmarkArgs(val bookmarkId: Output<String>? = null, val created: Output<String>? = null, val createdBy: Output<UserInfoArgs>? = null, val displayName: Output<String>? = null, val eventTime: Output<String>? = null, val incidentInfo: Output<IncidentInfoArgs>? = null, val labels: Output<List<String>>? = null, val notes: Output<String>? = null, val query: Output<String>? = null, val queryEndTime: Output<String>? = null, val queryResult: Output<String>? = null, val queryStartTime: Output<String>? = null, val resourceGroupName: Output<String>? = null, val updated: Output<String>? = null, val updatedBy: Output<UserInfoArgs>? = null, val workspaceName: Output<String>? = null) : ConvertibleToJava<BookmarkArgs>

Represents a bookmark in Azure Security Insights. Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01. Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-04-01-preview, 2023-05-01-preview, 2023-06-01-preview, 2023-07-01-preview, 2023-08-01-preview, 2023-09-01-preview, 2023-10-01-preview, 2023-11-01, 2023-12-01-preview, 2024-01-01-preview, 2024-03-01, 2024-04-01-preview, 2024-10-01-preview, 2025-01-01-preview, 2025-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native securityinsights [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

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/v2"
"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 com.pulumi.azurenative.securityinsights.inputs.UserInfoArgs;
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(UserInfoArgs.builder()
.objectId("2046feea-040d-4a46-9e2b-91c2941bfa70")
.build())
.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(UserInfoArgs.builder()
.objectId("2046feea-040d-4a46-9e2b-91c2941bfa70")
.build())
.workspaceName("myWorkspace")
.build());
}
}

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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}

Constructors

Link copied to clipboard
constructor(bookmarkId: Output<String>? = null, created: Output<String>? = null, createdBy: Output<UserInfoArgs>? = null, displayName: Output<String>? = null, eventTime: Output<String>? = null, incidentInfo: Output<IncidentInfoArgs>? = null, labels: Output<List<String>>? = null, notes: Output<String>? = null, query: Output<String>? = null, queryEndTime: Output<String>? = null, queryResult: Output<String>? = null, queryStartTime: Output<String>? = null, resourceGroupName: Output<String>? = null, updated: Output<String>? = null, updatedBy: Output<UserInfoArgs>? = null, workspaceName: Output<String>? = null)

Properties

Link copied to clipboard
val bookmarkId: Output<String>? = null

Bookmark ID

Link copied to clipboard
val created: Output<String>? = null

The time the bookmark was created

Link copied to clipboard
val createdBy: Output<UserInfoArgs>? = null

Describes a user that created the bookmark

Link copied to clipboard
val displayName: Output<String>? = null

The display name of the bookmark

Link copied to clipboard
val eventTime: Output<String>? = null

The bookmark event time

Link copied to clipboard
val incidentInfo: Output<IncidentInfoArgs>? = null

Describes an incident that relates to bookmark

Link copied to clipboard
val labels: Output<List<String>>? = null

List of labels relevant to this bookmark

Link copied to clipboard
val notes: Output<String>? = null

The notes of the bookmark

Link copied to clipboard
val query: Output<String>? = null

The query of the bookmark.

Link copied to clipboard
val queryEndTime: Output<String>? = null

The end time for the query

Link copied to clipboard
val queryResult: Output<String>? = null

The query result of the bookmark.

Link copied to clipboard
val queryStartTime: Output<String>? = null

The start time for the query

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val updated: Output<String>? = null

The last time the bookmark was updated

Link copied to clipboard
val updatedBy: Output<UserInfoArgs>? = null

Describes a user that updated the bookmark

Link copied to clipboard
val workspaceName: Output<String>? = null

The name of the workspace.

Functions

Link copied to clipboard
open override fun toJava(): BookmarkArgs