IEventhubProperties Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.EventhubPropertiesTypeConverter))]
public interface IEventhubProperties : Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.IJsonSerializable
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.EventhubPropertiesTypeConverter))>]
type IEventhubProperties = interface
    interface IJsonSerializable
Public Interface IEventhubProperties
Implements IJsonSerializable
Derived
Attributes
Implements

Properties

ArchiveNameFormat

Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order

BlobContainer

Blob container Name

CaptureDescriptionEnabled

A value that indicates whether capture description is enabled.

CaptureDescriptionEncoding

Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version

CaptureDescriptionIntervalInSecond

The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds

CaptureDescriptionSizeLimitInByte

The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes

CaptureDescriptionSkipEmptyArchive

A value that indicates whether to Skip Empty Archives

CreatedAt

Exact time the Event Hub was created.

DataLakeAccountName

The Azure Data Lake Store name for the captured events

DataLakeFolderPath

The destination folder path for the captured events

DataLakeSubscriptionId

Subscription Id of Azure Data Lake Store

DestinationName

Name for capture destination

IdentityType

Type of Azure Active Directory Managed Identity.

IdentityUserAssignedIdentity

ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used.

MessageRetentionInDay

Number of days to retain the events for this Event Hub, value should be 1 to 7 days

PartitionCount

Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.

PartitionId

Current number of shards on the Event Hub.

RetentionDescriptionCleanupPolicy

Enumerates the possible values for cleanup policy

RetentionDescriptionRetentionTimeInHour

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

RetentionDescriptionTombstoneRetentionTimeInHour

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

Status

Enumerates the possible values for the status of the Event Hub.

StorageAccountResourceId

Resource id of the storage account to be used to create the blobs

UpdatedAt

The exact time the message was updated.

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to