Microsoft.Azure.Devices.Client 2.0.0-preview007

The ID prefix of this package has been reserved for one of the owners of this package by Prefix Reserved
.NET Standard 2.0
This is a prerelease version of Microsoft.Azure.Devices.Client.
dotnet add package Microsoft.Azure.Devices.Client --version 2.0.0-preview007
NuGet\Install-Package Microsoft.Azure.Devices.Client -Version 2.0.0-preview007
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.Azure.Devices.Client" Version="2.0.0-preview007" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Azure.Devices.Client --version 2.0.0-preview007
#r "nuget: Microsoft.Azure.Devices.Client, 2.0.0-preview007"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Microsoft.Azure.Devices.Client as a Cake Addin
#addin nuget:?package=Microsoft.Azure.Devices.Client&version=2.0.0-preview007&prerelease

// Install Microsoft.Azure.Devices.Client as a Cake Tool
#tool nuget:?package=Microsoft.Azure.Devices.Client&version=2.0.0-preview007&prerelease

Microsoft Azure IoT SDK for .NET

V2 clients release notice

The 2.0.0-preview001 release has been published for each package in this library. These packages simplify usage and handling of our clients, and we highly encourage you to try out these packages and share your feedback. Once we promote these changes to main in the future and release the 2.x.x packages publicly, all future features will be brought only to this new major version.

If you need any help migrating your code to try out the new 2.X.X clients, please see this migration guide.


This repository contains the following:

  • Microsoft Azure IoT Hub device SDK for .NET to connect client devices to Azure IoT Hub with .NET.
  • Microsoft Azure IoT Hub service SDK for .NET to manage your IoT Hub service instance from a back-end .NET application.
  • Microsoft Azure Provisioning device SDK for .NET to provision devices to Azure IoT Hub with .NET.
  • Microsoft Azure Provisioning service SDK for .NET to manage your Provisioning service instance from a back-end .NET application.

Critical Upcoming Change Notice

All Azure IoT SDK users are advised to be aware of upcoming TLS certificate changes for Azure IoT Hub and Device Provisioning Service that will impact the SDK's ability to connect to these services. In October 2022, both services will migrate from the current Baltimore CyberTrust CA Root to the DigiCert Global G2 CA root. There will be a transition period beforehand where your IoT devices must have both the Baltimore and Digicert public certificates installed in their certificate store in order to prevent connectivity issues.

Devices with only the Baltimore public certificate installed will lose the ability to connect to Azure IoT hub and Device Provisioning Service in October 2022.

To prepare for this change, make sure your device's certificate store has both of these public certificates installed.

For a more in depth explanation as to why the IoT services are doing this, please see this article.

Package Name Release Version
Microsoft.Azure.Devices.Client NuGet
Microsoft.Azure.Devices NuGet
Microsoft.Azure.Devices.Provisioning.Client NuGet
Microsoft.Azure.Devices.Provisioning.Service NuGet


  1. In addition to stable builds we also release pre-release builds that contain preview features. You can find details about the preview features released by looking at the release notes. It is not recommended to take dependency on preview NuGets for production applications as breaking changes can be introduced in preview packages.

  2. Device streaming feature is not being included in our newer preview releases as there is no active development going on in the service. For more details on the feature, see here.

    This feature has not been included in any preview release after 2020-10-14. However, the feature is still available under previews/deviceStreaming branch.

    The latest preview NuGet versions that contain the device streaming feature are:
    Microsoft.Azure.Devices.Client - 1.32.0-preview-001
    Microsoft.Azure.Devices - 1.28.0-preview-001

  3. Stable and preview NuGet versions are not interdependent; eg. for NuGet packages versioned 1.25.0 (stable release) and 1.25.0-preview-001 (preview release), there is no guarantee that v1.25.0 contains the feature(s) previewed in v1.25.0-preview-001. For a list of updates shipped with each NuGet package, please refer to the release notes.

The API reference documentation for .NET SDK is here.

To find SDKs in other languages for Azure IoT, please refer to the azure-iot-sdks repository. For IoT Hub Management SDK in .NET, please visit azure-sdk-for-net repository.

