Package version:

Interface IoTHubStreamInputDataSource

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

interface IoTHubStreamInputDataSource {
    consumerGroupName?: string;
    endpoint?: string;
    iotHubNamespace?: string;
    sharedAccessPolicyKey?: string;
    sharedAccessPolicyName?: string;
    type: "Microsoft.Devices/IotHubs";
}

Hierarchy (view full)

Properties

consumerGroupName? endpoint? iotHubNamespace? sharedAccessPolicyKey? sharedAccessPolicyName? type

Properties

Optional consumerGroupName

consumerGroupName?: string

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.

Optional endpoint

endpoint?: string

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

Optional iotHubNamespace

iotHubNamespace?: string

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

Optional sharedAccessPolicyKey

sharedAccessPolicyKey?: string

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

Optional sharedAccessPolicyName

sharedAccessPolicyName?: string

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

type: "Microsoft.Devices/IotHubs"

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

Settings

Member Visibility

Theme

Generated using TypeDoc