Merge pull request #287622 from kgremban/sep30-ropc

AnnaMHuff · web-flow · commit 4f3fc2390cdc · 2024-09-30T16:32:13.000-06:00
ROPC - IoT Hub device and service connstring notes
diff --git a/articles/iot-hub/device-management-dotnet.md b/articles/iot-hub/device-management-dotnet.md
@@ -44,6 +44,8 @@ In this section, you:
 
 * Use the reported properties to enable device twin queries to identify devices and when they were last rebooted.
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 To create the simulated device app, follow these steps:
 
 1. Open Visual Studio and select **Create a new project**, then find and select the **Console App (.NET Framework)** project template, then select **Next**.
@@ -156,6 +158,9 @@ To create the simulated device app, follow these steps:
 
 In this section, you create a .NET console app, using C#, that initiates a remote reboot on a device using a direct method. The app uses device twin queries to discover the last reboot time for that device.
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
+
 1. Open Visual Studio and select **Create a new project**.
 
 1. In **Create a new project**, find and select the **Console App (.NET Framework)** project template, and then select **Next**.
diff --git a/articles/iot-hub/device-management-java.md b/articles/iot-hub/device-management-java.md
@@ -43,6 +43,8 @@ This article shows you how to create:
 
 In this section, you create a Java console app that simulates a device. The app listens for the reboot direct method call from your IoT hub and immediately responds to that call. The app then sleeps for a while to simulate the reboot process before it uses a reported property to notify the **trigger-reboot** back-end app that the reboot is complete.
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 1. In the **dm-get-started** folder, create a Maven project called **simulated-device** using the following command at your command prompt:
 
     ```cmd/sh
@@ -277,6 +279,8 @@ In this section, you create a Java console app that:
 
 3. Polls the reported properties sent from the device to determine when the reboot is complete.
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 This console app connects to your IoT Hub to invoke the direct method and read the reported properties.
 
 1. Create an empty folder called **dm-get-started**.
diff --git a/articles/iot-hub/device-management-node.md b/articles/iot-hub/device-management-node.md
@@ -44,6 +44,8 @@ In this section, you:
 
 * Use the reported properties to enable device twin queries to identify devices and when they last rebooted.
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 1. Create an empty folder called **managed-device**.  In the **managed-device** folder, create a package.json file using the following command at your command prompt.  Accept all the defaults:
 
     ```cmd/sh
@@ -144,6 +146,8 @@ In this section, you:
 
 In this section, you create a Node.js console app that initiates a remote reboot on a device using a direct method. The app uses device twin queries to discover the last reboot time for that device.
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 1. Create an empty folder called **trigger-reboot-on-device**. In the **trigger-reboot-on-device** folder, create a package.json file using the following command at your command prompt. Accept all the defaults:
 
     ```cmd/sh
diff --git a/articles/iot-hub/device-management-python.md b/articles/iot-hub/device-management-python.md
@@ -53,6 +53,8 @@ In this section, you:
 
 * Use the reported properties to enable device twin queries to identify devices and when they last rebooted.
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 In Azure Cloud Shell you used previously, or any other environment with Python, create the device code.
 
 1. At your command prompt, run the following command to install the **azure-iot-device** package:
@@ -160,6 +162,8 @@ In Azure Cloud Shell you used previously, or any other environment with Python,
 
 In this section, you create a Python console app that initiates a remote reboot on a device using a direct method. The app uses device twin queries to discover the last reboot time for that device.
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 In Azure Cloud Shell or any other environment with Python, create the console code.
 
 1. At your command prompt, run the following command to install the **azure-iot-hub** package:
diff --git a/articles/iot-hub/iot-hub-bulk-identity-mgmt.md b/articles/iot-hub/iot-hub-bulk-identity-mgmt.md
@@ -37,6 +37,8 @@ Identity registry operations use the job system when the operation:
 
 Instead of a single API call waiting or blocking on the result of the operation, the operation asynchronously creates a job for that IoT hub. The operation then immediately returns a **JobProperties** object.
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 The following C# code snippet shows how to create an export job:
 
 ```csharp
