RetentionDescription interface

Package:

@azure/arm-eventhub

Properties to configure retention settings for the eventhub

Properties

cleanupPolicy	Enumerates the possible values for cleanup policy
minCompactionLagTimeInMinutes	The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.
retentionTimeInHours	Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type.
tombstoneRetentionTimeInHours	Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. 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

minCompactionLagTimeInMinutes

The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.

minCompactionLagTimeInMinutes?: number

Property Value

number

retentionTimeInHours

Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type.

retentionTimeInHours?: number

Property Value

number

tombstoneRetentionTimeInHours

Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. 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