Microsoft.Azure.Devices.Client Namespace
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.
Classes
| AmqpConnectionPoolSettings |
Contains AMQP connection pool settings for device client. |
| AmqpTransportSettings |
Contains Amqp transport-specific settings for the device and module clients. |
| AuthenticationMethodFactory |
Creates an instance of an implementation of IAuthenticationMethod based on known authentication parameters. |
| AuthenticationWithTokenRefresh |
Authentication method that uses a shared access signature token and allows for token refresh. |
| ClientAuthenticationWithSharedAccessKeyRefresh |
Authentication method that generates shared access signature (SAS) token with refresh, based on a provided shared access key (SAK). |
| ClientAuthenticationWithSharedAccessSignature |
Authentication method that uses a shared access signature token. |
| ClientAuthenticationWithTokenRefresh |
Authentication method that uses a shared access signature token and allows for token refresh. |
| ClientAuthenticationWithX509Certificate |
Authentication method that uses an X.509 certificate |
| ClientOptions |
Options that allow configuration of the device or module client instance during initialization. |
| ConnectionStatusInfo |
The connection status information since the last status change. |
| DefaultPayloadConvention |
The default implementation of the PayloadConvention class. |
| DesiredProperties |
The collection of desired property update requests received from service. |
| DeviceAuthenticationWithRegistrySymmetricKey |
Authentication method that uses the symmetric key associated with the device in the device registry. |
| DeviceAuthenticationWithSharedAccessPolicyKey |
Authentication method that uses a shared access policy key. |
| DeviceAuthenticationWithToken |
Authentication method that uses a shared access signature token. |
| DeviceAuthenticationWithTokenRefresh |
Authentication method that uses a shared access signature token and allows for token refresh. |
| DeviceAuthenticationWithTpm |
Authentication method that uses a shared access signature token and allows for token refresh. |
| DeviceAuthenticationWithX509Certificate |
Authentication method that uses a X.509 certificate |
| DeviceClient |
Contains methods that a device can use to send messages to and receive from the service. |
| DirectMethodRequest |
Parameters to execute a direct method on a device or module. |
| DirectMethodResponse |
The device/module's response to a direct method invocation. |
| ExponentialBackoff |
Represents a retry policy that performs a specified number of retries, using a randomized exponential back off scheme to determine the interval between retries. |
| FileUploadCompletionNotification |
The request payload to send to IoT hub to notify it when a file upload is completed, whether successful or not. |
| FileUploadSasUriRequest |
The request parameters when getting a file upload SAS URI from IoT hub. |
| FileUploadSasUriResponse |
The information provided from IoT hub that can be used with the Azure Storage SDK to upload a file from this client application. |
| Http1TransportSettings |
Contains HTTP transport-specific settings for the device and module clients. |
| IncomingMessage |
The data structure that represents the message that is received from Iot hub. |
| IotHubBaseClient |
Contains methods that a client can use to send messages to and receive messages from the service, respond to direct method invocations from the service, and send and receive twin property updates. |
| IotHubClientAmqpSettings |
Contains AMQP transport-specific settings for the device and module clients. |
| IotHubClientException |
The exception that is thrown when an error occurs during DeviceClient or ModuleClient operation. |
| IotHubClientExponentialBackoffRetryPolicy |
Represents a retry policy that performs a specified number of retries, using a exponential back-off scheme, with option jitter, to determine the interval between retries. |
| IotHubClientFixedDelayRetryPolicy |
Represents a retry policy that performs a specified number of retries, using a fixed retry delay with jitter. |
| IotHubClientHttpSettings |
Contains HTTP transport-specific settings for the device and module clients. |
| IotHubClientIncrementalDelayRetryPolicy |
Represents a retry policy that performs a specified number of retries, using an incrementally increasing retry delay with jitter. |
| IotHubClientMqttSettings |
Contains MQTT transport-specific settings for the device and module clients. |
| IotHubClientNoRetry |
Represents a retry policy that performs no retries. |
| IotHubClientOptions |
Options that allow configuration of the IoT hub device or module client instance during initialization. |
| IotHubClientRetryPolicyBase |
A base retry policy. |
| IotHubClientTransportSettings |
Base class used to define various transport-specific settings for IoT hub device and module clients. |
| IotHubConnectionCredentials |
Holder for client credentials that will be used for authenticating the client with IoT hub service. |
| IotHubConnectionStringBuilder |
Builds a connection string for the IoT hub service based on the properties populated by the user. |
| IotHubDeviceClient |
Contains methods that a device can use to send messages to and receive from the service. |
| IotHubModuleClient |
Contains methods that a module can use to send messages to and receive from the service and interact with module twins. |
| Message |
The data structure represent the message that is used for interacting with IotHub. |
| MethodRequest |
The data structure that represents a method request. |
| MethodRequestInternal |
The data structure represent the method request coming from the IoT hub. |
| MethodResponse |
The data structure represent the Device Twin Method that is used for triggering an activity on the device. |
| MethodResponseInternal |
The data structure represent the method response that is used for interacting with IoT hub. |
| ModuleAuthenticationWithRegistrySymmetricKey |
Authentication method that uses the symmetric key associated with the module in the device registry. |
| ModuleAuthenticationWithToken |
Authentication method that uses a shared access signature token. |
| ModuleAuthenticationWithTokenRefresh |
Authentication method that uses a shared access signature token and allows for token refresh. |
| ModuleClient |
Contains methods that a module can use to send messages to and receive from the service and interact with module twins. |
| NewtonsoftJsonPayloadSerializer |
A Newtonsoft.Json.JsonConvert PayloadSerializer implementation. |
| NoRetry |
Represents a retry policy that performs no retries. |
| PayloadConvention |
The payload convention class. It is used to define a specific serializer as well as a specific content encoding. |
| PayloadEncoder |
Specifies the byte encoding for the payload. |
| PayloadSerializer |
Provides the serialization for a specified convention. |
| PropertyCollection |
The collection of twin properties. |
| ReadOnlyDictionary45<TKey,TValue>.KeyCollection |
A collection of dictionary keys |
| ReadOnlyDictionary45<TKey,TValue>.ValueCollection |
A collection of dictionary values |
| ReadOnlyDictionary45<TKey,TValue> |
Read-only wrapper for another generic dictionary. |
| ReportedProperties |
The collection of twin properties reported by the client. |
| Resources | |
| SharedAccessSignatureBuilder |
Builds Shared Access Signature (SAS) tokens. |
| StringFormattingExtensions |
String extension class for common operations. This class is used by the SDK and should not be directly used by applications. |
| SystemTextJsonPayloadConvention |
A PayloadConvention that uses SystemTextJsonPayloadSerializer. |
| SystemTextJsonPayloadSerializer |
A System.Text.JsonPayloadSerializer implementation. |
| TelemetryMessage |
The data structure that represents the message that will be sent to IoT hub. |
| TwinProperties |
A container for client properties retrieved from the service. |
| Utf8PayloadEncoder |
A UTF-8 PayloadEncoder implementation. |
| WillMessage |
An MQTT "will" message to be sent by this client before the client disconnects. |
Interfaces
| IAuthenticationMethod |
Authentication interface to use for device communications. |
| IETagHolder | |
| IIotHubClientRetryPolicy |
Represents a retry policy for the hub device/module client. |
| IReadOnlyIndicator |
Indicates if a class is read-only |
| IRetryPolicy |
Represents a retry policy |
| ITransportSettings |
Interface used to define various transport-specific settings for DeviceClient and ModuleClient. |
| IWillMessage |
An MQTT "will" message to be sent by this client before the client disconnects. |
Enums
| AuthenticationModel |
The authentication model for the device; i.e. X.509 certificates, individual client scoped SAS tokens or IoT hub level scoped SAS tokens. |
| ConnectionStatus |
The connection status from a connection change event. |
| ConnectionStatusChangeReason |
The reason for a connection status change from a connection change event. |
| DeliveryAcknowledgement |
Specifies the different acknowledgement levels for message delivery. |
| IotHubClientErrorCode |
The IoT hub device/module client error code. |
| IotHubClientTransportProtocol |
The protocol over which a transport (i.e., MQTT, AMQP) communicates. |
| MessageAcknowledgement |
The options for acknowledging a cloud-to-device (C2D) message. |
| MessageResponse |
Status of handling a message. |
| MethodResponseStatusCode |
Status code for method response. |
| QualityOfService |
The policy for which a particular message will be sent over MQTT. |
| RecommendedAction |
The recommended action for device applications to take in response to a connection change event. |
| RetryPolicyType |
Retry Strategy types supported by DeviceClient |
| SdkAssignsMessageId |
The different configurations available for setting a value of MessageId on an IoT hub message. |
| TraceEventType | |
| TransportType |
Transport types supported by the device and module clients - AMQP/TCP, HTTP 1.1, MQTT/TCP, AMQP/WS, MQTT/WS |
Delegates
| ConnectionStatusChangesHandler |
Delegate for connection status changed. |
| DesiredPropertyUpdateCallback |
Delegate for desired property update callbacks. This will be called every time we receive a patch from the service. |
| MessageHandler |
Delegate that gets called when a message is received on a ModuleClient. |
| MethodCallback |
Delegate for method call. This will be called every time we receive a method call that was registered. |
| ReceiveMessageCallback |
Delegate that gets called when a message is received on a DeviceClient. |
