Skip to content

Commit

Permalink
doc(service-client): Update readme about the differnt client and oper…
Browse files Browse the repository at this point in the history 
…ations
  • Loading branch information
@vinagesh
vinagesh committed Feb 19, 2021
1 parent d55a884 commit d2d90e0
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 11 deletions.
1 change: 1 addition & 0 deletions iothub/service/src/DigitalTwin/DigitalTwinClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ namespace Microsoft.Azure.Devices
{
/// <summary>
/// The Digital Twins Service Client contains methods to retrieve and update digital twin information, and invoke commands on a digital twin device.
/// For more information, see <see href="https://github.com/Azure/azure-iot-sdk-csharp/tree/previews/RBAC#iot-hub-service-sdk"/>
/// </summary>
public class DigitalTwinClient : IDisposable
{
Expand Down
1 change: 1 addition & 0 deletions iothub/service/src/JobClient/JobClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ public abstract class JobClient : IDisposable
{
/// <summary>
/// Creates a JobClient from the Iot Hub connection string.
/// For more information, see <see href="https://github.com/Azure/azure-iot-sdk-csharp/tree/previews/RBAC#iot-hub-service-sdk"/>
/// </summary>
/// <param name="connectionString"> The Iot Hub connection string.</param>
/// <returns> A JobClient instance. </returns>
Expand Down
1 change: 1 addition & 0 deletions iothub/service/src/RegistryManager.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ namespace Microsoft.Azure.Devices
{
/// <summary>
/// Contains methods that services can use to perform create, remove, update and delete operations on devices.
/// For more information, see <see href="https://github.com/Azure/azure-iot-sdk-csharp/tree/previews/RBAC#iot-hub-service-sdk"/>
/// </summary>
[System.Diagnostics.CodeAnalysis.SuppressMessage(
"Naming",
Expand Down
1 change: 1 addition & 0 deletions iothub/service/src/ServiceClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ public enum TransportType

/// <summary>
/// Contains methods that services can use to send messages to devices
/// For more information, see <see href="https://github.com/Azure/azure-iot-sdk-csharp/tree/previews/RBAC#iot-hub-service-sdk"/>
/// </summary>
public abstract class ServiceClient : IDisposable
{
Expand Down
22 changes: 11 additions & 11 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,17 +103,17 @@ For details on OS support see the following resources:

:heavy_check_mark: feature available :heavy_multiplication_x: feature planned but not supported :heavy_minus_sign: no support planned

| Features | Support | Transport protocol used underneath | Description |
|---------------------------------------------------------------------------------------------------------------|--------------------- |-------------------------|--------------------------------------------------------------------------------------------------------------------------|
| [Identity registry (CRUD)](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry) | :heavy_check_mark: | HTTP | Use your backend app to perform CRUD operation for individual device or in bulk. |
| [Cloud-to-device messaging](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-c2d) | :heavy_check_mark: | AMQP | 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](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-direct-methods) | :heavy_check_mark: | HTTP | Use your backend app to invoke direct method on device. |
| [Device Twins operations](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-device-twins) | :heavy_check_mark: | HTTP | Use your backend app to perform twin operations. |
| [Query](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language) | :heavy_check_mark: | HTTP | Use your backend app to perform query for information. |
| [Jobs](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs) | :heavy_check_mark: | HTTP | Use your backend app to perform job operation. |
| [File Upload](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-file-upload) | :heavy_check_mark: | AMQP | Set up your backend app to receive file upload notifications.
| [Digital Twin Client](https://docs.microsoft.com/en-us/azure/iot-pnp/overview-iot-plug-and-play) | :heavy_check_mark: | HTTP | Set up your backend app to perform operations on plug and play devices. |
| [IoT Hub Statistics](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-metrics) | :heavy_check_mark: | HTTP | Get IoT Hub identity registry statistics; such as total device count for device statistics, and connected device count for service statistics. |
| Features | Support | Transport protocol used underneath | Client to use | Description |
|---------------------------------------------------------------------------------------------------------------|--------------------- |-------------------------| -------|--------------------------------------------------------------------------------------------------------------------------|
| [Identity registry (CRUD)](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry) | :heavy_check_mark: | HTTP | RegistryManager | Use your backend app to perform CRUD operation for individual device or in bulk. ||
| [Query](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language) | :heavy_check_mark: | HTTP | RegistryManager | Use your backend app to query for information on device twins, module twins, jobs and message routing. |
| [Import/Export jobs](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs) | :heavy_check_mark: | HTTP | RegistryManager | Use your backend app to import or export device identities in bulk. |
| [Scheduled jobs](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs) | :heavy_check_mark: | HTTP | JobsClient | Use your backend app to schedule jobs to update desired properties, update tags and invoke direct methods.
| [Cloud-to-device messaging](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-c2d) | :heavy_check_mark: | 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](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-direct-methods) | :heavy_check_mark: | HTTP | ServiceClient | Use your backend app to invoke direct method on device. |
| [File Upload Notifications](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-file-upload) | :heavy_check_mark: | AMQP | ServiceClient | Use your backend app to receive file upload notifications.
| [IoT Hub Statistics](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-metrics) | :heavy_check_mark: | 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](https://docs.microsoft.com/en-us/azure/iot-pnp/overview-iot-plug-and-play) | :heavy_check_mark: | 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. |

### Provisioning Device SDK

Expand Down

0 comments on commit d2d90e0

Please sign in to comment.