CaptureDescription Class

Definition

Properties to configure capture description for eventhub

[Microsoft.Azure.PowerShell.Cmdlets.EventHub.DoNotFormat]
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.CaptureDescriptionTypeConverter))]
public class CaptureDescription : Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.ICaptureDescription
[<Microsoft.Azure.PowerShell.Cmdlets.EventHub.DoNotFormat>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.CaptureDescriptionTypeConverter))>]
type CaptureDescription = class
    interface ICaptureDescription
    interface IJsonSerializable
Public Class CaptureDescription
Implements ICaptureDescription
Inheritance
CaptureDescription
Attributes
Implements

Constructors

CaptureDescription()

Creates an new CaptureDescription instance.

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

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

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

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.

IntervalInSecond

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

SizeLimitInByte

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

SkipEmptyArchive

A value that indicates whether to Skip Empty Archives

StorageAccountResourceId

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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of CaptureDescription.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of CaptureDescription.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.ICaptureDescription.

FromJsonString(String)

Creates a new instance of CaptureDescription, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of CaptureDescription into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to