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.
Contains classes and interfaces that support managing device clients.
Classes
AmqpConnectionPoolSettings |
contains Amqp Connection Pool settings for DeviceClient |
AmqpTransportSettings |
contains Amqp transport-specific settings for DeviceClient |
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. |
ClientOptions |
Options that allow configuration of the device or module client instance during initialization. |
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. |
DeviceStreamRequest | |
DeviceStreamResponse | |
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. |
Http1TransportSettings |
contains Http1 transport-specific settings for DeviceClient |
IotHubConnectionStringBuilder |
Builds a connection string for the IoT Hub service based on the properties populated by the user. |
Message |
The data structure represent the message that is used for interacting with IotHub. |
MethodRequest | |
MethodRequestInternal |
The data structure represent the method request coming from the IotHub. |
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 IotHub. |
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. |
NoRetry |
Represents a retry policy that performs no retries. |
ReadOnlyDictionary45<TKey,TValue>.KeyCollection | |
ReadOnlyDictionary45<TKey,TValue>.ValueCollection | |
ReadOnlyDictionary45<TKey,TValue> |
Read-only wrapper for another generic dictionary. |
Resources | |
SharedAccessSignatureBuilder |
Interfaces
IAuthenticationMethod |
Authentication interface to use for device communications. |
IETagHolder | |
IReadOnlyIndicator | |
IRetryPolicy |
Represents a retry policy |
ITransportSettings |
Interface used to define various transport-specific settings for DeviceClient |
Enums
ConnectionStatus |
Connection Status supported by DeviceClient |
ConnectionStatusChangeReason |
Connection status change reason supported by DeviceClient |
DeliveryAcknowledgement |
Specifies the different acknowledgement levels for message delivery. |
MessageResponse |
Status of handling a message. |
MethodResponseStatusCode |
Status code for Method Response |
RetryPolicyType |
Retry Strategy types supported by DeviceClient |
TraceEventType | |
TransportType |
Transport types supported by DeviceClient - 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 | |
ReceiveMessageCallback |
Delegate that gets called when a message is received on a DeviceClient. |