EventHubProperties interface

Package:

@azure/arm-iothub

The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.

Properties

endpoint	The Event Hub-compatible endpoint. NOTE: This property will not be serialized. It can only be populated by the server.
partitionCount	The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	The partition ids in the Event Hub-compatible endpoint. NOTE: This property will not be serialized. It can only be populated by the server.
path	The Event Hub-compatible name. NOTE: This property will not be serialized. It can only be populated by the server.
retentionTimeInDays	The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

Property Details

endpoint

The Event Hub-compatible endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

endpoint?: string

Property Value

string

partitionCount

The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

partitionCount?: number

Property Value

number

partitionIds

The partition ids in the Event Hub-compatible endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

partitionIds?: string[]

Property Value

string[]

path

The Event Hub-compatible name. NOTE: This property will not be serialized. It can only be populated by the server.

path?: string

Property Value

string

retentionTimeInDays

The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

retentionTimeInDays?: number

Property Value

number