Need support?

  • Have a feature request for SDKs? Please post it on User Voice to help us prioritize.
  • Have a technical question? Ask on Stack Overflow with tag “azure-iot-hub”.
  • Need Support? Every customer with an active Azure subscription has access to support with guaranteed response time. Consider submitting a ticket and get assistance from Microsoft support team.
  • Found a bug? Please help us fix it by thoroughly documenting it and filing an issue on GitHub (C, Java, .NET, Node.js, Python).

Developing applications for Azure IoT

Visit Azure IoT Dev Center to learn more about developing applications for Azure IoT.


All of our samples are located in this repository. The samples live alongside the source for each client library.

Samples for each of these categories are further separated into three sub-categories (from simplest to complex):

  1. Getting Started
  2. How To
  3. Solutions

If you are looking for a good device sample to get started with, please see the device reconnection sample. It shows how to connect a device, handle disconnect events, cases to handle when making calls, and when to re-initialize the DeviceClient.

Contribute to the Azure IoT .NET SDK

If you would like to build or change the SDK source code, please follow the devguide.

OS platforms and hardware compatibility

For an official list of all the operating systems and .NET platforms that we support, please see this document.

Note that you can configure your TLS protocol version and ciphers by following this document.

Key features and roadmap

IoT Hub Device SDK

✔️ feature available ✖️ feature planned but not supported ➖ no support planned

Features mqtt mqtt-ws amqp amqp-ws Description
Authentication ✔️ ✔️* ✔️ ✔️* Connect your device to IoT Hub securely with supported authentication methods, including private key, shared access signature (SAS) token, X.509 self-signed, and X.509 certificate authority (CA) signed. </br> *IoT Hub only supports X.509 CA signed over AMQP and MQTT at the moment. X.509 CA authentication over web socket and HTTPS are not supported. When authenticating a device using shared access key (SAK) over MQTT, new connection will be setup as part of the SAS token refresh process; device communication will be briefly closed during refresh (for details, see device connection and messaging reliability documentation). X.509 certificate-based authentication process does not have the same refresh disruption. Also, X.509 certificate-based authentication is more secure than share access key authentication.
Send device-to-cloud message ✔️* ✔️* ✔️ ✔️ Send device-to-cloud messages (max 256KB) to IoT Hub with the option to add application properties and system properties, and batch send. </br> *IoT Hub only supports batch send over AMQP at the moment.
Receive cloud-to-device messages ✔️* ✔️* ✔️ ✔️ Receive cloud-to-device messages and read associated application and system properties from IoT Hub, with the option to complete/reject/abandon C2D messages. </br> *IoT Hub does not support the option to reject/abandon C2D messages over MQTT at the moment.
Device Twins ✔️* ✔️* ✔️* ✔️* IoT Hub persists a device twin for each device that you connect to IoT Hub. The device can perform operations like get twin tags, subscribe to desired properties. </br> *Send reported properties version and desired properties version are in progress.
Direct Methods ✔️ ✔️ ✔️ ✔️ IoT Hub gives you the ability to invoke direct methods on devices from the cloud. The SDK supports handler for method specific and generic operation.
Upload file to Blob The user can use the device client to retrieve a SAS URI from IoT Hub (to use for file uploads), upload to Azure Storage blob using IoT Hub provided credentials (using a supported client library), and then use the device client to notify IoT Hub that a file upload has completed. File upload requires HTTPS connection, but can be initiated from client using any protocol for other operations.
Connection Status and Error reporting ✔️ ✔️ ✔️ ✔️ Error reporting for IoT Hub supported error code.
Retry policies ✔️ ✔️ ✔️ ✔️ Retry policy for unsuccessful device-to-cloud messages have three options: no try, exponential backoff with jitter (default) and custom.
Devices multiplexing over single connection ✔️ ✔️
Connection Pooling - Specifying number of connections ✔️ ✔️
IoT Plug and Play ✔️ ✔️ ✔️* ✔️* IoT Plug and Play lets you build smart devices that advertise their capabilities to Azure IoT applications. IoT Plug and Play devices don't require manual configuration when a customer connects them to IoT Plug and Play-enabled applications. You can read more here. </br> *Note: AMQP support is mainly targeted for Edge-based scenarios.

