Azure Native v1.98.0, Mar 23 23

azure-native.securityinsights.getActivityCustomEntityQuery

Gets an entity query. API Version: 2021-03-01-preview.

Using getActivityCustomEntityQuery

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 getActivityCustomEntityQuery(args: GetActivityCustomEntityQueryArgs, opts?: InvokeOptions): Promise<GetActivityCustomEntityQueryResult>
function getActivityCustomEntityQueryOutput(args: GetActivityCustomEntityQueryOutputArgs, opts?: InvokeOptions): Output<GetActivityCustomEntityQueryResult>

def get_activity_custom_entity_query(entity_query_id: Optional[str] = None,
                                     operational_insights_resource_provider: Optional[str] = None,
                                     resource_group_name: Optional[str] = None,
                                     workspace_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetActivityCustomEntityQueryResult
def get_activity_custom_entity_query_output(entity_query_id: Optional[pulumi.Input[str]] = None,
                                     operational_insights_resource_provider: 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[GetActivityCustomEntityQueryResult]

func LookupActivityCustomEntityQuery(ctx *Context, args *LookupActivityCustomEntityQueryArgs, opts ...InvokeOption) (*LookupActivityCustomEntityQueryResult, error)
func LookupActivityCustomEntityQueryOutput(ctx *Context, args *LookupActivityCustomEntityQueryOutputArgs, opts ...InvokeOption) LookupActivityCustomEntityQueryResultOutput

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

public static class GetActivityCustomEntityQuery 
{
    public static Task<GetActivityCustomEntityQueryResult> InvokeAsync(GetActivityCustomEntityQueryArgs args, InvokeOptions? opts = null)
    public static Output<GetActivityCustomEntityQueryResult> Invoke(GetActivityCustomEntityQueryInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetActivityCustomEntityQueryResult> getActivityCustomEntityQuery(GetActivityCustomEntityQueryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:securityinsights:getActivityCustomEntityQuery
  arguments:
    # arguments dictionary

The following arguments are supported:

EntityQueryId string: entity query ID
OperationalInsightsResourceProvider string: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
WorkspaceName string: The name of the workspace.

EntityQueryId string: entity query ID
OperationalInsightsResourceProvider string: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
WorkspaceName string: The name of the workspace.

entityQueryId String: entity query ID
operationalInsightsResourceProvider String: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
resourceGroupName String: The name of the resource group. The name is case insensitive.
workspaceName String: The name of the workspace.

entityQueryId string: entity query ID
operationalInsightsResourceProvider string: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
resourceGroupName string: The name of the resource group. The name is case insensitive.
workspaceName string: The name of the workspace.

entity_query_id str: entity query ID
operational_insights_resource_provider str: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
resource_group_name str: The name of the resource group. The name is case insensitive.
workspace_name str: The name of the workspace.

entityQueryId String: entity query ID
operationalInsightsResourceProvider String: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
resourceGroupName String: The name of the resource group. The name is case insensitive.
workspaceName String: The name of the workspace.

getActivityCustomEntityQuery Result

The following output properties are available:

CreatedTimeUtc string: The time the activity was created
Id string: Azure resource Id
LastModifiedTimeUtc string: The last time the activity was updated
Name string: Azure resource name
SystemData Pulumi.AzureNative.SecurityInsights.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: Azure resource type
Content string: The entity query content to display in timeline
Description string: The entity query description
Enabled bool: Determines whether this activity is enabled or disabled.
EntitiesFilter Dictionary<string, ImmutableArray<string>>: The query applied only to entities matching to all filters
Etag string: Etag of the azure resource
InputEntityType string: The type of the query's source entity
QueryDefinitions Pulumi.AzureNative.SecurityInsights.Outputs.ActivityEntityQueriesPropertiesResponseQueryDefinitions: The Activity query definitions
RequiredInputFieldsSets List<ImmutableArray<string>>: List of the fields of the source entity that are required to run the query
TemplateName string: The template id this activity was created from
Title string: The entity query title

CreatedTimeUtc string: The time the activity was created
Id string: Azure resource Id
LastModifiedTimeUtc string: The last time the activity was updated
Name string: Azure resource name
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: Azure resource type
Content string: The entity query content to display in timeline
Description string: The entity query description
Enabled bool: Determines whether this activity is enabled or disabled.
EntitiesFilter map[string][]string: The query applied only to entities matching to all filters
Etag string: Etag of the azure resource
InputEntityType string: The type of the query's source entity
QueryDefinitions ActivityEntityQueriesPropertiesResponseQueryDefinitions: The Activity query definitions
RequiredInputFieldsSets [][]string: List of the fields of the source entity that are required to run the query
TemplateName string: The template id this activity was created from
Title string: The entity query title

createdTimeUtc String: The time the activity was created
id String: Azure resource Id
lastModifiedTimeUtc String: The last time the activity was updated
name String: Azure resource name
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: Azure resource type
content String: The entity query content to display in timeline
description String: The entity query description
enabled Boolean: Determines whether this activity is enabled or disabled.
entitiesFilter Map<String,List<String>>: The query applied only to entities matching to all filters
etag String: Etag of the azure resource
inputEntityType String: The type of the query's source entity
queryDefinitions ActivityEntityQueriesPropertiesResponseQueryDefinitions: The Activity query definitions
requiredInputFieldsSets List<List<String>>: List of the fields of the source entity that are required to run the query
templateName String: The template id this activity was created from
title String: The entity query title

createdTimeUtc string: The time the activity was created
id string: Azure resource Id
lastModifiedTimeUtc string: The last time the activity was updated
name string: Azure resource name
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: Azure resource type
content string: The entity query content to display in timeline
description string: The entity query description
enabled boolean: Determines whether this activity is enabled or disabled.
entitiesFilter {[key: string]: string[]}: The query applied only to entities matching to all filters
etag string: Etag of the azure resource
inputEntityType string: The type of the query's source entity
queryDefinitions ActivityEntityQueriesPropertiesResponseQueryDefinitions: The Activity query definitions
requiredInputFieldsSets string[][]: List of the fields of the source entity that are required to run the query
templateName string: The template id this activity was created from
title string: The entity query title

created_time_utc str: The time the activity was created
id str: Azure resource Id
last_modified_time_utc str: The last time the activity was updated
name str: Azure resource name
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: Azure resource type
content str: The entity query content to display in timeline
description str: The entity query description
enabled bool: Determines whether this activity is enabled or disabled.
entities_filter Mapping[str, Sequence[str]]: The query applied only to entities matching to all filters
etag str: Etag of the azure resource
input_entity_type str: The type of the query's source entity
query_definitions ActivityEntityQueriesPropertiesResponseQueryDefinitions: The Activity query definitions
required_input_fields_sets Sequence[Sequence[str]]: List of the fields of the source entity that are required to run the query
template_name str: The template id this activity was created from
title str: The entity query title

createdTimeUtc String: The time the activity was created
id String: Azure resource Id
lastModifiedTimeUtc String: The last time the activity was updated
name String: Azure resource name
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: Azure resource type
content String: The entity query content to display in timeline
description String: The entity query description
enabled Boolean: Determines whether this activity is enabled or disabled.
entitiesFilter Map<List<String>>: The query applied only to entities matching to all filters
etag String: Etag of the azure resource
inputEntityType String: The type of the query's source entity
queryDefinitions Property Map: The Activity query definitions
requiredInputFieldsSets List<List<String>>: List of the fields of the source entity that are required to run the query
templateName String: The template id this activity was created from
title String: The entity query title

Supporting Types

ActivityEntityQueriesPropertiesResponseQueryDefinitions

Query string: The Activity query to run on a given entity

Query string: The Activity query to run on a given entity

query String: The Activity query to run on a given entity

query string: The Activity query to run on a given entity

query str: The Activity query to run on a given entity

query String: The Activity query to run on a given entity

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