1. Packages
  2. Azure Native
  3. API Docs
  4. cloudhealth
  5. getEntityHistory
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
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.cloudhealth.getEntityHistory

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
Schema (JSON)
pulumi/pulumi-azure-native

    Retrieve the health state transition history for an entity

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

    Using getEntityHistory

    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 getEntityHistory(args: GetEntityHistoryArgs, opts?: InvokeOptions): Promise<GetEntityHistoryResult>
function getEntityHistoryOutput(args: GetEntityHistoryOutputArgs, opts?: InvokeOptions): Output<GetEntityHistoryResult>
    def get_entity_history(end_at: Optional[str] = None,
                       entity_name: Optional[str] = None,
                       health_model_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       start_at: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetEntityHistoryResult
def get_entity_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,
                       start_at: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetEntityHistoryResult]
    func GetEntityHistory(ctx *Context, args *GetEntityHistoryArgs, opts ...InvokeOption) (*GetEntityHistoryResult, error)
func GetEntityHistoryOutput(ctx *Context, args *GetEntityHistoryOutputArgs, opts ...InvokeOption) GetEntityHistoryResultOutput

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

    public static class GetEntityHistory 
{
    public static Task<GetEntityHistoryResult> InvokeAsync(GetEntityHistoryArgs args, InvokeOptions? opts = null)
    public static Output<GetEntityHistoryResult> Invoke(GetEntityHistoryInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEntityHistoryResult> getEntityHistory(GetEntityHistoryArgs args, InvokeOptions options)
public static Output<GetEntityHistoryResult> getEntityHistory(GetEntityHistoryArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:cloudhealth:getEntityHistory
  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.
    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.
    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.
    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.
    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.
    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.
    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.

    getEntityHistory Result

    The following output properties are available:

    EntityName string
    Name of the entity
    History []HealthStateTransitionResponse
    List of health state transitions
    entityName String
    Name of the entity
    history List<HealthStateTransitionResponse>
    List of health state transitions
    entityName string
    Name of the entity
    history HealthStateTransitionResponse[]
    List of health state transitions
    entity_name str
    Name of the entity
    history Sequence[HealthStateTransitionResponse]
    List of health state transitions
    entityName String
    Name of the entity
    history List<Property Map>
    List of health state transitions

    Supporting Types

    HealthStateTransitionResponse

    NewState string
    New health state after the transition
    OccurredAt string
    Timestamp when the transition occurred
    PreviousState string
    Previous health state before the transition
    Reason string
    Reason of the transition
    NewState string
    New health state after the transition
    OccurredAt string
    Timestamp when the transition occurred
    PreviousState string
    Previous health state before the transition
    Reason string
    Reason of the transition
    newState String
    New health state after the transition
    occurredAt String
    Timestamp when the transition occurred
    previousState String
    Previous health state before the transition
    reason String
    Reason of the transition
    newState string
    New health state after the transition
    occurredAt string
    Timestamp when the transition occurred
    previousState string
    Previous health state before the transition
    reason string
    Reason of the transition
    new_state str
    New health state after the transition
    occurred_at str
    Timestamp when the transition occurred
    previous_state str
    Previous health state before the transition
    reason str
    Reason of the transition
    newState String
    New health state after the transition
    occurredAt String
    Timestamp when the transition occurred
    previousState String
    Previous health state before the transition
    reason String
    Reason of the transition

    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
    Schema (JSON)
    pulumi/pulumi-azure-native
      Try Pulumi Cloud free. Your team will thank you.