Share via

RetentionDescription interface

  • Reference
Package:
@azure/arm-eventhub

Properties to configure retention settings for the eventhub

Properties

cleanupPolicy

Enumerates the possible values for cleanup policy
retentionTimeInHours

Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue
tombstoneRetentionTimeInHours

Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub

Property Details

cleanupPolicy

Enumerates the possible values for cleanup policy

cleanupPolicy?: string

Property Value

string

retentionTimeInHours

Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue

retentionTimeInHours?: number

Property Value

number

tombstoneRetentionTimeInHours

Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub

tombstoneRetentionTimeInHours?: number

Property Value

number