BrokerPersistence Class

Definition

Namespace:

Azure.ResourceManager.IotOperations.Models

Assembly:

Azure.ResourceManager.IotOperations.dll

Package:

Azure.ResourceManager.IotOperations v1.1.0

Source:

BrokerPersistence.cs

Disk persistence configuration. When persistence is enabled, certain items (non-performance-critical data) selected for persistence will reside only on disk. Below are the affected items:

• Retained messages will be stored on disk only.
• WILL messages will be stored on disk only.
• DSS key/value pairs will be stored on disk only, except for performance-critical items like timed locks, which remain in both disk and memory for improved performance.

Optional. Everything is in-memory if not set. Note: if configured, all MQTT session states are written to disk.

public class BrokerPersistence : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotOperations.Models.BrokerPersistence>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotOperations.Models.BrokerPersistence>

type BrokerPersistence = class
    interface IJsonModel<BrokerPersistence>
    interface IPersistableModel<BrokerPersistence>

Public Class BrokerPersistence
Implements IJsonModel(Of BrokerPersistence), IPersistableModel(Of BrokerPersistence)

Inheritance

Object

BrokerPersistence

Implements

IJsonModel<BrokerPersistence> IPersistableModel<BrokerPersistence> IPersistableModel<T>

Constructors

Name	Description
BrokerPersistence(String)	Initializes a new instance of BrokerPersistence.

Properties

Name	Description
EncryptionMode	Determines if encryption is enabled.
MaxSize	The max size of the message buffer on disk. If a PVC template is specified using persistentVolumeClaimSpec Then this size is used as the request and limit sizes of that template. If a PVC template isn't specified Then local-path provisioner is requested with this size limit. Required.
PersistentVolumeClaimSpec	Use the specified persistent volume claim template to mount a persistent volume. Same object as in diskBackedMessageBuffer, but with a limitation that access modes field must be set to ReadWriteOncePod. If unset, a default PVC with default properties will be used. Among other things this PVC will use the cluster default storage class, which may or may not be using a local path provisioner. User is opting in to sub-optimal behavior if they leave this unset or set it without the storage class field, and their cluster default is not a local path class.
Retain	Controls which topic's retained messages should be persisted to disk.
StateStore	Controls which keys should be persisted to disk for the state store.
SubscriberQueue	Controls which subscriber message queues should be persisted to disk. Important: to facilitate reconnection, session state metadata are ALWAYS written to disk if any persistence setting is specified, even if this section isn't set.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<BrokerPersistence>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<BrokerPersistence>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<BrokerPersistence>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<BrokerPersistence>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<BrokerPersistence>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.