Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. securityinsights
  5. getBookmarkRelation
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.getBookmarkRelation

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 relation. Azure REST API version: 2023-06-01-preview.

Other available API versions: 2019-01-01-preview, 2023-07-01-preview, 2023-08-01-preview, 2023-09-01-preview, 2023-10-01-preview, 2023-12-01-preview, 2024-01-01-preview, 2024-04-01-preview, 2024-10-01-preview.

Using getBookmarkRelation

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 getBookmarkRelation(args: GetBookmarkRelationArgs, opts?: InvokeOptions): Promise<GetBookmarkRelationResult>
function getBookmarkRelationOutput(args: GetBookmarkRelationOutputArgs, opts?: InvokeOptions): Output<GetBookmarkRelationResult>
Copy
def get_bookmark_relation(bookmark_id: Optional[str] = None,
                          relation_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          workspace_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetBookmarkRelationResult
def get_bookmark_relation_output(bookmark_id: Optional[pulumi.Input[str]] = None,
                          relation_name: 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[GetBookmarkRelationResult]
Copy
func LookupBookmarkRelation(ctx *Context, args *LookupBookmarkRelationArgs, opts ...InvokeOption) (*LookupBookmarkRelationResult, error)
func LookupBookmarkRelationOutput(ctx *Context, args *LookupBookmarkRelationOutputArgs, opts ...InvokeOption) LookupBookmarkRelationResultOutput
Copy

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

public static class GetBookmarkRelation 
{
    public static Task<GetBookmarkRelationResult> InvokeAsync(GetBookmarkRelationArgs args, InvokeOptions? opts = null)
    public static Output<GetBookmarkRelationResult> Invoke(GetBookmarkRelationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBookmarkRelationResult> getBookmarkRelation(GetBookmarkRelationArgs args, InvokeOptions options)
public static Output<GetBookmarkRelationResult> getBookmarkRelation(GetBookmarkRelationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:securityinsights:getBookmarkRelation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BookmarkId
This property is required.
Changes to this property will trigger replacement.
string
Bookmark ID
RelationName
This property is required.
Changes to this property will trigger replacement.
string
Relation Name
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
RelationName
This property is required.
Changes to this property will trigger replacement.
string
Relation Name
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
relationName
This property is required.
Changes to this property will trigger replacement.
String
Relation Name
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
relationName
This property is required.
Changes to this property will trigger replacement.
string
Relation Name
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
relation_name
This property is required.
Changes to this property will trigger replacement.
str
Relation Name
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
relationName
This property is required.
Changes to this property will trigger replacement.
String
Relation Name
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.

getBookmarkRelation Result

The following output properties are available:

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
RelatedResourceId string
The resource ID of the related resource
RelatedResourceKind string
The resource kind of the related resource
RelatedResourceName string
The name of the related resource
RelatedResourceType string
The resource type of the related 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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
RelatedResourceId string
The resource ID of the related resource
RelatedResourceKind string
The resource kind of the related resource
RelatedResourceName string
The name of the related resource
RelatedResourceType string
The resource type of the related 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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
relatedResourceId String
The resource ID of the related resource
relatedResourceKind String
The resource kind of the related resource
relatedResourceName String
The name of the related resource
relatedResourceType String
The resource type of the related 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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
relatedResourceId string
The resource ID of the related resource
relatedResourceKind string
The resource kind of the related resource
relatedResourceName string
The name of the related resource
relatedResourceType string
The resource type of the related 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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
related_resource_id str
The resource ID of the related resource
related_resource_kind str
The resource kind of the related resource
related_resource_name str
The name of the related resource
related_resource_type str
The resource type of the related 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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
relatedResourceId String
The resource ID of the related resource
relatedResourceKind String
The resource kind of the related resource
relatedResourceName String
The name of the related resource
relatedResourceType String
The resource type of the related 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

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.

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