Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. securityinsights
  5. getBookmark
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.securityinsights.getBookmark

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a bookmark. Azure REST API version: 2023-02-01.

Other available API versions: 2019-01-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-09-01, 2024-10-01-preview.

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>
Copy
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]
Copy
func LookupBookmark(ctx *Context, args *LookupBookmarkArgs, opts ...InvokeOption) (*LookupBookmarkResult, error)
func LookupBookmarkOutput(ctx *Context, args *LookupBookmarkOutputArgs, opts ...InvokeOption) LookupBookmarkResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetBookmarkResult> getBookmark(GetBookmarkArgs args, InvokeOptions options)
public static Output<GetBookmarkResult> getBookmark(GetBookmarkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:securityinsights:getBookmark
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BookmarkId
This property is required.
Changes to this property will trigger replacement.
string
Bookmark ID
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
BookmarkId
This property is required.
Changes to this property will trigger replacement.
string
Bookmark ID
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
bookmarkId
This property is required.
Changes to this property will trigger replacement.
String
Bookmark ID
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
bookmarkId
This property is required.
Changes to this property will trigger replacement.
string
Bookmark ID
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
bookmark_id
This property is required.
Changes to this property will trigger replacement.
str
Bookmark ID
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
bookmarkId
This property is required.
Changes to this property will trigger replacement.
String
Bookmark ID
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getBookmark Result

The following output properties are available:

DisplayName string
The display name of the bookmark
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
Query string
The query of the bookmark.
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"
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
Query string
The query of the bookmark.
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"
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
query String
The query of the bookmark.
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"
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
query string
The query of the bookmark.
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"
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
query str
The query of the bookmark.
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"
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
query String
The query of the bookmark.
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"
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

SystemDataResponse

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.

UserInfoResponse

Email This property is required. string
The email of the user.
Name This property is required. string
The name of the user.
ObjectId string
The object id of the user.
Email This property is required. string
The email of the user.
Name This property is required. string
The name of the user.
ObjectId string
The object id of the user.
email This property is required. String
The email of the user.
name This property is required. String
The name of the user.
objectId String
The object id of the user.
email This property is required. string
The email of the user.
name This property is required. string
The name of the user.
objectId string
The object id of the user.
email This property is required. str
The email of the user.
name This property is required. str
The name of the user.
object_id str
The object id of the user.
email This property is required. String
The email of the user.
name This property is required. String
The name of the user.
objectId String
The object id of the user.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native