azure-native.securityinsights.getEntitiesGetTimeline
Explore with Pulumi AI
Timeline for an entity. Azure REST API version: 2023-06-01-preview.
Other available API versions: 2019-01-01-preview, 2021-09-01-preview, 2021-10-01-preview, 2022-01-01-preview, 2022-04-01-preview, 2022-05-01-preview, 2022-06-01-preview, 2022-07-01-preview, 2022-08-01-preview, 2022-09-01-preview, 2022-10-01-preview, 2022-11-01-preview, 2022-12-01-preview, 2023-02-01-preview, 2023-03-01-preview, 2023-04-01-preview, 2023-05-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, 2025-01-01-preview.
Using getEntitiesGetTimeline
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 getEntitiesGetTimeline(args: GetEntitiesGetTimelineArgs, opts?: InvokeOptions): Promise<GetEntitiesGetTimelineResult>
function getEntitiesGetTimelineOutput(args: GetEntitiesGetTimelineOutputArgs, opts?: InvokeOptions): Output<GetEntitiesGetTimelineResult>def get_entities_get_timeline(end_time: Optional[str] = None,
                              entity_id: Optional[str] = None,
                              kinds: Optional[Sequence[Union[str, EntityTimelineKind]]] = None,
                              number_of_bucket: Optional[int] = None,
                              resource_group_name: Optional[str] = None,
                              start_time: Optional[str] = None,
                              workspace_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetEntitiesGetTimelineResult
def get_entities_get_timeline_output(end_time: Optional[pulumi.Input[str]] = None,
                              entity_id: Optional[pulumi.Input[str]] = None,
                              kinds: Optional[pulumi.Input[Sequence[pulumi.Input[Union[str, EntityTimelineKind]]]]] = None,
                              number_of_bucket: Optional[pulumi.Input[int]] = 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[GetEntitiesGetTimelineResult]func GetEntitiesGetTimeline(ctx *Context, args *GetEntitiesGetTimelineArgs, opts ...InvokeOption) (*GetEntitiesGetTimelineResult, error)
func GetEntitiesGetTimelineOutput(ctx *Context, args *GetEntitiesGetTimelineOutputArgs, opts ...InvokeOption) GetEntitiesGetTimelineResultOutput> Note: This function is named GetEntitiesGetTimeline in the Go SDK.
public static class GetEntitiesGetTimeline 
{
    public static Task<GetEntitiesGetTimelineResult> InvokeAsync(GetEntitiesGetTimelineArgs args, InvokeOptions? opts = null)
    public static Output<GetEntitiesGetTimelineResult> Invoke(GetEntitiesGetTimelineInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetEntitiesGetTimelineResult> getEntitiesGetTimeline(GetEntitiesGetTimelineArgs args, InvokeOptions options)
public static Output<GetEntitiesGetTimelineResult> getEntitiesGetTimeline(GetEntitiesGetTimelineArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:securityinsights:getEntitiesGetTimeline
  arguments:
    # arguments dictionaryThe following arguments are supported:
- EndTime string
- The end timeline date, so the results returned are before this date.
- EntityId string
- entity ID
- ResourceGroup stringName 
- The name of the resource group. 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.
- Kinds
List<Union<string, Pulumi.Azure Native. Security Insights. Entity Timeline Kind>> 
- Array of timeline Item kinds.
- NumberOf intBucket 
- The number of bucket for timeline queries aggregation.
- EndTime string
- The end timeline date, so the results returned are before this date.
- EntityId string
- entity ID
- ResourceGroup stringName 
- The name of the resource group. 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.
- Kinds []string
- Array of timeline Item kinds.
- NumberOf intBucket 
- The number of bucket for timeline queries aggregation.
- endTime String
- The end timeline date, so the results returned are before this date.
- entityId String
- entity ID
- resourceGroup StringName 
- The name of the resource group. 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.
- kinds
List<Either<String,EntityTimeline Kind>> 
- Array of timeline Item kinds.
- numberOf IntegerBucket 
- The number of bucket for timeline queries aggregation.
- endTime string
- The end timeline date, so the results returned are before this date.
- entityId string
- entity ID
- resourceGroup stringName 
- The name of the resource group. 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.
- kinds
(string | EntityTimeline Kind)[] 
- Array of timeline Item kinds.
- numberOf numberBucket 
- The number of bucket for timeline queries aggregation.
- end_time str
- The end timeline date, so the results returned are before this date.
- entity_id str
- entity ID
- resource_group_ strname 
- The name of the resource group. 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.
- kinds
Sequence[Union[str, EntityTimeline Kind]] 
- Array of timeline Item kinds.
- number_of_ intbucket 
- The number of bucket for timeline queries aggregation.
- endTime String
- The end timeline date, so the results returned are before this date.
- entityId String
- entity ID
- resourceGroup StringName 
- The name of the resource group. 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.
- kinds
List<String | "Activity" | "Bookmark" | "SecurityAlert" | "Anomaly"> 
- Array of timeline Item kinds.
- numberOf NumberBucket 
- The number of bucket for timeline queries aggregation.
getEntitiesGetTimeline Result
The following output properties are available:
- MetaData Pulumi.Azure Native. Security Insights. Outputs. Timeline Results Metadata Response 
- The metadata from the timeline operation results.
- Value List<object>
- The timeline result values.
- MetaData TimelineResults Metadata Response 
- The metadata from the timeline operation results.
- Value []interface{}
- The timeline result values.
- metaData TimelineResults Metadata Response 
- The metadata from the timeline operation results.
- value List<Object>
- The timeline result values.
- metaData TimelineResults Metadata Response 
- The metadata from the timeline operation results.
- value
(ActivityTimeline Item Response | Anomaly Timeline Item Response | Bookmark Timeline Item Response | Security Alert Timeline Item Response)[] 
- The timeline result values.
- meta_data TimelineResults Metadata Response 
- The metadata from the timeline operation results.
- value Sequence[Any]
- The timeline result values.
- metaData Property Map
- The metadata from the timeline operation results.
- value List<Property Map | Property Map | Property Map | Property Map>
- The timeline result values.
Supporting Types
ActivityTimelineItemResponse   
- BucketEnd stringTime UTC 
- The grouping bucket end time.
- BucketStart stringTime UTC 
- The grouping bucket start time.
- Content string
- The activity timeline content.
- FirstActivity stringTime UTC 
- The time of the first activity in the grouping bucket.
- LastActivity stringTime UTC 
- The time of the last activity in the grouping bucket.
- QueryId string
- The activity query id.
- Title string
- The activity timeline title.
- BucketEnd stringTime UTC 
- The grouping bucket end time.
- BucketStart stringTime UTC 
- The grouping bucket start time.
- Content string
- The activity timeline content.
- FirstActivity stringTime UTC 
- The time of the first activity in the grouping bucket.
- LastActivity stringTime UTC 
- The time of the last activity in the grouping bucket.
- QueryId string
- The activity query id.
- Title string
- The activity timeline title.
- bucketEnd StringTime UTC 
- The grouping bucket end time.
- bucketStart StringTime UTC 
- The grouping bucket start time.
- content String
- The activity timeline content.
- firstActivity StringTime UTC 
- The time of the first activity in the grouping bucket.
- lastActivity StringTime UTC 
- The time of the last activity in the grouping bucket.
- queryId String
- The activity query id.
- title String
- The activity timeline title.
- bucketEnd stringTime UTC 
- The grouping bucket end time.
- bucketStart stringTime UTC 
- The grouping bucket start time.
- content string
- The activity timeline content.
- firstActivity stringTime UTC 
- The time of the first activity in the grouping bucket.
- lastActivity stringTime UTC 
- The time of the last activity in the grouping bucket.
- queryId string
- The activity query id.
- title string
- The activity timeline title.
- bucket_end_ strtime_ utc 
- The grouping bucket end time.
- bucket_start_ strtime_ utc 
- The grouping bucket start time.
- content str
- The activity timeline content.
- first_activity_ strtime_ utc 
- The time of the first activity in the grouping bucket.
- last_activity_ strtime_ utc 
- The time of the last activity in the grouping bucket.
- query_id str
- The activity query id.
- title str
- The activity timeline title.
- bucketEnd StringTime UTC 
- The grouping bucket end time.
- bucketStart StringTime UTC 
- The grouping bucket start time.
- content String
- The activity timeline content.
- firstActivity StringTime UTC 
- The time of the first activity in the grouping bucket.
- lastActivity StringTime UTC 
- The time of the last activity in the grouping bucket.
- queryId String
- The activity query id.
- title String
- The activity timeline title.
AnomalyTimelineItemResponse   
- AzureResource stringId 
- The anomaly azure resource id.
- DisplayName string
- The anomaly name.
- EndTime stringUtc 
- The anomaly end time.
- StartTime stringUtc 
- The anomaly start time.
- TimeGenerated string
- The anomaly generated time.
- Description string
- The anomaly description.
- Intent string
- The intent of the anomaly.
- ProductName string
- The anomaly product name.
- Reasons List<string>
- The reasons that cause the anomaly.
- Techniques List<string>
- The techniques of the anomaly.
- Vendor string
- The name of the anomaly vendor.
- AzureResource stringId 
- The anomaly azure resource id.
- DisplayName string
- The anomaly name.
- EndTime stringUtc 
- The anomaly end time.
- StartTime stringUtc 
- The anomaly start time.
- TimeGenerated string
- The anomaly generated time.
- Description string
- The anomaly description.
- Intent string
- The intent of the anomaly.
- ProductName string
- The anomaly product name.
- Reasons []string
- The reasons that cause the anomaly.
- Techniques []string
- The techniques of the anomaly.
- Vendor string
- The name of the anomaly vendor.
- azureResource StringId 
- The anomaly azure resource id.
- displayName String
- The anomaly name.
- endTime StringUtc 
- The anomaly end time.
- startTime StringUtc 
- The anomaly start time.
- timeGenerated String
- The anomaly generated time.
- description String
- The anomaly description.
- intent String
- The intent of the anomaly.
- productName String
- The anomaly product name.
- reasons List<String>
- The reasons that cause the anomaly.
- techniques List<String>
- The techniques of the anomaly.
- vendor String
- The name of the anomaly vendor.
- azureResource stringId 
- The anomaly azure resource id.
- displayName string
- The anomaly name.
- endTime stringUtc 
- The anomaly end time.
- startTime stringUtc 
- The anomaly start time.
- timeGenerated string
- The anomaly generated time.
- description string
- The anomaly description.
- intent string
- The intent of the anomaly.
- productName string
- The anomaly product name.
- reasons string[]
- The reasons that cause the anomaly.
- techniques string[]
- The techniques of the anomaly.
- vendor string
- The name of the anomaly vendor.
- azure_resource_ strid 
- The anomaly azure resource id.
- display_name str
- The anomaly name.
- end_time_ strutc 
- The anomaly end time.
- start_time_ strutc 
- The anomaly start time.
- time_generated str
- The anomaly generated time.
- description str
- The anomaly description.
- intent str
- The intent of the anomaly.
- product_name str
- The anomaly product name.
- reasons Sequence[str]
- The reasons that cause the anomaly.
- techniques Sequence[str]
- The techniques of the anomaly.
- vendor str
- The name of the anomaly vendor.
- azureResource StringId 
- The anomaly azure resource id.
- displayName String
- The anomaly name.
- endTime StringUtc 
- The anomaly end time.
- startTime StringUtc 
- The anomaly start time.
- timeGenerated String
- The anomaly generated time.
- description String
- The anomaly description.
- intent String
- The intent of the anomaly.
- productName String
- The anomaly product name.
- reasons List<String>
- The reasons that cause the anomaly.
- techniques List<String>
- The techniques of the anomaly.
- vendor String
- The name of the anomaly vendor.
BookmarkTimelineItemResponse   
- AzureResource stringId 
- The bookmark azure resource id.
- CreatedBy Pulumi.Azure Native. Security Insights. Inputs. User Info Response 
- Describes a user that created the bookmark
- DisplayName string
- The bookmark display name.
- EndTime stringUtc 
- The bookmark end time.
- EventTime string
- The bookmark event time.
- Labels List<string>
- List of labels relevant to this bookmark
- Notes string
- The notes of the bookmark
- StartTime stringUtc 
- The bookmark start time.
- AzureResource stringId 
- The bookmark azure resource id.
- CreatedBy UserInfo Response 
- Describes a user that created the bookmark
- DisplayName string
- The bookmark display name.
- EndTime stringUtc 
- The bookmark end time.
- EventTime string
- The bookmark event time.
- Labels []string
- List of labels relevant to this bookmark
- Notes string
- The notes of the bookmark
- StartTime stringUtc 
- The bookmark start time.
- azureResource StringId 
- The bookmark azure resource id.
- createdBy UserInfo Response 
- Describes a user that created the bookmark
- displayName String
- The bookmark display name.
- endTime StringUtc 
- The bookmark end time.
- eventTime String
- The bookmark event time.
- labels List<String>
- List of labels relevant to this bookmark
- notes String
- The notes of the bookmark
- startTime StringUtc 
- The bookmark start time.
- azureResource stringId 
- The bookmark azure resource id.
- createdBy UserInfo Response 
- Describes a user that created the bookmark
- displayName string
- The bookmark display name.
- endTime stringUtc 
- The bookmark end time.
- eventTime string
- The bookmark event time.
- labels string[]
- List of labels relevant to this bookmark
- notes string
- The notes of the bookmark
- startTime stringUtc 
- The bookmark start time.
- azure_resource_ strid 
- The bookmark azure resource id.
- created_by UserInfo Response 
- Describes a user that created the bookmark
- display_name str
- The bookmark display name.
- end_time_ strutc 
- The bookmark end time.
- event_time str
- The bookmark event time.
- labels Sequence[str]
- List of labels relevant to this bookmark
- notes str
- The notes of the bookmark
- start_time_ strutc 
- The bookmark start time.
- azureResource StringId 
- The bookmark azure resource id.
- createdBy Property Map
- Describes a user that created the bookmark
- displayName String
- The bookmark display name.
- endTime StringUtc 
- The bookmark end time.
- eventTime String
- The bookmark event time.
- labels List<String>
- List of labels relevant to this bookmark
- notes String
- The notes of the bookmark
- startTime StringUtc 
- The bookmark start time.
EntityTimelineKind  
SecurityAlertTimelineItemResponse    
- AlertType string
- The name of the alert type.
- AzureResource stringId 
- The alert azure resource id.
- DisplayName string
- The alert name.
- EndTime stringUtc 
- The alert end time.
- Intent string
- The intent of the alert.
- Severity string
- The alert severity.
- StartTime stringUtc 
- The alert start time.
- TimeGenerated string
- The alert generated time.
- Description string
- The alert description.
- ProductName string
- The alert product name.
- Techniques List<string>
- The techniques of the alert.
- AlertType string
- The name of the alert type.
- AzureResource stringId 
- The alert azure resource id.
- DisplayName string
- The alert name.
- EndTime stringUtc 
- The alert end time.
- Intent string
- The intent of the alert.
- Severity string
- The alert severity.
- StartTime stringUtc 
- The alert start time.
- TimeGenerated string
- The alert generated time.
- Description string
- The alert description.
- ProductName string
- The alert product name.
- Techniques []string
- The techniques of the alert.
- alertType String
- The name of the alert type.
- azureResource StringId 
- The alert azure resource id.
- displayName String
- The alert name.
- endTime StringUtc 
- The alert end time.
- intent String
- The intent of the alert.
- severity String
- The alert severity.
- startTime StringUtc 
- The alert start time.
- timeGenerated String
- The alert generated time.
- description String
- The alert description.
- productName String
- The alert product name.
- techniques List<String>
- The techniques of the alert.
- alertType string
- The name of the alert type.
- azureResource stringId 
- The alert azure resource id.
- displayName string
- The alert name.
- endTime stringUtc 
- The alert end time.
- intent string
- The intent of the alert.
- severity string
- The alert severity.
- startTime stringUtc 
- The alert start time.
- timeGenerated string
- The alert generated time.
- description string
- The alert description.
- productName string
- The alert product name.
- techniques string[]
- The techniques of the alert.
- alert_type str
- The name of the alert type.
- azure_resource_ strid 
- The alert azure resource id.
- display_name str
- The alert name.
- end_time_ strutc 
- The alert end time.
- intent str
- The intent of the alert.
- severity str
- The alert severity.
- start_time_ strutc 
- The alert start time.
- time_generated str
- The alert generated time.
- description str
- The alert description.
- product_name str
- The alert product name.
- techniques Sequence[str]
- The techniques of the alert.
- alertType String
- The name of the alert type.
- azureResource StringId 
- The alert azure resource id.
- displayName String
- The alert name.
- endTime StringUtc 
- The alert end time.
- intent String
- The intent of the alert.
- severity String
- The alert severity.
- startTime StringUtc 
- The alert start time.
- timeGenerated String
- The alert generated time.
- description String
- The alert description.
- productName String
- The alert product name.
- techniques List<String>
- The techniques of the alert.
TimelineAggregationResponse  
TimelineErrorResponse  
- 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
TimelineResultsMetadataResponse   
- Aggregations
List<Pulumi.Azure Native. Security Insights. Inputs. Timeline Aggregation Response> 
- timeline aggregation per kind
- TotalCount int
- the total items found for the timeline request
- Errors
List<Pulumi.Azure Native. Security Insights. Inputs. Timeline Error Response> 
- information about the failure queries
- Aggregations
[]TimelineAggregation Response 
- timeline aggregation per kind
- TotalCount int
- the total items found for the timeline request
- Errors
[]TimelineError Response 
- information about the failure queries
- aggregations
List<TimelineAggregation Response> 
- timeline aggregation per kind
- totalCount Integer
- the total items found for the timeline request
- errors
List<TimelineError Response> 
- information about the failure queries
- aggregations
TimelineAggregation Response[] 
- timeline aggregation per kind
- totalCount number
- the total items found for the timeline request
- errors
TimelineError Response[] 
- information about the failure queries
- aggregations
Sequence[TimelineAggregation Response] 
- timeline aggregation per kind
- total_count int
- the total items found for the timeline request
- errors
Sequence[TimelineError Response] 
- information about the failure queries
- aggregations List<Property Map>
- timeline aggregation per kind
- totalCount Number
- the total items found for the timeline request
- errors List<Property Map>
- information about the failure queries
UserInfoResponse  
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0