1. Packages
  2. Azure Native v1
  3. API Docs
  4. securityinsights
  5. getBookmark
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

azure-native.securityinsights.getBookmark

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

    Gets a bookmark. API Version: 2020-01-01.

    Using getBookmark

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBookmark(args: GetBookmarkArgs, opts?: InvokeOptions): Promise<GetBookmarkResult>
    function getBookmarkOutput(args: GetBookmarkOutputArgs, opts?: InvokeOptions): Output<GetBookmarkResult>
    def get_bookmark(bookmark_id: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     workspace_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetBookmarkResult
    def get_bookmark_output(bookmark_id: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     workspace_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetBookmarkResult]
    func LookupBookmark(ctx *Context, args *LookupBookmarkArgs, opts ...InvokeOption) (*LookupBookmarkResult, error)
    func LookupBookmarkOutput(ctx *Context, args *LookupBookmarkOutputArgs, opts ...InvokeOption) LookupBookmarkResultOutput

    > Note: This function is named LookupBookmark in the Go SDK.

    public static class GetBookmark 
    {
        public static Task<GetBookmarkResult> InvokeAsync(GetBookmarkArgs args, InvokeOptions? opts = null)
        public static Output<GetBookmarkResult> Invoke(GetBookmarkInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBookmarkResult> getBookmark(GetBookmarkArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:securityinsights:getBookmark
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BookmarkId string
    Bookmark ID
    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
    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
    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
    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.
    bookmark_id str
    Bookmark ID
    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.
    bookmarkId String
    Bookmark ID
    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.

    getBookmark Result

    The following output properties are available:

    DisplayName string
    The display name of the bookmark
    Id string
    Azure resource Id
    Name string
    Azure resource name
    Query string
    The query of the bookmark.
    Type string
    Azure resource type
    Created string
    The time the bookmark was created
    CreatedBy Pulumi.AzureNative.SecurityInsights.Outputs.UserInfoResponse
    Describes a user that created the bookmark
    Etag string
    Etag of the azure resource
    EventTime string
    The bookmark event time
    IncidentInfo Pulumi.AzureNative.SecurityInsights.Outputs.IncidentInfoResponse
    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.Outputs.UserInfoResponse
    Describes a user that updated the bookmark
    DisplayName string
    The display name of the bookmark
    Id string
    Azure resource Id
    Name string
    Azure resource name
    Query string
    The query of the bookmark.
    Type string
    Azure resource type
    Created string
    The time the bookmark was created
    CreatedBy UserInfoResponse
    Describes a user that created the bookmark
    Etag string
    Etag of the azure resource
    EventTime string
    The bookmark event time
    IncidentInfo IncidentInfoResponse
    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 UserInfoResponse
    Describes a user that updated the bookmark
    displayName String
    The display name of the bookmark
    id String
    Azure resource Id
    name String
    Azure resource name
    query String
    The query of the bookmark.
    type String
    Azure resource type
    created String
    The time the bookmark was created
    createdBy UserInfoResponse
    Describes a user that created the bookmark
    etag String
    Etag of the azure resource
    eventTime String
    The bookmark event time
    incidentInfo IncidentInfoResponse
    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 UserInfoResponse
    Describes a user that updated the bookmark
    displayName string
    The display name of the bookmark
    id string
    Azure resource Id
    name string
    Azure resource name
    query string
    The query of the bookmark.
    type string
    Azure resource type
    created string
    The time the bookmark was created
    createdBy UserInfoResponse
    Describes a user that created the bookmark
    etag string
    Etag of the azure resource
    eventTime string
    The bookmark event time
    incidentInfo IncidentInfoResponse
    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 UserInfoResponse
    Describes a user that updated the bookmark
    display_name str
    The display name of the bookmark
    id str
    Azure resource Id
    name str
    Azure resource name
    query str
    The query of the bookmark.
    type str
    Azure resource type
    created str
    The time the bookmark was created
    created_by UserInfoResponse
    Describes a user that created the bookmark
    etag str
    Etag of the azure resource
    event_time str
    The bookmark event time
    incident_info IncidentInfoResponse
    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 UserInfoResponse
    Describes a user that updated the bookmark
    displayName String
    The display name of the bookmark
    id String
    Azure resource Id
    name String
    Azure resource name
    query String
    The query of the bookmark.
    type String
    Azure resource type
    created String
    The time the bookmark was created
    createdBy Property Map
    Describes a user that created the bookmark
    etag String
    Etag of the azure resource
    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

    Supporting Types

    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

    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.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi