Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. securityinsights
  5. getHuntRelation
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.securityinsights.getHuntRelation

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a hunt relation

Uses Azure REST API version 2025-01-01-preview.

Other available API versions: 2023-04-01-preview, 2023-05-01-preview, 2023-06-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. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native securityinsights [ApiVersion]. See the version guide for details.

Using getHuntRelation

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 getHuntRelation(args: GetHuntRelationArgs, opts?: InvokeOptions): Promise<GetHuntRelationResult>
function getHuntRelationOutput(args: GetHuntRelationOutputArgs, opts?: InvokeOptions): Output<GetHuntRelationResult>
Copy
def get_hunt_relation(hunt_id: Optional[str] = None,
                      hunt_relation_id: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      workspace_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetHuntRelationResult
def get_hunt_relation_output(hunt_id: Optional[pulumi.Input[str]] = None,
                      hunt_relation_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[GetHuntRelationResult]
Copy
func LookupHuntRelation(ctx *Context, args *LookupHuntRelationArgs, opts ...InvokeOption) (*LookupHuntRelationResult, error)
func LookupHuntRelationOutput(ctx *Context, args *LookupHuntRelationOutputArgs, opts ...InvokeOption) LookupHuntRelationResultOutput
Copy

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

public static class GetHuntRelation 
{
    public static Task<GetHuntRelationResult> InvokeAsync(GetHuntRelationArgs args, InvokeOptions? opts = null)
    public static Output<GetHuntRelationResult> Invoke(GetHuntRelationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHuntRelationResult> getHuntRelation(GetHuntRelationArgs args, InvokeOptions options)
public static Output<GetHuntRelationResult> getHuntRelation(GetHuntRelationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:securityinsights:getHuntRelation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

HuntId
This property is required.
Changes to this property will trigger replacement.
string
The hunt id (GUID)
HuntRelationId
This property is required.
Changes to this property will trigger replacement.
string
The hunt relation id (GUID)
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.
HuntId
This property is required.
Changes to this property will trigger replacement.
string
The hunt id (GUID)
HuntRelationId
This property is required.
Changes to this property will trigger replacement.
string
The hunt relation id (GUID)
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.
huntId
This property is required.
Changes to this property will trigger replacement.
String
The hunt id (GUID)
huntRelationId
This property is required.
Changes to this property will trigger replacement.
String
The hunt relation id (GUID)
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.
huntId
This property is required.
Changes to this property will trigger replacement.
string
The hunt id (GUID)
huntRelationId
This property is required.
Changes to this property will trigger replacement.
string
The hunt relation id (GUID)
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.
hunt_id
This property is required.
Changes to this property will trigger replacement.
str
The hunt id (GUID)
hunt_relation_id
This property is required.
Changes to this property will trigger replacement.
str
The hunt relation id (GUID)
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.
huntId
This property is required.
Changes to this property will trigger replacement.
String
The hunt id (GUID)
huntRelationId
This property is required.
Changes to this property will trigger replacement.
String
The hunt relation id (GUID)
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.

getHuntRelation Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the 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 id of the related 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
Labels List<string>
List of labels relevant to this hunt
AzureApiVersion string
The Azure API version of the 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 id of the related 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
Labels []string
List of labels relevant to this hunt
azureApiVersion String
The Azure API version of the 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 id of the related 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
labels List<String>
List of labels relevant to this hunt
azureApiVersion string
The Azure API version of the 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 id of the related 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
labels string[]
List of labels relevant to this hunt
azure_api_version str
The Azure API version of the 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 id of the related 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
labels Sequence[str]
List of labels relevant to this hunt
azureApiVersion String
The Azure API version of the 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 id of the related 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
labels List<String>
List of labels relevant to this hunt

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 pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native