IoT Hub Service SDK

✔️ feature available ✖️ feature planned but not supported ➖ no support planned

Features Support Transport protocol used underneath Client to use Description
Identity registry (CRUD) ✔️ HTTP RegistryManager Use your backend app to perform CRUD operation for individual device or in bulk.
Query ✔️ HTTP RegistryManager Use your backend app to query for information on device twins, module twins, jobs and message routing.
Import/Export jobs ✔️ HTTP RegistryManager Use your backend app to import or export device identities in bulk.
Scheduled jobs ✔️ HTTP JobsClient Use your backend app to schedule jobs to update desired properties, update tags and invoke direct methods.
Cloud-to-device messaging ✔️ AMQP ServiceClient Use your backend app to send cloud-to-device messages in AMQP and AMQP-WS, and set up notifications for cloud-to-device message delivery.
Direct Methods operations ✔️ HTTP ServiceClient Use your backend app to invoke direct method on device.
File Upload Notifications ✔️ AMQP ServiceClient Use your backend app to receive file upload notifications.
IoT Hub Statistics ✔️ HTTP ServiceClient Use your backend app to get IoT hub identity registry statistics such as total device count for device statistics, and connected device count for service statistics.
Digital Twin Operations ✔️ HTTP DigitalTwinClient or RegistryManager Use your backend app to perform operations on plug and play devices. The operations include get twins, update twins and invoke commands. DigitalTwinClient is the preferred client to use.

Provisioning Device SDK

This repository contains provisioning device client SDK for the Device Provisioning Service.

✔️ feature available ✖️ feature planned but not supported ➖ no support planned

Features mqtt mqtt-ws amqp amqp-ws Description
TPM Individual Enrollment ✔️ ✔️ This SDK supports connecting your device to the Device Provisioning Service via individual enrollment using Trusted Platform Module. Please review the samples folder and this quickstart on how to create a device client. TPM over MQTT is currently not supported by the Device Provisioning Service.
X.509 Individual Enrollment ✔️ ✔️* ✔️ ✔️* This SDK supports connecting your device to the Device Provisioning Service via individual enrollment using X.509 root certificate. Please review the samples and this quickstart folder on how to create a device client.
X.509 Enrollment Group ✔️ ✔️* ✔️ ✔️* This SDK supports connecting your device to the Device Provisioning Service via individual enrollment using X.509 leaf certificate. Please review the samples folder on how to create a device client.

Note * WebSocket support for MQTT/AMQP is limited to .NET Framework 4.x.

Provisioniong Service SDK

This repository contains provisioning service client SDK for the Device Provisioning Service to programmatically enroll devices.

Feature Support Description
CRUD Operation with TPM Individual Enrollment ✔️ Programmatically manage device enrollment using TPM with the service SDK. Please visit the samples folder to learn more about this feature.
Bulk CRUD Operation with TPM Individual Enrollment ✔️ Programmatically bulk manage device enrollment using TPM with the service SDK. Please visit the samples folder to learn more about this feature.
CRUD Operation with X.509 Individual Enrollment ✔️ Programmatically manage device enrollment using X.509 individual enrollment with the service SDK. Please visit the samples folder to learn more about this feature.
CRUD Operation with X.509 Group Enrollment ✔️ Programmatically manage device enrollment using X.509 group enrollment with the service SDK. Please visit the samples folder to learn more about this feature.
Query enrollments ✔️ Programmatically query registration states with the service SDK. Please visit the samples folder to learn more about this feature.

Read more

Device Explorer is no longer supported. A replacement tool can be found here.

Certificates - Important to know

The Azure IoT Hub certificates presented during TLS negotiation shall be always validated using the appropriate root CA certificate(s).

Always prefer using the local system's Trusted Root Certificate Authority store instead of hardcoding the certificates.

A couple of examples:

Additional Information

