IotHubClientOptions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Options that allow configuration of the IoT hub device or module client instance during initialization.
public sealed class IotHubClientOptions
type IotHubClientOptions = class
Public NotInheritable Class IotHubClientOptions
- Inheritance
-
IotHubClientOptions
Constructors
IotHubClientOptions() |
Creates an instances of this class with the default transport settings. |
IotHubClientOptions(IotHubClientTransportSettings) |
Creates an instance of this class with the specified transport settings. |
Properties
AdditionalUserAgentInfo |
Specifies additional information that will be appended to the user-agent string that is sent to IoT hub. |
FileUploadTransportSettings |
The transport settings to use for all file upload operations, regardless of what protocol the device client is configured with. All file upload operations take place over https. |
GatewayHostName |
The fully-qualified DNS host name of a gateway to connect through. |
ModelId |
The DTDL model Id associated with the device or module client instance. |
PayloadConvention |
The payload convention to be used to serialize and encode the payload being sent to service. |
RetryPolicy |
Sets the retry policy used in the operation retries. |
SdkAssignsMessageId |
The configuration for setting MessageId for every message sent by the device or module client instance. |
TransportSettings |
The transport settings to use (i.e., IotHubClientMqttSettings or IotHubClientAmqpSettings). |