Push Agent properties

Property name	Property type	Property description
DataLogger	NodeId	A reference to the data logger instance.
DataLoggerPullTme	Duration	The time interval after which data is taken from the data logger and stored in the auxiliary store. If `PreserveDataLoggerHistory` is set to `True`, the original data is deleted from the data logger after copying it to the auxiliary store.
PushFullSample	Boolean	If `True`, the by line transfer mode is used. If `False`, the by variable transfer mode is used.
PreserveDataLoggerHistory	Boolean	If `True`, the data is sent and historicized. If `False`, every time the data is transferred to the auxiliary store, the data is deleted from the data logger.
MaximumStoreCapacity	Int32	The maximum capacity of the auxiliary store used by the Push Agent.
MaximumItemsPerPacket	Int32	The number of records encapsulated in a packet. by line transfer mode sends only one line per packet. Tip: When `PushFullSample` is set to `True`, set the `MaximumItemsPerPacket` to `1`.
MaximumPublishTime	Duration	The maximum time interval after which data is taken from the auxiliary store and sent to the cloud. The interval is used when the auxiliary store has fewer records than `MaximumItemsPerPacket`.
MinimumPublishTime	Duration	The minimum time interval after which data is taken from the auxiliary store and sent to the cloud. The interval is used when the auxiliary store has more records than `MaximumItemsPerPacket`. You may want to increase the sending frequency to download the queue of the store.
ClientId	String	The `ID` of the client that has to send the data.
BrokerIPAddress	String	The broker IP address or hostname.
BrokerPort	Int32	The broker port (if you want to communicate with SSL, set the value to `8883`).
BrokerTopic	String	The name of the topic you want to publish on preceded by `/`.
QoS	Int32	The Quality Of Service (QoS) level used to send information. `0` `AT_MOST_ONCE` `1` `AT_LEAST_ONCE` `2` `EXACTLY_ONCE`
UseSSL	Boolean	Enables or disables secure communication. CACert The path to the file that contains the CA (must be in the `PEM` format). ClientCert The path to the file that contains the client certificate (must be in the `PFX` format). ClientCertPassword The password of the client certificate. Important: Use the newest OpenSSL library and encryption algorithm supported in .NET to generate the PFX certificates. If you use the RC2 algorithm to generate the PFX certificate, certificate-based authentication for Azure IoT Hub fails on the terminal
Username	String	The username for authenticated communication with the broker.
Password	Password	The password for authenticated communication with the broker.

DataLogger

NodeId

A reference to the data logger instance.

DataLoggerPullTme

Duration

The time interval after which data is taken from the data logger and stored in the auxiliary store. If PreserveDataLoggerHistory is set to True, the original data is deleted from the data logger after copying it to the auxiliary store.

PushFullSample

Boolean

If True, the by line transfer mode is used.

If False, the by variable transfer mode is used.

PreserveDataLoggerHistory

Boolean

If True, the data is sent and historicized.

If False, every time the data is transferred to the auxiliary store, the data is deleted from the data logger.

MaximumStoreCapacity

Int32

The maximum capacity of the auxiliary store used by the Push Agent.

MaximumItemsPerPacket

Int32

The number of records encapsulated in a packet. by line transfer mode sends only one line per packet.

Tip: When PushFullSample is set to True, set the MaximumItemsPerPacket to 1.

MaximumPublishTime

Duration

The maximum time interval after which data is taken from the auxiliary store and sent to the cloud. The interval is used when the auxiliary store has fewer records than MaximumItemsPerPacket.

MinimumPublishTime

Duration

The minimum time interval after which data is taken from the auxiliary store and sent to the cloud. The interval is used when the auxiliary store has more records than MaximumItemsPerPacket. You may want to increase the sending frequency to download the queue of the store.

ClientId

String

The ID of the client that has to send the data.

BrokerIPAddress

String

The broker IP address or hostname.

BrokerPort

Int32

The broker port (if you want to communicate with SSL, set the value to 8883).

BrokerTopic

String

The name of the topic you want to publish on preceded by /.

QoS

Int32

The Quality Of Service (QoS) level used to send information.

0: AT_MOST_ONCE
1: AT_LEAST_ONCE
2: EXACTLY_ONCE

UseSSL

Boolean

Enables or disables secure communication.

CACert: The path to the file that contains the CA (must be in the PEM format).
ClientCert: The path to the file that contains the client certificate (must be in the PFX format).
ClientCertPassword: The password of the client certificate.

Important: Use the newest OpenSSL library and encryption algorithm supported in .NET to generate the PFX certificates. If you use the RC2 algorithm to generate the PFX certificate, certificate-based authentication for Azure IoT Hub fails on the terminal

Username

String

The username for authenticated communication with the broker.

Password

The password for authenticated communication with the broker.