diff --git a/articles/iot-hub/iot-hub-live-data-visualization-in-web-apps.md b/articles/iot-hub/iot-hub-live-data-visualization-in-web-apps.md
@@ -64,6 +64,8 @@ The service connection string should look similar to the following example:
 
 Note down the service connection string, you need it later in this tutorial.
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 ## Download the web app from GitHub
 
 Download or clone the web app sample from GitHub: [web-apps-node-iot-hub-data-visualization](https://github.com/Azure-Samples/web-apps-node-iot-hub-data-visualization.git).
diff --git a/articles/iot-hub/iot-hub-managed-identity.md b/articles/iot-hub/iot-hub-managed-identity.md
@@ -376,8 +376,6 @@ Azure IoT Hub SDKs also support this functionality in the service client's regis
 ```csharp
     // Create an export job
  
-    using RegistryManager srcRegistryManager = RegistryManager.CreateFromConnectionString(hubConnectionString);
- 
     JobProperties jobProperties = JobProperties.CreateForExportJob(
         outputBlobContainerUri: blobContainerUri,
         excludeKeysInExport: false,
@@ -391,8 +389,6 @@ Azure IoT Hub SDKs also support this functionality in the service client's regis
 ```csharp
     // Create an import job
     
-    using RegistryManager destRegistryManager = RegistryManager.CreateFromConnectionString(hubConnectionString);
- 
     JobProperties jobProperties = JobProperties.CreateForImportJob(
         inputBlobContainerUri: blobContainerUri,
         outputBlobContainerUri: blobContainerUri,
@@ -407,7 +403,7 @@ Azure IoT Hub SDKs also support this functionality in the service client's regis
 
 ```python
 # see note below
-iothub_job_manager = IoTHubJobManager("<IoT Hub connection string>")
+iothub_job_manager = IoTHubJobManager("<IoT Hub connection information>")
 
 # Create an import job
 result = iothub_job_manager.create_import_export_job(JobProperties(
diff --git a/articles/iot-hub/module-twins-dotnet.md b/articles/iot-hub/module-twins-dotnet.md
@@ -49,6 +49,8 @@ openssl req -new -key d1m1.key.pem -out d1m1.csr -subj "/CN=device01\/module01"
 
 [!INCLUDE [iot-hub-include-find-registryrw-connection-string](../../includes/iot-hub-include-find-registryrw-connection-string.md)]
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 [!INCLUDE [iot-hub-get-started-create-module-identity-csharp](../../includes/iot-hub-get-started-create-module-identity-csharp.md)]
 
 ## Update the module twin using .NET device SDK
@@ -57,6 +59,8 @@ Now let's communicate to the cloud from your simulated device. Once a module ide
 
 To retrieve your module connection string, navigate to your [IoT hub](https://portal.azure.com/#view/HubsExtension/BrowseResource/resourceType/Microsoft.Devices%2FIotHubs) then select **Devices**. Find and select **myFirstDevice** to open it and then select **myFirstModule** to open it. In **Module Identity Details**, copy the **Connection string (primary key)** and save it for the console app.
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 1. In Visual Studio, add a new project to your solution by selecting **File** > **New** > **Project**. In **Create a new project**, select **Console App (.NET Framework)**, and select **Next**.
 
 1. In **Configure your new project**, name the project *UpdateModuleTwinReportedProperties*, then select **Next**.
diff --git a/articles/iot-hub/module-twins-node.md b/articles/iot-hub/module-twins-node.md
@@ -49,10 +49,14 @@ openssl req -new -key d1m1.key.pem -out d1m1.csr -subj "/CN=device01\/module01"
 
 [!INCLUDE [iot-hub-include-find-registryrw-connection-string](../../includes/iot-hub-include-find-registryrw-connection-string.md)]
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 ## Create a device identity and a module identity in IoT Hub
 
 In this section, you create a Node.js app that creates a device identity and a module identity in the identity registry in your IoT hub. A device or module can't connect to IoT hub unless it has an entry in the identity registry. For more information, see [Understand the identity registry in your IoT hub](iot-hub-devguide-identity-registry.md). When you run this console app, it generates a unique ID and key for both device and module. The ID and key are case-sensitive. Your device and module use these values to identify itself when it sends device-to-cloud messages to IoT Hub.
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 1. Create a directory to hold your code.
 
 2. Inside of that directory, first run **npm init -y** to create an empty package.json with defaults. This is the project file for your code.
@@ -134,7 +138,7 @@ In this section, you create a Node.js app on your simulated device that updates
 
    ![Azure portal module detail](./media/module-twins-node/module-detail.png)
 
-2. Similar to what you did in the previous section, create a directory for your device code and use NPM to initialize it and install the device SDK (**npm install -S azure-iot-device-amqp\@modules-preview**).
+2. Similar to what you did in the previous section, create a directory for your device code and use npm to initialize it and install the device SDK (**npm install -S azure-iot-device-amqp\@modules-preview**).
 
    > [!NOTE]
    > The npm install command may feel slow. Be patient; it's pulling down lots of code from the package repository.
diff --git a/articles/iot-hub/module-twins-portal-dotnet.md b/articles/iot-hub/module-twins-portal-dotnet.md
@@ -88,6 +88,8 @@ The module identity and module twin features are only available in the IoT Hub p
 
 ### Create UpdateModuleTwinReportedProperties console app
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 To create your app, follow these steps:
 
 1. Add the following `using` statements at the top of the **Program.cs** file:
diff --git a/articles/iot-hub/module-twins-python.md b/articles/iot-hub/module-twins-python.md
@@ -53,10 +53,14 @@ In this article, you create a back-end service that adds a device in the identit
 
 [!INCLUDE [iot-hub-include-find-service-regrw-connection-string](../../includes/iot-hub-include-find-service-regrw-connection-string.md)]
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 ## Create a device identity and a module identity in IoT Hub
 
 In this section, you create a Python service app that creates a device identity and a module identity in the identity registry in your IoT hub. A device or module can't connect to IoT hub unless it has an entry in the identity registry. For more information, see [Understand the identity registry in your IoT hub](iot-hub-devguide-identity-registry.md). When you run this console app, it generates a unique ID and key for both device and module. The ID and key are case-sensitive. Your device and module use these values to identify itself when it sends device-to-cloud messages to IoT Hub.
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 1. At your command prompt, run the following command to install the **azure-iot-hub** package:
 
     ```cmd/sh
diff --git a/articles/iot-hub/schedule-jobs-dotnet.md b/articles/iot-hub/schedule-jobs-dotnet.md
@@ -57,6 +57,8 @@ This article shows you how to create two .NET (C#) console apps:
 
 In this section, you create a .NET console app that responds to a direct method called by the solution back end.
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 1. In Visual Studio, select **Create a new project**, and then choose the **Console App (.NET Framework)** project template. Select **Next** to continue.
 
 1. In **Configure your new project**, name the project *SimulateDeviceMethods* then select **Next**.
@@ -153,6 +155,8 @@ In this section, you create a .NET console app that responds to a direct method
 
 [!INCLUDE [iot-hub-include-find-registryrw-connection-string](../../includes/iot-hub-include-find-registryrw-connection-string.md)]
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 ## Schedule jobs for calling a direct method and sending device twin updates
 
 In this section, you create a .NET console app (using C#) that uses jobs to call the **LockDoor** direct method and send desired property updates to multiple devices.
diff --git a/articles/iot-hub/schedule-jobs-java.md b/articles/iot-hub/schedule-jobs-java.md
@@ -62,6 +62,8 @@ This article shows you how to create two Java apps:
 
 [!INCLUDE [iot-hub-include-find-registryrw-connection-string](../../includes/iot-hub-include-find-registryrw-connection-string.md)]
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 ## Create the service app
 
 In this section, you create a Java console app that uses jobs to:
@@ -290,6 +292,8 @@ To create the app:
 
 In this section, you create a Java console app that handles the desired properties sent from IoT Hub and implements the direct method call.
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 1. In the **iot-java-schedule-jobs** folder, create a Maven project called **simulated-device** using the following command at your command prompt. Note this is a single, long command:
 
    ```cmd/sh
diff --git a/articles/iot-hub/schedule-jobs-node.md b/articles/iot-hub/schedule-jobs-node.md
@@ -55,6 +55,8 @@ This article shows you how to create two Node.js apps:
 
 In this section, you create a Node.js console app that responds to a direct method called by the cloud, which triggers a simulated **lockDoor** method.
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 1. Create a new empty folder called **simDevice**.  In the **simDevice** folder, create a package.json file using the following command at your command prompt.  Accept all the defaults:
 
    ```console
@@ -127,6 +129,8 @@ In this section, you create a Node.js console app that responds to a direct meth
 
 [!INCLUDE [iot-hub-include-find-registryrw-connection-string](../../includes/iot-hub-include-find-registryrw-connection-string.md)]
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 ## Schedule jobs for calling a direct method and updating a device twin's properties
 
 In this section, you create a Node.js console app that initiates a remote **lockDoor** on a device using a direct method and update the device twin's properties.
diff --git a/articles/iot-hub/schedule-jobs-python.md b/articles/iot-hub/schedule-jobs-python.md
@@ -55,6 +55,8 @@ This article shows you how to create two Python apps:
 
 In this section, you create a Python console app that responds to a direct method called by the cloud, which triggers a simulated **lockDoor** method.
 
+[!INCLUDE [iot-authentication-device-connection-string.md](../../includes/iot-authentication-device-connection-string.md)]
+
 1. At your command prompt, run the following command to install the **azure-iot-device** package:
 
     ```cmd/sh
@@ -164,6 +166,8 @@ To create a shared access policy that grants **service connect**, **registry rea
 
 For more information about IoT Hub shared access policies and permissions, see [Access control and permissions](./iot-hub-dev-guide-sas.md#access-control-and-permissions).
 
+[!INCLUDE [iot-authentication-service-connection-string.md](../../includes/iot-authentication-service-connection-string.md)]
+
 ## Schedule jobs for calling a direct method and updating a device twin's properties
 
 In this section, you create a Python console app that initiates a remote **lockDoor** on a device using a direct method and also updates the device twin's desired properties.
