RetentionDescription Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview

Assembly:: Az.EventHub.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Properties to configure retention settings for the eventhub

[Microsoft.Azure.PowerShell.Cmdlets.EventHub.DoNotFormat]
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.RetentionDescriptionTypeConverter))]
public class RetentionDescription : Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.IRetentionDescription

[<Microsoft.Azure.PowerShell.Cmdlets.EventHub.DoNotFormat>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.RetentionDescriptionTypeConverter))>]
type RetentionDescription = class
    interface IRetentionDescription
    interface IJsonSerializable

Public Class RetentionDescription
Implements IRetentionDescription

Inheritance: Object
RetentionDescription

Attributes: DoNotFormatAttribute TypeConverterAttribute

Implements: IRetentionDescription IJsonSerializable

Constructors

RetentionDescription()

Creates an new RetentionDescription instance.

Properties

CleanupPolicy	Enumerates the possible values for cleanup policy
RetentionTimeInHour	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
TombstoneRetentionTimeInHour	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

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of RetentionDescription.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of RetentionDescription.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.IRetentionDescription.
FromJsonString(String)	Creates a new instance of RetentionDescription, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of RetentionDescription into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()

Applies to

Share via