1. Packages
  2. Azure Native
  3. API Docs
  4. securityinsights
  5. Bookmark
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

azure-native.securityinsights.Bookmark

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

    Represents a bookmark in Azure Security Insights. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 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 (
    	"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 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

    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. 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.UserInfo

    Describes a user that created the bookmark

    EventTime string

    The bookmark event time

    IncidentInfo Pulumi.AzureNative.SecurityInsights.Inputs.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

    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.UserInfo

    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. 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. 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 UserInfo

    Describes a user that created the bookmark

    eventTime String

    The bookmark event time

    incidentInfo 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

    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 UserInfo

    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. 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 UserInfo

    Describes a user that created the bookmark

    eventTime string

    The bookmark event time

    incidentInfo IncidentInfo

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

    The name of the resource group. 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. 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

    The name of the resource

    SystemData Pulumi.AzureNative.SecurityInsights.Outputs.SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Etag string

    Etag of the azure resource

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The name of the resource

    SystemData SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Etag string

    Etag of the azure resource

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the resource

    systemData SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    etag String

    Etag of the azure resource

    id string

    The provider-assigned unique ID for this managed resource.

    name string

    The name of the resource

    systemData SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    etag string

    Etag of the azure resource

    id str

    The provider-assigned unique ID for this managed resource.

    name str

    The name of the resource

    system_data SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type str

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    etag str

    Etag of the azure resource

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the resource

    systemData Property Map

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    etag String

    Etag of the azure resource

    Supporting Types

    IncidentInfo, IncidentInfoArgs

    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, IncidentInfoResponseArgs

    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, IncidentSeverityArgs

    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

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string

    The timestamp of resource creation (UTC).

    CreatedBy string

    The identity that created the resource.

    CreatedByType string

    The type of identity that created the resource.

    LastModifiedAt string

    The timestamp of resource last modification (UTC)

    LastModifiedBy string

    The identity that last modified the resource.

    LastModifiedByType string

    The type of identity that last modified the resource.

    CreatedAt string

    The timestamp of resource creation (UTC).

    CreatedBy string

    The identity that created the resource.

    CreatedByType string

    The type of identity that created the resource.

    LastModifiedAt string

    The timestamp of resource last modification (UTC)

    LastModifiedBy string

    The identity that last modified the resource.

    LastModifiedByType string

    The type of identity that last modified the resource.

    createdAt String

    The timestamp of resource creation (UTC).

    createdBy String

    The identity that created the resource.

    createdByType String

    The type of identity that created the resource.

    lastModifiedAt String

    The timestamp of resource last modification (UTC)

    lastModifiedBy String

    The identity that last modified the resource.

    lastModifiedByType String

    The type of identity that last modified the resource.

    createdAt string

    The timestamp of resource creation (UTC).

    createdBy string

    The identity that created the resource.

    createdByType string

    The type of identity that created the resource.

    lastModifiedAt string

    The timestamp of resource last modification (UTC)

    lastModifiedBy string

    The identity that last modified the resource.

    lastModifiedByType string

    The type of identity that last modified the resource.

    created_at str

    The timestamp of resource creation (UTC).

    created_by str

    The identity that created the resource.

    created_by_type str

    The type of identity that created the resource.

    last_modified_at str

    The timestamp of resource last modification (UTC)

    last_modified_by str

    The identity that last modified the resource.

    last_modified_by_type str

    The type of identity that last modified the resource.

    createdAt String

    The timestamp of resource creation (UTC).

    createdBy String

    The identity that created the resource.

    createdByType String

    The type of identity that created the resource.

    lastModifiedAt String

    The timestamp of resource last modification (UTC)

    lastModifiedBy String

    The identity that last modified the resource.

    lastModifiedByType String

    The type of identity that last modified the resource.

    UserInfo, UserInfoArgs

    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, UserInfoResponseArgs

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi