Share via

CaptureDescription interface

  • Reference
Package:
@azure/arm-eventhub

Properties to configure capture description for eventhub

Properties

destination

Properties of Destination where capture will be stored. (Storage Account, Blob Names)
enabled

A value that indicates whether capture description is enabled.
encoding

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

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
sizeLimitInBytes

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
skipEmptyArchives

A value that indicates whether to Skip Empty Archives

Property Details

destination

Properties of Destination where capture will be stored. (Storage Account, Blob Names)

destination?: Destination

Property Value

Destination

enabled

A value that indicates whether capture description is enabled.

enabled?: boolean

Property Value

boolean

encoding

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

encoding?: EncodingCaptureDescription

Property Value

EncodingCaptureDescription

intervalInSeconds

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

intervalInSeconds?: number

Property Value

number

sizeLimitInBytes

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

sizeLimitInBytes?: number

Property Value

number

skipEmptyArchives

A value that indicates whether to Skip Empty Archives

skipEmptyArchives?: boolean

Property Value

boolean