Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. securityinsights
  5. HuntRelation
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.securityinsights.HuntRelation

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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Represents a Hunt Relation in Azure Security Insights. Azure REST API version: 2023-06-01-preview.

    Other available API versions: 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, 2025-01-01-preview.

    Example Usage

    Creates or updates a hunt relation.

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var huntRelation = new AzureNative.SecurityInsights.HuntRelation("huntRelation", new()
    {
        HuntId = "163e7b2a-a2ec-4041-aaba-d878a38f265f",
        HuntRelationId = "2216d0e1-91e3-4902-89fd-d2df8c535096",
        Labels = new[]
        {
            "Test Label",
        },
        RelatedResourceId = "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096",
        ResourceGroupName = "myRg",
        WorkspaceName = "myWorkspace",
    });

});

    package main

import (
	securityinsights "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.NewHuntRelation(ctx, "huntRelation", &securityinsights.HuntRelationArgs{
			HuntId:         pulumi.String("163e7b2a-a2ec-4041-aaba-d878a38f265f"),
			HuntRelationId: pulumi.String("2216d0e1-91e3-4902-89fd-d2df8c535096"),
			Labels: pulumi.StringArray{
				pulumi.String("Test Label"),
			},
			RelatedResourceId: pulumi.String("/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096"),
			ResourceGroupName: pulumi.String("myRg"),
			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.HuntRelation;
import com.pulumi.azurenative.securityinsights.HuntRelationArgs;
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 huntRelation = new HuntRelation("huntRelation", HuntRelationArgs.builder()
            .huntId("163e7b2a-a2ec-4041-aaba-d878a38f265f")
            .huntRelationId("2216d0e1-91e3-4902-89fd-d2df8c535096")
            .labels("Test Label")
            .relatedResourceId("/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096")
            .resourceGroupName("myRg")
            .workspaceName("myWorkspace")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const huntRelation = new azure_native.securityinsights.HuntRelation("huntRelation", {
    huntId: "163e7b2a-a2ec-4041-aaba-d878a38f265f",
    huntRelationId: "2216d0e1-91e3-4902-89fd-d2df8c535096",
    labels: ["Test Label"],
    relatedResourceId: "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096",
    resourceGroupName: "myRg",
    workspaceName: "myWorkspace",
});

    import pulumi
import pulumi_azure_native as azure_native

hunt_relation = azure_native.securityinsights.HuntRelation("huntRelation",
    hunt_id="163e7b2a-a2ec-4041-aaba-d878a38f265f",
    hunt_relation_id="2216d0e1-91e3-4902-89fd-d2df8c535096",
    labels=["Test Label"],
    related_resource_id="/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096",
    resource_group_name="myRg",
    workspace_name="myWorkspace")

    resources:
  huntRelation:
    type: azure-native:securityinsights:HuntRelation
    properties:
      huntId: 163e7b2a-a2ec-4041-aaba-d878a38f265f
      huntRelationId: 2216d0e1-91e3-4902-89fd-d2df8c535096
      labels:
        - Test Label
      relatedResourceId: /subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096
      resourceGroupName: myRg
      workspaceName: myWorkspace

    Create HuntRelation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HuntRelation(name: string, args: HuntRelationArgs, opts?: CustomResourceOptions);
    @overload
def HuntRelation(resource_name: str,
                 args: HuntRelationArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def HuntRelation(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 hunt_id: Optional[str] = None,
                 related_resource_id: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 workspace_name: Optional[str] = None,
                 hunt_relation_id: Optional[str] = None,
                 labels: Optional[Sequence[str]] = None)
    func NewHuntRelation(ctx *Context, name string, args HuntRelationArgs, opts ...ResourceOption) (*HuntRelation, error)
    public HuntRelation(string name, HuntRelationArgs args, CustomResourceOptions? opts = null)
    public HuntRelation(String name, HuntRelationArgs args)
public HuntRelation(String name, HuntRelationArgs args, CustomResourceOptions options)

    type: azure-native:securityinsights:HuntRelation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args HuntRelationArgs
    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 HuntRelationArgs
    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 HuntRelationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HuntRelationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HuntRelationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var huntRelationResource = new AzureNative.SecurityInsights.HuntRelation("huntRelationResource", new()
{
    HuntId = "string",
    RelatedResourceId = "string",
    ResourceGroupName = "string",
    WorkspaceName = "string",
    HuntRelationId = "string",
    Labels = new[]
    {
        "string",
    },
});

    example, err := securityinsights.NewHuntRelation(ctx, "huntRelationResource", &securityinsights.HuntRelationArgs{
	HuntId:            pulumi.String("string"),
	RelatedResourceId: pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	WorkspaceName:     pulumi.String("string"),
	HuntRelationId:    pulumi.String("string"),
	Labels: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var huntRelationResource = new HuntRelation("huntRelationResource", HuntRelationArgs.builder()
    .huntId("string")
    .relatedResourceId("string")
    .resourceGroupName("string")
    .workspaceName("string")
    .huntRelationId("string")
    .labels("string")
    .build());

    hunt_relation_resource = azure_native.securityinsights.HuntRelation("huntRelationResource",
    hunt_id="string",
    related_resource_id="string",
    resource_group_name="string",
    workspace_name="string",
    hunt_relation_id="string",
    labels=["string"])

    const huntRelationResource = new azure_native.securityinsights.HuntRelation("huntRelationResource", {
    huntId: "string",
    relatedResourceId: "string",
    resourceGroupName: "string",
    workspaceName: "string",
    huntRelationId: "string",
    labels: ["string"],
});

    type: azure-native:securityinsights:HuntRelation
properties:
    huntId: string
    huntRelationId: string
    labels:
        - string
    relatedResourceId: string
    resourceGroupName: string
    workspaceName: string

    HuntRelation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The HuntRelation resource accepts the following input properties:

    HuntId string
    The hunt id (GUID)
    RelatedResourceId string
    The id of the related resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    HuntRelationId string
    The hunt relation id (GUID)
    Labels List<string>
    List of labels relevant to this hunt
    HuntId string
    The hunt id (GUID)
    RelatedResourceId string
    The id of the related resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    HuntRelationId string
    The hunt relation id (GUID)
    Labels []string
    List of labels relevant to this hunt
    huntId String
    The hunt id (GUID)
    relatedResourceId String
    The id of the related resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.
    huntRelationId String
    The hunt relation id (GUID)
    labels List<String>
    List of labels relevant to this hunt
    huntId string
    The hunt id (GUID)
    relatedResourceId string
    The id of the related resource
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    workspaceName string
    The name of the workspace.
    huntRelationId string
    The hunt relation id (GUID)
    labels string[]
    List of labels relevant to this hunt
    hunt_id str
    The hunt id (GUID)
    related_resource_id str
    The id of the related resource
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    workspace_name str
    The name of the workspace.
    hunt_relation_id str
    The hunt relation id (GUID)
    labels Sequence[str]
    List of labels relevant to this hunt
    huntId String
    The hunt id (GUID)
    relatedResourceId String
    The id of the related resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.
    huntRelationId String
    The hunt relation id (GUID)
    labels List<String>
    List of labels relevant to this hunt

    Outputs

    All input properties are implicitly available as output properties. Additionally, the HuntRelation resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    RelatedResourceKind string
    The resource that the relation is related to
    RelatedResourceName string
    The name of the related resource
    RelationType string
    The type of the hunt relation
    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
    RelatedResourceKind string
    The resource that the relation is related to
    RelatedResourceName string
    The name of the related resource
    RelationType string
    The type of the hunt relation
    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
    relatedResourceKind String
    The resource that the relation is related to
    relatedResourceName String
    The name of the related resource
    relationType String
    The type of the hunt relation
    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
    relatedResourceKind string
    The resource that the relation is related to
    relatedResourceName string
    The name of the related resource
    relationType string
    The type of the hunt relation
    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
    related_resource_kind str
    The resource that the relation is related to
    related_resource_name str
    The name of the related resource
    relation_type str
    The type of the hunt relation
    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
    relatedResourceKind String
    The resource that the relation is related to
    relatedResourceName String
    The name of the related resource
    relationType String
    The type of the hunt relation
    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, 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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:securityinsights:HuntRelation 2216d0e1-91e3-4902-89fd-d2df8c535096 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts/{huntId}/relations/{huntRelationId}

    To learn more about importing existing cloud resources, see Importing resources.

    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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native