Merge pull request #292660 from gsteve88/add-cert-device-management

Added certificate steps to device section

Author: prmerger-automator[bot]

articles/iot-hub/how-to-device-management.md

@@ -8,7 +8,7 @@ manager: lizross
 ms.service: azure-iot-hub
 ms.devlang: csharp
 ms.topic: how-to
-ms.date: 11/25/2024
+ms.date: 1/6/2025
 zone_pivot_groups: iot-hub-howto-c2d-1
 ---
 

includes/iot-hub-howto-device-management-dotnet.md

@@ -7,7 +7,7 @@ ms.author: kgremban
 ms.service: iot-hub
 ms.devlang: csharp
 ms.topic: include
-ms.date: 11/25/2024
+ms.date: 1/6/2025
 ms.custom: mqtt, devx-track-csharp, devx-track-dotnet
 ---
 
@@ -21,9 +21,7 @@ This article describes how to use the [Azure IoT SDK for .NET](https://github.co
 
 This section describes how to use device application code to create a direct method callback listener.
 
-[!INCLUDE [iot-authentication-device-connection-string.md](iot-authentication-device-connection-string.md)]
-
-### Required device NuGet package
+### Required device NuGet packages
 
 Device client applications written in C# require the **Microsoft.Azure.Devices.Client** NuGet package.
 
@@ -34,7 +32,16 @@ using Microsoft.Azure.Devices.Client;
 using Microsoft.Azure.Devices.Shared;
 ```
 
-### Connect to a device
+### Connect a device to IoT Hub
+
+A device app can authenticate with IoT Hub using the following methods:
+
+* Shared access key
+* X.509 certificate
+
+[!INCLUDE [iot-authentication-device-connection-string.md](iot-authentication-device-connection-string.md)]
+
+#### Authenticate using a shared access key
 
 The [DeviceClient](/dotnet/api/microsoft.azure.devices.client.deviceclient) class exposes all the methods required to interact with device messages from the device.
 
@@ -59,6 +66,10 @@ deviceClient = DeviceClient.CreateFromConnectionString(DeviceConnectionString,
    TransportType.Mqtt);
 ```
 
+#### Authenticate using an X.509 certificate
+
+[!INCLUDE [iot-hub-howto-auth-device-cert-dotnet](iot-hub-howto-auth-device-cert-dotnet.md)]
+
 ### Create a direct method callback listener
 
 Use [SetMethodHandlerAsync](/dotnet/api/microsoft.azure.devices.client.deviceclient.setmethodhandlerasync) to initialize a direct method callback listener. The listener is associated with a method name keyword, such as "reboot". The method name can be used in an IoT Hub or backend application to trigger the callback method on the device.

includes/iot-hub-howto-device-management-java.md

@@ -7,7 +7,7 @@ ms.author: kgremban
 ms.service: iot-hub
 ms.devlang: csharp
 ms.topic: include
-ms.date: 11/25/2024
+ms.date: 1/6/2025
 ms.custom: amqp, mqtt, devx-track-java, devx-track-extended-java
 ---
 
@@ -21,9 +21,11 @@ This article describes how to use the [Azure IoT SDK for Java](https://github.co
 
 This section describes how to use device application code to create a direct method callback listener.
 
+The [DeviceClient](/java/api/com.microsoft.azure.sdk.iot.device.deviceclient) class exposes all the methods you require to interact with direct methods on the device.
+
 [!INCLUDE [iot-authentication-device-connection-string.md](iot-authentication-device-connection-string.md)]
 
-### Device import statement
+### Device import statements
 
 Use the following device import statements to access the Azure IoT SDK for Java.
 
@@ -37,9 +39,16 @@ import com.microsoft.azure.sdk.iot.device.transport.IotHubConnectionStatus;
 import com.microsoft.azure.sdk.iot.device.twin.SubscriptionAcknowledgedCallback;
 ```
 
-### Connect to a device
+### Connect a device to IoT Hub
 
-The [DeviceClient](/java/api/com.microsoft.azure.sdk.iot.device.deviceclient) class exposes all the methods you require to interact with direct methods on the device.
+A device app can authenticate with IoT Hub using the following methods:
+
+* Shared access key
+* X.509 certificate
+
+[!INCLUDE [iot-authentication-device-connection-string.md](iot-authentication-device-connection-string.md)]
+
+#### Authenticate using a shared access key
 
 To connect to a device:
 
@@ -62,6 +71,10 @@ To connect to a device:
     client.open(true);
     ```
 
+#### Authenticate using an X.509 certificate
+
+[!INCLUDE [iot-hub-howto-auth-device-cert-java](iot-hub-howto-auth-device-cert-java.md)]
+
 ### Create a direct method callback listener
 
 Use [subscribeToMethods](https://azure.github.io/azure-iot-sdk-java/master/device/com/microsoft/azure/sdk/iot/device/InternalClient.html#subscribeToMethods-com.microsoft.azure.sdk.iot.device.twin.MethodCallback-java.lang.Object-int-) to initialize a direct method callback listener. `subscribeToMethods` listens for incoming direct methods until the connection is terminated. The method name and payload is received for each direct method call.
@@ -92,7 +105,7 @@ The Azure IoT SDK for Java includes a working sample to test the device app conc
 
 This section describes how to initiate a remote reboot on a device using a direct method.
 
-The `ServiceClient` [DeviceMethod](/java/api/com.microsoft.azure.sdk.iot.service.devicetwin.devicemethod) class contains methods that services can use to access device twins.
+The `ServiceClient` [DeviceMethod](/java/api/com.microsoft.azure.sdk.iot.service.devicetwin.devicemethod) class contains methods that services can use to access direct methods.
 
 ### Service import statements
 

includes/iot-hub-howto-device-management-node.md

@@ -7,7 +7,7 @@ ms.author: kgremban
 ms.service: iot-hub
 ms.devlang: csharp
 ms.topic: include
-ms.date: 11/25/2024
+ms.date: 1/6/2025
 ms.custom: mqtt, devx-track-js
 ---
 
@@ -21,15 +21,30 @@ This article describes how to use the [Azure IoT SDK for Node.js](https://github
 
 This section describes how to use device application code to create a direct method callback.
 
-### Install SDK packages
+### Install SDK package
 
 The [azure-iot-device](/javascript/api/azure-iot-device) package contains objects that interface with IoT devices. Run this command to install the **azure-iot-device** device SDK on your development machine:
 
 ```cmd/sh
 npm install azure-iot-device --save
 ```
 
-### Choose a transport protocol
+### Connect a device to IoT Hub
+
+A device app can authenticate with IoT Hub using the following methods:
+
+* X.509 certificate
+* Shared access key
+
+[!INCLUDE [iot-authentication-device-connection-string.md](iot-authentication-device-connection-string.md)]
+
+#### Authenticate using an X.509 certificate
+
+[!INCLUDE [iot-hub-howto-auth-device-cert-node](iot-hub-howto-auth-device-cert-node.md)]
+
+#### Authenticate using a shared access key
+
+##### Choose a transport protocol
 
 The `Client` object supports these protocols:
 
@@ -49,7 +64,7 @@ npm install azure-iot-device-amqp --save
 
 For more information about the differences between MQTT, AMQP, and HTTPS support, see [Cloud-to-device communications guidance](../articles/iot-hub/iot-hub-devguide-c2d-guidance.md) and [Choose a communication protocol](../articles/iot-hub/iot-hub-devguide-protocols.md).
 
-### Create a client object
+##### Create a client object
 
 Create a `Client` object using the installed package.
 
@@ -59,7 +74,7 @@ For example:
 const Client = require('azure-iot-device').Client;
 ```
 
-### Create a protocol object
+##### Create a protocol object
 
 Create a `Protocol` object using an installed transport package.
 
@@ -69,7 +84,7 @@ This example assigns the AMQP protocol:
 const Protocol = require('azure-iot-device-amqp').Amqp;
 ```
 
-### Add the device connection string and transport protocol
+##### Add the device connection string and transport protocol
 
 Call [fromConnectionString](/javascript/api/azure-iot-device/client?#azure-iot-device-client-fromconnectionstring) to supply device connection parameters:
 
@@ -84,7 +99,7 @@ const Protocol = require('azure-iot-device-mqtt').Amqp;
 let client = Client.fromConnectionString(deviceConnectionString, Protocol);
 ```
 
-### Open the connection to IoT Hub
+##### Open the connection to IoT Hub
 
 Use the [open](/javascript/api/azure-iot-device/client?#azure-iot-device-client-open) method to open connection between an IoT device and IoT Hub.
 

includes/iot-hub-howto-device-management-python.md

@@ -7,7 +7,7 @@ ms.author: kgremban
 ms.service: iot-hub
 ms.devlang: csharp
 ms.topic: include
-ms.date: 11/25/2024
+ms.date: 1/6/2025
 ms.custom: mqtt, devx-track-python, py-fresh-zinc
 ---
 
@@ -35,9 +35,9 @@ pip install azure-iot-hub
 
 This section describes how to use device application code to create a direct method callback listener.
 
-[!INCLUDE [iot-authentication-device-connection-string.md](iot-authentication-device-connection-string.md)]
+The [IoTHubDeviceClient](/python/api/azure-iot-device/azure.iot.device.iothubdeviceclient) class contains methods that can be used to work with direct methods.
 
-### Device import statements
+### Device import statement
 
 Add this import statement to access `IoTHubDeviceClient` and `MethodResponse`.
 
@@ -48,7 +48,14 @@ from azure.iot.device import IoTHubDeviceClient, MethodResponse
 
 ### Connect to a device
 
-The [IoTHubDeviceClient](/python/api/azure-iot-device/azure.iot.device.iothubdeviceclient) class contains methods that can be used to work with direct methods.
+A device app can authenticate with IoT Hub using the following methods:
+
+* Shared access key
+* X.509 certificate
+
+[!INCLUDE [iot-authentication-device-connection-string.md](iot-authentication-device-connection-string.md)]
+
+#### Authenticate using a shared access key
 
 Use [create_from_connection_string](/python/api/azure-iot-device/azure.iot.device.iothubdeviceclient?#azure-iot-device-iothubdeviceclient-create-from-connection-string) to connect an application to a device using a device connection string.
 
@@ -59,6 +66,10 @@ conn_str = "{IoT hub device connection string}"
 device_client = IoTHubDeviceClient.create_from_connection_string(conn_str)
 ```
 
+#### Authenticate using an X.509 certificate
+
+[!INCLUDE [iot-hub-howto-auth-device-cert-python](iot-hub-howto-auth-device-cert-python.md)]
+
 ### Create a direct method callback
 
 Use [on_method_request_received](/python/api/azure-iot-device/azure.iot.device.iothubdeviceclient?#azure-iot-device-iothubdeviceclient-on-method-request-received) to create a handler function or coroutine that is called when a direct method is received. The listener is associated with a method name keyword, such as "reboot". The method name can be used in an IoT Hub or backend application to trigger the callback method on the device.
@@ -157,7 +168,7 @@ To invoke a direct method on a device:
 1. Create a [CloudToDeviceMethod](/python/api/azure-iot-hub/azure.iot.hub.protocol.models.cloudtodevicemethod) object. Supply the method name and payload as parameters.
 1. Call [invoke_device_method](/python/api/azure-iot-hub/azure.iot.hub.iothub_registry_manager.iothubregistrymanager?#azure-iot-hub-iothub-registry-manager-iothubregistrymanager-invoke-device-method) to invoke a direct method on a device. Supply the device ID and `CloudToDeviceMethod` payload object as parameters.
 
-This example calls `CloudToDeviceMethod` to invoke a direct method named "rebootDevice" on a device. After the direct method has been successfully invoked, the direct method response payload is displayed.
+This example calls `CloudToDeviceMethod` to invoke a direct method named "rebootDevice" on a device. After the direct method is successfully invoked, the direct method response payload is displayed.
 
 ```python
 CONNECTION_STRING = "{IoTHubConnectionString}"