A C# SDK for connecting devices to Microsoft Azure IoT services
Permalink
Failed to load latest commit information.
.github Moving test projects to netcoreapp2.1 Jul 15, 2018
common Limit unsafe code to NET451 (#654) Oct 9, 2018
doc Removing ENABLE_MODULES_SDK compilation flag. Jun 19, 2018
e2e Mqtt changes (#660) Oct 9, 2018
iothub Update AmqpTransportHandler.cs (#666) Oct 15, 2018
jenkins Restart the TPM simulator several times during Jenkins. Aug 24, 2018
provisioning Increasing versions. (#662) Oct 9, 2018
security/tpm Increasing versions. (#662) Oct 9, 2018
shared/src Moving test projects to netcoreapp2.1 Jul 15, 2018
tools Fix accessibility issues for Data tab and Create Device form (#671) Oct 15, 2018
vsts Increasing versions. (#662) Oct 9, 2018
.gitattributes add .git* files Nov 16, 2016
.gitignore Updating nuspec files. Dec 22, 2017
35MSSharedLib1024.snk Update .NetStandard projects to build with Delay_Sign config for code… Apr 19, 2017
CODE_OF_CONDUCT.md Adding common test configuration. Nov 8, 2017
CONTRIBUTING.md Update CONTRIBUTING.md Feb 22, 2017
LICENSE Import docs and git files Nov 16, 2016
azureiot.sln Build the SLN instead of individual csproj files. Aug 22, 2018
build.cmd The build will no longer be corrupted by a user's powershell profile. Mar 9, 2018
build.ps1 Mqtt changes (#660) Oct 9, 2018
build.sh The linux build will not load the user's profile while running. Mar 12, 2018
lts_branches.png Updating LTS branch information. Feb 8, 2018
readme.md Update readme.md (#644) Sep 29, 2018
thirdpartynotice.txt Hsm Authentication with Http over Unix domain sockets May 21, 2018
versions.csv Increasing versions. (#662) Oct 9, 2018
versionupdate.ps1 Use Version instead of VersionPrefix in csproj files Mar 27, 2018

readme.md

Microsoft Azure IoT SDK for .NET

This repository contains the following:

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

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.

Samples

Samples are available at Azure IoT Samples for C#

Contribute to the Azure IoT C# SDK

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

Build status

Due to security considerations, build logs are not publicly available.

Service Environment Status
WestUS Build Status
Canary Build Status
Dogfood Build Status

OS platforms and hardware compatibility

The IoT Hub device SDK for .NET can be used with a broad range of OS platforms and devices.

The NuGet packages provide support for the following .NET flavors:

  • .NET Standard 2.0
  • .NET Standard 1.3 (IoT Hub SDKs only)
  • .NET Framework 4.5.1 (IoT Hub SDKs only)
  • .NET MicroFramework (IoT Hub SDKs only)

For details on .NET support see the .NET Standard documentation. For details on OS support see the following resources:

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 https Description
Authentication ✔️ ✔️* ✔️ ✔️* ✔️* Connect your device to IoT Hub securely with supported authentication, including private key, SASToken, X-509 Self Signed and X-509 CA Signed. *IoT Hub only supports X-509 CA Signed over AMQP and MQTT at the moment. X509-CA authentication over websocket and HTTPS are not supported.
Send device-to-cloud message ✔️* ✔️* ✔️ ✔️ ✔️ Send device-to-cloud messages (max 256KB) to IoT Hub with the option to add custom properties and system properties, and batch send. *IoT Hub only supports batch send over AMQP and HTTPS at the moment.
Receive cloud-to-device messages ✔️* ✔️* ✔️ ✔️ ✔️ Receive cloud-to-device messages and read associated custom and system properties from IoT Hub, with the option to complete/reject/abandon C2D messages. *IoT Hub supports the option to complete/reject/abandon C2D messages over HTTPS and AMQP only 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. *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 amd generic operation.
Upload file to Blob ✔️ A device can initiate a file upload and notifies IoT Hub when the upload is complete. 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 Hub Service SDK

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

Features C# .Net Description
Identity registry (CRUD) ✔️* Use your backend app to perform CRUD operation for individual device or in bulk.
Cloud-to-device messaging ✔️ Use your backend app to send cloud-to-device messages in AMQP and AMQP-WS, and set up cloud-to-device message receivers.
Direct Methods operations ✔️ Use your backend app to invoke direct method on device.
Device Twins operations ✖️ Use your backend app to perform twin operations. This SDK only supports Get Twin at the moment.
Query ✔️ Use your backend app to perform query for information.
Jobs ✔️ Use your backend app to perform job operation.
File Upload ✔️ Set up your backend app to send file upload notification receiver.

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 https 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

Long Term Support

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

A new LTS version will be created every 6 months. The lifetime of an LTS branch is currently planned for one year. LTS branches receive all bug fixes that fall in one of these categories:

  • security bugfixes
  • critical bugfixes (crashes, memory leaks, etc.)

No new features or improvements will be picked up in an LTS branch.

LTS branches are named lts_yyyy_mm, where mm and yyyy are the month and year when the branch was created. An example of such a branch is lts_2018_01.

Schedule1

Below is a table showing the mapping of the LTS branches to the packages released

Release Github Branch LTS Status LTS Start Date Maintenance End Date Removed Date
2018-1-23 lts_2018_01 Active 2018-01-23 2018-06-30 2018-12-31
2017-10-6 lts_07_2017 Deprecated 2017-07-01 2018-12-31 2018-06-30
  • 1 All scheduled dates are subject to change by the Azure IoT SDK team.

Planned Release Schedule


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