For additional guidance and important information about certificates, please refer to this blog post from the security team.

Long-Term Support (LTS)

The project offers a Long-Term Support (LTS) releases to allow users that do not need the latest features to be shielded from unwanted changes.

LTS repo tags are to be named lts_yyyy-mm-dd, where yyyy, mm, and dd are the year, month, and day when the tag was created. An example of such a tag is lts_2021-03-18.

The lifetime of an LTS release is 12 months. During this time, LTS releases may receive maintenance bug fixes that fall in these categories:

  • security bug fixes
  • critical bug fixes (e.g., unavoidable/unrecoverable crashes, significant memory leaks)

No new features or improvements are in scope to be picked up in an LTS branch. A patch will not extend the maintenance or expiry date.

LTS releases may include additional extended support for security bug fixes as listed in the LTS schedule.


This table shows previous LTS releases and end dates.

Release LTS Start Date Maintenance End Date
2022-06-07 <sub>patch 6 of 2021-03-18</sub> 2021-03-18 current

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments.

Microsoft collects performance and usage information which may be used to provide and improve Microsoft products and services and enhance your experience. To learn more, review the privacy statement.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (58)

Showing the top 5 NuGet packages that depend on Microsoft.Azure.Devices.Client:

Package Downloads

This library Chia contains utils for internal Danpower Reporting and is used by serveral reports.

RaaLabs.Edge.Modules.EdgeHub The ID prefix of this package has been reserved for one of the owners of this package by

Package Description


Communication module, that allows to send and receive messages from Azure Service Bus queues or Azure IoT Hub


Library to simplify the interaction with a cube and increase testability


Common libraries

GitHub repositories (17)

Showing the top 5 popular GitHub repositories that depend on Microsoft.Azure.Devices.Client:

Repository Stars
This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at or our versioned developer docs at
Sample code referenced by the .NET documentation
This repo includes .NET Core implementations for various IoT boards, chips, displays and PCBs.
The IoT Edge OSS project
A C# SDK for connecting devices to Microsoft Azure IoT services
Version Downloads Last updated
2.0.0-preview007 2,694 8/17/2023
2.0.0-preview006 447 8/7/2023
2.0.0-preview005 3,525 4/28/2023
2.0.0-preview004 1,065 3/13/2023
2.0.0-preview003 865 2/27/2023
2.0.0-preview002 1,605 11/4/2022
2.0.0-preview001 469 10/15/2022
1.42.0 292,535 5/2/2023
1.41.3 643,522 11/17/2022
1.41.2 305,055 8/12/2022
1.41.1 50,430 8/2/2022
1.41.0 282,943 5/12/2022
1.41.0-preview-001 2,664 2/19/2022
1.40.0 354,935 1/28/2022
1.39.0 264,870 11/2/2021
1.38.1-preview-001 993 10/19/2021
1.38.0 204,375 8/11/2021
1.38.0-preview-001 2,370 6/9/2021
1.37.2 400,634 5/14/2021
1.37.1 65,209 5/6/2021
1.37.0 54,699 4/27/2021
1.36.8 4,688 3/28/2023
1.36.7 1,091 1/24/2023
1.36.6 17,379 6/7/2022
1.36.5 724 5/11/2022
1.36.4 8,346 1/19/2022
1.36.3 29,029 10/20/2021
1.36.2 3,808 8/12/2021
1.36.1 14,032 6/23/2021
1.36.0 131,426 3/24/2021
1.35.0 258,986 2/8/2021
1.34.0 81,665 1/22/2021
1.33.1 323,195 11/6/2020
1.33.0 11,001 11/3/2020
1.32.0 100,067 10/16/2020
1.32.0-preview-001 30,151 10/14/2020
1.31.2 21,631 10/9/2020
1.31.1 23,139 10/2/2020
1.31.0 12,849 10/1/2020
1.30.0 48,894 9/17/2020
1.29.1-preview-003 654 9/22/2020
1.29.1-preview-002 2,455 7/15/2020
1.29.1-preview-001 3,851 7/13/2020
1.29.0-preview-004 80,417 11/21/2019
1.29.0-preview-002 23,030 3/13/2019
1.29.0-preview-001 5,429 1/22/2019
1.28.2 9,359 8/10/2021
1.28.1 1,494 9/24/2020
1.28.0 115,738 8/19/2020
1.27.0 253,122 7/9/2020
1.26.0 132,713 6/11/2020
1.25.0 224,000 4/3/2020
1.24.0 67,061 3/13/2020
1.23.2 61,591 2/27/2020
1.23.1 66,317 2/19/2020
1.23.0 33,814 2/13/2020
1.22.0 44,110 2/1/2020
1.21.4 27,883 1/24/2020
1.21.3 108,165 12/18/2019
1.21.2 80,845 11/16/2019
1.21.1 163,256 9/12/2019
1.21.0 113,585 7/27/2019
1.20.3 96,978 7/2/2019
1.20.2 43,614 6/7/2019
1.20.1 89,001 5/3/2019
1.20.0 57,486 4/10/2019
1.19.0 256,145 1/5/2019
1.18.1 145,513 10/9/2018
1.18.0 201,333 8/18/2018
1.17.1 62,523 7/27/2018
1.17.0 137,834 6/21/2018
1.17.0-preview-007 3,394 5/7/2018
1.17.0-preview-006 1,661 5/1/2018
1.17.0-preview-005 1,387 4/26/2018
1.17.0-preview-004 2,778 3/29/2018
1.17.0-preview-003 1,326 3/28/2018
1.17.0-preview-001 4,196 2/9/2018
1.7.2 32,989 6/13/2018
1.7.1 49,908 4/5/2018
1.7.0 18,538 3/14/2018
1.6.4 1,471 10/9/2018
1.6.3 2,116 3/14/2018
1.6.2 37,118 1/26/2018
1.6.1 24,776 12/22/2017
1.6.0 49,200 12/4/2017
1.6.0-preview-001 19,491 11/14/2017
1.5.2 56,574 10/24/2017
1.5.1 11,951 10/9/2017
1.5.0 27,457 9/9/2017
1.4.2 9,279 8/26/2017
1.4.1 13,503 8/10/2017
1.4.0 4,112 8/3/2017
1.3.1 16,802 7/14/2017
1.3.0 12,423 6/30/2017
1.2.13 12,005 6/16/2017
1.2.12 7,102 6/2/2017
1.2.11 6,464 5/20/2017
1.2.10 61,967 5/5/2017
1.2.9 10,306 4/21/2017
1.2.8 29,358 4/13/2017
1.2.6 52,838 3/24/2017
1.2.5 14,043 3/10/2017
1.2.4 8,996 2/24/2017
1.2.3 8,008 2/11/2017
1.2.2 4,743 1/28/2017
1.2.1 11,415 1/12/2017
1.1.3 4,051 12/13/2016
1.1.2 3,001 12/8/2016
1.0.22 8,687 11/17/2016
1.0.21 7,144 10/20/2016
1.0.20 9,823 9/24/2016
1.0.19 6,815 9/10/2016
1.0.18 3,833 8/27/2016
1.0.17 3,142 8/15/2016
1.0.16 7,934 7/30/2016
1.0.13 13,623 6/20/2016
1.0.12 5,209 6/7/2016
1.0.11 4,840 5/26/2016
1.0.10 1,519 5/26/2016
1.0.9 3,384 5/25/2016
1.0.7 7,921 5/9/2016
1.0.6 4,844 4/25/2016
1.0.5 10,400 4/9/2016
1.0.4 3,018 3/28/2016
1.0.3 32,260 3/14/2016
1.0.2 8,685 2/16/2016
1.0.1 3,732 2/4/2016
1.0.0-preview-010 6,623 1/16/2016
1.0.0-preview-009 3,878 12/23/2015
1.0.0-preview-007 4,846 12/1/2015
1.0.0-preview-006 4,766 11/3/2015
1.0.0-preview-005 2,940 10/21/2015
1.0.0-preview-004 2,498 10/17/2015
1.0.0-preview-003-1 3,593 9/29/2015