Azure Native v1.102.0, May 2 23

azure-native.securityinsights.getEntityInsights

Explore with Pulumi AI

Execute Insights for an entity. API Version: 2019-01-01-preview.

Using getEntityInsights

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 getEntityInsights(args: GetEntityInsightsArgs, opts?: InvokeOptions): Promise<GetEntityInsightsResult>
function getEntityInsightsOutput(args: GetEntityInsightsOutputArgs, opts?: InvokeOptions): Output<GetEntityInsightsResult>

def get_entity_insights(add_default_extended_time_range: Optional[bool] = None,
                        end_time: Optional[str] = None,
                        entity_id: Optional[str] = None,
                        insight_query_ids: Optional[Sequence[str]] = None,
                        operational_insights_resource_provider: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        start_time: Optional[str] = None,
                        workspace_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetEntityInsightsResult
def get_entity_insights_output(add_default_extended_time_range: Optional[pulumi.Input[bool]] = None,
                        end_time: Optional[pulumi.Input[str]] = None,
                        entity_id: Optional[pulumi.Input[str]] = None,
                        insight_query_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        operational_insights_resource_provider: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        start_time: Optional[pulumi.Input[str]] = None,
                        workspace_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetEntityInsightsResult]

func GetEntityInsights(ctx *Context, args *GetEntityInsightsArgs, opts ...InvokeOption) (*GetEntityInsightsResult, error)
func GetEntityInsightsOutput(ctx *Context, args *GetEntityInsightsOutputArgs, opts ...InvokeOption) GetEntityInsightsResultOutput

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

public static class GetEntityInsights 
{
    public static Task<GetEntityInsightsResult> InvokeAsync(GetEntityInsightsArgs args, InvokeOptions? opts = null)
    public static Output<GetEntityInsightsResult> Invoke(GetEntityInsightsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEntityInsightsResult> getEntityInsights(GetEntityInsightsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

EndTime string: The end timeline date, so the results returned are before this date.
EntityId string: entity ID
OperationalInsightsResourceProvider string: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
ResourceGroupName string: The name of the resource group within the user's subscription. The name is case insensitive.
StartTime string: The start timeline date, so the results returned are after this date.
WorkspaceName string: The name of the workspace.
AddDefaultExtendedTimeRange bool: Indicates if query time range should be extended with default time range of the query. Default value is false
InsightQueryIds List<string>: List of Insights Query Id. If empty, default value is all insights of this entity

EndTime string: The end timeline date, so the results returned are before this date.
EntityId string: entity ID
OperationalInsightsResourceProvider string: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
ResourceGroupName string: The name of the resource group within the user's subscription. The name is case insensitive.
StartTime string: The start timeline date, so the results returned are after this date.
WorkspaceName string: The name of the workspace.
AddDefaultExtendedTimeRange bool: Indicates if query time range should be extended with default time range of the query. Default value is false
InsightQueryIds []string: List of Insights Query Id. If empty, default value is all insights of this entity

endTime String: The end timeline date, so the results returned are before this date.
entityId String: entity ID
operationalInsightsResourceProvider String: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
resourceGroupName String: The name of the resource group within the user's subscription. The name is case insensitive.
startTime String: The start timeline date, so the results returned are after this date.
workspaceName String: The name of the workspace.
addDefaultExtendedTimeRange Boolean: Indicates if query time range should be extended with default time range of the query. Default value is false
insightQueryIds List<String>: List of Insights Query Id. If empty, default value is all insights of this entity

endTime string: The end timeline date, so the results returned are before this date.
entityId string: entity ID
operationalInsightsResourceProvider string: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
resourceGroupName string: The name of the resource group within the user's subscription. The name is case insensitive.
startTime string: The start timeline date, so the results returned are after this date.
workspaceName string: The name of the workspace.
addDefaultExtendedTimeRange boolean: Indicates if query time range should be extended with default time range of the query. Default value is false
insightQueryIds string[]: List of Insights Query Id. If empty, default value is all insights of this entity

end_time str: The end timeline date, so the results returned are before this date.
entity_id str: entity ID
operational_insights_resource_provider str: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
resource_group_name str: The name of the resource group within the user's subscription. The name is case insensitive.
start_time str: The start timeline date, so the results returned are after this date.
workspace_name str: The name of the workspace.
add_default_extended_time_range bool: Indicates if query time range should be extended with default time range of the query. Default value is false
insight_query_ids Sequence[str]: List of Insights Query Id. If empty, default value is all insights of this entity

endTime String: The end timeline date, so the results returned are before this date.
entityId String: entity ID
operationalInsightsResourceProvider String: The namespace of workspaces resource provider- Microsoft.OperationalInsights.
resourceGroupName String: The name of the resource group within the user's subscription. The name is case insensitive.
startTime String: The start timeline date, so the results returned are after this date.
workspaceName String: The name of the workspace.
addDefaultExtendedTimeRange Boolean: Indicates if query time range should be extended with default time range of the query. Default value is false
insightQueryIds List<String>: List of Insights Query Id. If empty, default value is all insights of this entity

getEntityInsights Result

The following output properties are available:

MetaData Pulumi.AzureNative.SecurityInsights.Outputs.GetInsightsResultsMetadataResponse: The metadata from the get insights operation results.
Value List<Pulumi.AzureNative.SecurityInsights.Outputs.EntityInsightItemResponse>: The insights result values.

MetaData GetInsightsResultsMetadataResponse: The metadata from the get insights operation results.
Value []EntityInsightItemResponse: The insights result values.

metaData GetInsightsResultsMetadataResponse: The metadata from the get insights operation results.
value List<EntityInsightItemResponse>: The insights result values.

metaData GetInsightsResultsMetadataResponse: The metadata from the get insights operation results.
value EntityInsightItemResponse[]: The insights result values.

meta_data GetInsightsResultsMetadataResponse: The metadata from the get insights operation results.
value Sequence[EntityInsightItemResponse]: The insights result values.

metaData Property Map: The metadata from the get insights operation results.
value List<Property Map>: The insights result values.

Supporting Types

EntityInsightItemResponse

ChartQueryResults List<Pulumi.AzureNative.SecurityInsights.Inputs.InsightsTableResultResponse>: Query results for table insights query.
QueryId string: The query id of the insight
QueryTimeInterval Pulumi.AzureNative.SecurityInsights.Inputs.EntityInsightItemResponseQueryTimeInterval: The Time interval that the query actually executed on.
TableQueryResults Pulumi.AzureNative.SecurityInsights.Inputs.InsightsTableResultResponse: Query results for table insights query.

ChartQueryResults []InsightsTableResultResponse: Query results for table insights query.
QueryId string: The query id of the insight
QueryTimeInterval EntityInsightItemResponseQueryTimeInterval: The Time interval that the query actually executed on.
TableQueryResults InsightsTableResultResponse: Query results for table insights query.

chartQueryResults List<InsightsTableResultResponse>: Query results for table insights query.
queryId String: The query id of the insight
queryTimeInterval EntityInsightItemResponseQueryTimeInterval: The Time interval that the query actually executed on.
tableQueryResults InsightsTableResultResponse: Query results for table insights query.

chartQueryResults InsightsTableResultResponse[]: Query results for table insights query.
queryId string: The query id of the insight
queryTimeInterval EntityInsightItemResponseQueryTimeInterval: The Time interval that the query actually executed on.
tableQueryResults InsightsTableResultResponse: Query results for table insights query.

chart_query_results Sequence[InsightsTableResultResponse]: Query results for table insights query.
query_id str: The query id of the insight
query_time_interval EntityInsightItemResponseQueryTimeInterval: The Time interval that the query actually executed on.
table_query_results InsightsTableResultResponse: Query results for table insights query.

chartQueryResults List<Property Map>: Query results for table insights query.
queryId String: The query id of the insight
queryTimeInterval Property Map: The Time interval that the query actually executed on.
tableQueryResults Property Map: Query results for table insights query.

EntityInsightItemResponseQueryTimeInterval

EndTime string: Insight query end time
StartTime string: Insight query start time

EndTime string: Insight query end time
StartTime string: Insight query start time

endTime String: Insight query end time
startTime String: Insight query start time

endTime string: Insight query end time
startTime string: Insight query start time

end_time str: Insight query end time
start_time str: Insight query start time

endTime String: Insight query end time
startTime String: Insight query start time

GetInsightsErrorResponse

ErrorMessage string: the error message
Kind string: the query kind
QueryId string: the query id

ErrorMessage string: the error message
Kind string: the query kind
QueryId string: the query id

errorMessage String: the error message
kind String: the query kind
queryId String: the query id

errorMessage string: the error message
kind string: the query kind
queryId string: the query id

error_message str: the error message
kind str: the query kind
query_id str: the query id

errorMessage String: the error message
kind String: the query kind
queryId String: the query id

GetInsightsResultsMetadataResponse

TotalCount int: the total items found for the insights request
Errors List<Pulumi.AzureNative.SecurityInsights.Inputs.GetInsightsErrorResponse>: information about the failed queries

TotalCount int: the total items found for the insights request
Errors []GetInsightsErrorResponse: information about the failed queries

totalCount Integer: the total items found for the insights request
errors List<GetInsightsErrorResponse>: information about the failed queries

totalCount number: the total items found for the insights request
errors GetInsightsErrorResponse[]: information about the failed queries

total_count int: the total items found for the insights request
errors Sequence[GetInsightsErrorResponse]: information about the failed queries

totalCount Number: the total items found for the insights request
errors List<Property Map>: information about the failed queries

InsightsTableResultResponse

Columns List<Pulumi.AzureNative.SecurityInsights.Inputs.InsightsTableResultResponseColumns>: Columns Metadata of the table
Rows List<ImmutableArray<string>>: Rows data of the table

Columns []InsightsTableResultResponseColumns: Columns Metadata of the table
Rows [][]string: Rows data of the table

columns List<InsightsTableResultResponseColumns>: Columns Metadata of the table
rows List<List<String>>: Rows data of the table

columns InsightsTableResultResponseColumns[]: Columns Metadata of the table
rows string[][]: Rows data of the table

columns Sequence[InsightsTableResultResponseColumns]: Columns Metadata of the table
rows Sequence[Sequence[str]]: Rows data of the table

columns List<Property Map>: Columns Metadata of the table
rows List<List<String>>: Rows data of the table

InsightsTableResultResponseColumns

Name string: the name of the colum
Type string: the type of the colum

Name string: the name of the colum
Type string: the type of the colum

name String: the name of the colum
type String: the type of the colum

name string: the name of the colum
type string: the type of the colum

name str: the name of the colum
type str: the type of the colum

name String: the name of the colum
type String: the type of the colum

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0