Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventHubProperties

Package version

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

Hierarchy

  • EventHubProperties

Index

Properties

Properties

Optional endpoint

endpoint: undefined | string

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

Optional partitionCount

partitionCount: undefined | number

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.

Optional partitionIds

partitionIds: string[]

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

Optional path

path: undefined | string

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

Optional retentionTimeInDays

retentionTimeInDays: undefined | number

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

Generated using TypeDoc