azure-native.securityinsights.getBookmark
Explore with Pulumi AI
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, 2025-01-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>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)
public static Output<GetBookmarkResult> getBookmark(GetBookmarkArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:securityinsights:getBookmark
  arguments:
    # arguments dictionaryThe following arguments are supported:
- BookmarkId string
- Bookmark ID
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- WorkspaceName string
- The name of the workspace.
- BookmarkId string
- Bookmark ID
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- WorkspaceName string
- The name of the workspace.
- bookmarkId String
- Bookmark ID
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- workspaceName String
- The name of the workspace.
- bookmarkId string
- Bookmark ID
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- workspaceName string
- The name of the workspace.
- bookmark_id str
- Bookmark ID
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- workspace_name str
- The name of the workspace.
- bookmarkId String
- Bookmark ID
- resourceGroup StringName 
- The name of the resource group. 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
- 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.Azure Native. Security Insights. Outputs. System Data Response 
- 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.Azure Native. Security Insights. Outputs. User Info Response 
- Describes a user that created the bookmark
- Etag string
- Etag of the azure resource
- EventTime string
- The bookmark event time
- IncidentInfo Pulumi.Azure Native. Security Insights. Outputs. Incident Info Response 
- Describes an incident that relates to bookmark
- Labels List<string>
- List of labels relevant to this bookmark
- Notes string
- The notes of the bookmark
- QueryEnd stringTime 
- The end time for the query
- QueryResult string
- The query result of the bookmark.
- QueryStart stringTime 
- The start time for the query
- Updated string
- The last time the bookmark was updated
- UpdatedBy Pulumi.Azure Native. Security Insights. Outputs. User Info Response 
- 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 SystemData Response 
- 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 UserInfo Response 
- Describes a user that created the bookmark
- Etag string
- Etag of the azure resource
- EventTime string
- The bookmark event time
- IncidentInfo IncidentInfo Response 
- Describes an incident that relates to bookmark
- Labels []string
- List of labels relevant to this bookmark
- Notes string
- The notes of the bookmark
- QueryEnd stringTime 
- The end time for the query
- QueryResult string
- The query result of the bookmark.
- QueryStart stringTime 
- The start time for the query
- Updated string
- The last time the bookmark was updated
- UpdatedBy UserInfo Response 
- 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 SystemData Response 
- 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 UserInfo Response 
- Describes a user that created the bookmark
- etag String
- Etag of the azure resource
- eventTime String
- The bookmark event time
- incidentInfo IncidentInfo Response 
- Describes an incident that relates to bookmark
- labels List<String>
- List of labels relevant to this bookmark
- notes String
- The notes of the bookmark
- queryEnd StringTime 
- The end time for the query
- queryResult String
- The query result of the bookmark.
- queryStart StringTime 
- The start time for the query
- updated String
- The last time the bookmark was updated
- updatedBy UserInfo Response 
- 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 SystemData Response 
- 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 UserInfo Response 
- Describes a user that created the bookmark
- etag string
- Etag of the azure resource
- eventTime string
- The bookmark event time
- incidentInfo IncidentInfo Response 
- Describes an incident that relates to bookmark
- labels string[]
- List of labels relevant to this bookmark
- notes string
- The notes of the bookmark
- queryEnd stringTime 
- The end time for the query
- queryResult string
- The query result of the bookmark.
- queryStart stringTime 
- The start time for the query
- updated string
- The last time the bookmark was updated
- updatedBy UserInfo Response 
- 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 SystemData Response 
- 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 UserInfo Response 
- Describes a user that created the bookmark
- etag str
- Etag of the azure resource
- event_time str
- The bookmark event time
- incident_info IncidentInfo Response 
- 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_ strtime 
- The end time for the query
- query_result str
- The query result of the bookmark.
- query_start_ strtime 
- The start time for the query
- updated str
- The last time the bookmark was updated
- updated_by UserInfo Response 
- 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
- queryEnd StringTime 
- The end time for the query
- queryResult String
- The query result of the bookmark.
- queryStart StringTime 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
UserInfoResponse  
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0