Share via

IoTHubStreamInputDataSource interface

  • Reference
Package:
@azure/arm-streamanalytics

Describes an IoT Hub input data source that contains stream data.

Extends
StreamInputDataSource

Properties

consumerGroupName

The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub. If not specified, the input uses the Iot Hub’s default consumer group.
endpoint

The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
iotHubNamespace

The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyKey

The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyName

The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests.
type

Polymorphic discriminator, which specifies the different types this object can be

Property Details

consumerGroupName

The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub. If not specified, the input uses the Iot Hub’s default consumer group.

consumerGroupName?: string

Property Value

string

endpoint

The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).

endpoint?: string

Property Value

string

iotHubNamespace

The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests.

iotHubNamespace?: string

Property Value

string

sharedAccessPolicyKey

The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.

sharedAccessPolicyKey?: string

Property Value

string

sharedAccessPolicyName

The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests.

sharedAccessPolicyName?: string

Property Value

string

type

Polymorphic discriminator, which specifies the different types this object can be

type: "Microsoft.Devices/IotHubs"

Property Value

"Microsoft.Devices/IotHubs"