1. Packages
  2. Azure Native
  3. API Docs
  4. cloudhealth
  5. getEntitySignalHistory
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

    Retrieve the time series history for a signal on an entity

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

    Using getEntitySignalHistory

    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 getEntitySignalHistory(args: GetEntitySignalHistoryArgs, opts?: InvokeOptions): Promise<GetEntitySignalHistoryResult>
    function getEntitySignalHistoryOutput(args: GetEntitySignalHistoryOutputArgs, opts?: InvokeOptions): Output<GetEntitySignalHistoryResult>
    def get_entity_signal_history(end_at: Optional[str] = None,
                                  entity_name: Optional[str] = None,
                                  health_model_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  signal_name: Optional[str] = None,
                                  start_at: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetEntitySignalHistoryResult
    def get_entity_signal_history_output(end_at: Optional[pulumi.Input[str]] = None,
                                  entity_name: Optional[pulumi.Input[str]] = None,
                                  health_model_name: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  signal_name: Optional[pulumi.Input[str]] = None,
                                  start_at: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetEntitySignalHistoryResult]
    func GetEntitySignalHistory(ctx *Context, args *GetEntitySignalHistoryArgs, opts ...InvokeOption) (*GetEntitySignalHistoryResult, error)
    func GetEntitySignalHistoryOutput(ctx *Context, args *GetEntitySignalHistoryOutputArgs, opts ...InvokeOption) GetEntitySignalHistoryResultOutput

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

    public static class GetEntitySignalHistory 
    {
        public static Task<GetEntitySignalHistoryResult> InvokeAsync(GetEntitySignalHistoryArgs args, InvokeOptions? opts = null)
        public static Output<GetEntitySignalHistoryResult> Invoke(GetEntitySignalHistoryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEntitySignalHistoryResult> getEntitySignalHistory(GetEntitySignalHistoryArgs args, InvokeOptions options)
    public static Output<GetEntitySignalHistoryResult> getEntitySignalHistory(GetEntitySignalHistoryArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:cloudhealth:getEntitySignalHistory
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EntityName string
    Name of the entity. Must be unique within a health model.
    HealthModelName string
    Name of health model resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SignalName string
    Name of the signal to get history for
    EndAt string
    End time for the history query. Defaults to now if not specified.
    StartAt string
    Start time for the history query. Defaults to 24 hours ago if not specified.
    EntityName string
    Name of the entity. Must be unique within a health model.
    HealthModelName string
    Name of health model resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SignalName string
    Name of the signal to get history for
    EndAt string
    End time for the history query. Defaults to now if not specified.
    StartAt string
    Start time for the history query. Defaults to 24 hours ago if not specified.
    entityName String
    Name of the entity. Must be unique within a health model.
    healthModelName String
    Name of health model resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    signalName String
    Name of the signal to get history for
    endAt String
    End time for the history query. Defaults to now if not specified.
    startAt String
    Start time for the history query. Defaults to 24 hours ago if not specified.
    entityName string
    Name of the entity. Must be unique within a health model.
    healthModelName string
    Name of health model resource
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    signalName string
    Name of the signal to get history for
    endAt string
    End time for the history query. Defaults to now if not specified.
    startAt string
    Start time for the history query. Defaults to 24 hours ago if not specified.
    entity_name str
    Name of the entity. Must be unique within a health model.
    health_model_name str
    Name of health model resource
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    signal_name str
    Name of the signal to get history for
    end_at str
    End time for the history query. Defaults to now if not specified.
    start_at str
    Start time for the history query. Defaults to 24 hours ago if not specified.
    entityName String
    Name of the entity. Must be unique within a health model.
    healthModelName String
    Name of health model resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    signalName String
    Name of the signal to get history for
    endAt String
    End time for the history query. Defaults to now if not specified.
    startAt String
    Start time for the history query. Defaults to 24 hours ago if not specified.

    getEntitySignalHistory Result

    The following output properties are available:

    EntityName string
    Name of the entity
    History List<Pulumi.AzureNative.CloudHealth.Outputs.SignalHistoryDataPointResponse>
    Signal history data points
    SignalName string
    Name of the signal
    EntityName string
    Name of the entity
    History []SignalHistoryDataPointResponse
    Signal history data points
    SignalName string
    Name of the signal
    entityName String
    Name of the entity
    history List<SignalHistoryDataPointResponse>
    Signal history data points
    signalName String
    Name of the signal
    entityName string
    Name of the entity
    history SignalHistoryDataPointResponse[]
    Signal history data points
    signalName string
    Name of the signal
    entity_name str
    Name of the entity
    history Sequence[SignalHistoryDataPointResponse]
    Signal history data points
    signal_name str
    Name of the signal
    entityName String
    Name of the entity
    history List<Property Map>
    Signal history data points
    signalName String
    Name of the signal

    Supporting Types

    SignalHistoryDataPointResponse

    HealthState string
    Health state at this point in time
    OccurredAt string
    Timestamp of the data point
    AdditionalContext string
    Additional context as provided by the submitter
    Value double
    Signal value at this point in time
    HealthState string
    Health state at this point in time
    OccurredAt string
    Timestamp of the data point
    AdditionalContext string
    Additional context as provided by the submitter
    Value float64
    Signal value at this point in time
    healthState String
    Health state at this point in time
    occurredAt String
    Timestamp of the data point
    additionalContext String
    Additional context as provided by the submitter
    value Double
    Signal value at this point in time
    healthState string
    Health state at this point in time
    occurredAt string
    Timestamp of the data point
    additionalContext string
    Additional context as provided by the submitter
    value number
    Signal value at this point in time
    health_state str
    Health state at this point in time
    occurred_at str
    Timestamp of the data point
    additional_context str
    Additional context as provided by the submitter
    value float
    Signal value at this point in time
    healthState String
    Health state at this point in time
    occurredAt String
    Timestamp of the data point
    additionalContext String
    Additional context as provided by the submitter
    value Number
    Signal value at this point in time

    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 v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.