jochenkalmbach / azure-iot-sdk-csharp

A C# SDK for connecting devices to Microsoft Azure IoT services

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
Canary
Dogfood

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:

• .NET Core Runtime ID Catalog
• .NET MicroFramework
• .NET Framework System Requirements

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

• Azure IoT Hub documentation
• Set up IoT Hub describes how to configure your Azure IoT Hub service.
• Manage IoT Hub describes how to provision devices in your Azure IoT Hub service.
• Azure Certified for IoT device catalog
• Set up your development environment to prepare your development environment as well as how to run the samples on Linux, Windows or other platforms.
• API reference documentation for .NET
• Get Started with IoT Hub using .NET

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.

Schedule¹

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

• ¹ 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 [email protected] with any additional questions or comments.