Share via


CaptureDescription Class

Definition

Properties to configure capture description for eventhub.

public class CaptureDescription : Azure.Provisioning.Primitives.ProvisionableConstruct
public class CaptureDescription : Azure.Provisioning.Primitives.ProvisioningConstruct
type CaptureDescription = class
    inherit ProvisionableConstruct
type CaptureDescription = class
    inherit ProvisioningConstruct
Public Class CaptureDescription
Inherits ProvisionableConstruct
Public Class CaptureDescription
Inherits ProvisioningConstruct
Inheritance
Inheritance

Constructors

CaptureDescription()

Creates a new CaptureDescription.

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.

Methods

AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableConstruct)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisioningConstruct)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of CaptureDescription.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
GetResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
OverrideWithExpression(Expression)

Set this construct to represent the result of an expression. This is primarily meant to be called via FromExpression static methods on specific resources or constructs.

(Inherited from ProvisioningConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from Provisionable)
Resolve(ProvisioningContext)

Resolve any resources or properties that were not explicitly specified.

(Inherited from Provisionable)
Resolve(ProvisioningContext)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisioningConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from Provisionable)
Validate(ProvisioningContext)

Validate the presence of any required members.

(Inherited from Provisionable)
Validate(ProvisioningContext)

Validate the presence of any required members.

(Inherited from ProvisioningConstruct)

Explicit Interface Implementations

IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Applies to