Final changes, update comments.

Author: robinsh

iot-hub/Samples/device/ImportExportDevicesSample/ProcessImpExpCommands.cs

@@ -14,7 +14,6 @@ namespace ImportExportDevices
     public static class IoTHubDevices
     {
 
-
         //generate NumToAdd devices and add them to the hub 
         // to do this, generate each identity 
         // * include authentication keys
@@ -215,8 +214,7 @@ public static async Task DeleteAllDevicesFromHub(string hubConnectionString,
                 sb.AppendLine(JsonConvert.SerializeObject(device));
             });
 
-            // Step 2: Delete the blob if it already exists, then write the list in memory to the blob.
-            
+            // Step 2: Delete the blob if it already exists, then write the list in memory to the blob.            
             await blobToDelete.DeleteIfExistsAsync();
             using (CloudBlobStream stream = await blobToDelete.OpenWriteAsync())
             {
@@ -252,18 +250,19 @@ public static async Task DeleteAllDevicesFromHub(string hubConnectionString,
         }
 
         //---------------------------------------------------------------------------------------
-        // This shows how to export devices for an IoT Hub. Then import them to a new Hub. 
+        // This shows how to copy devices from one IoT Hub to another.
         // First, export the list from the Source hut to devices.txt (ExportDevices).
         // Next, read in that file. Each row is a serialized object; 
         //   read them into the generic list serializedDevices. 
         // Delete the devices.txt in blob storage, because you're going to recreate it.
-        // For each serializedDevice, deserialize it, set ImportMode to UPDATE, 
+        // For each serializedDevice, deserialize it, set ImportMode to CREATE, 
         //   reserialize it, and write it to a StringBuilder. The ImportMode field is what
-        //   tells the job framework to update each one.
+        //   tells the job framework to add each device.
         // Write the new StringBuilder to the block blob.
         //   This essentially replaces the list with a list of devices that have ImportJob = Delete.
         // Call ImportDevicesAsync, which will read in the list in devices.txt, then add each one 
-        //   because it doesn't already exist
+        //   because it doesn't already exist. If it already exists, it will write an entry to
+        //   the import error log and not add the new one.
         public static async Task CopyAllDevicesToNewHub(string sourceHubConnectionString,
             string destHubConnectionString, CloudBlobContainer cloudBlobContainer, 
             string containerURI, string deviceListFile)        {
@@ -323,8 +322,8 @@ public static async Task CopyAllDevicesToNewHub(string sourceHubConnectionString
                 }
             }
 
-            // Step 3: Call import using the same blob to delete all devices.
-            // Loads devices.txt and applies that change.
+            // Step 3: Call import using the same blob to create all devices.
+            // Loads devices.txt and adds the devices to the destination hub.
             RegistryManager registryManager =
               RegistryManager.CreateFromConnectionString(destHubConnectionString);
             JobProperties importJob =

iot-hub/Samples/device/ImportExportDevicesSample/Program.cs

@@ -1,14 +1,12 @@
-using System;
-using System.Threading.Tasks;
+using Microsoft.Azure.Storage;
 using Microsoft.Azure.Storage.Blob;
-using Microsoft.Azure.Storage;
 using Microsoft.Azure.Storage.RetryPolicies;
+using System;
 
 namespace ImportExportDevices
 {
     public class Program
     {
-        //user variables -- add a config file and put these in settings? 
 
         //IoT Hub connection string. You can get this from the portal.
         // Log into https://azure.portal.com, go to Resources, find your hub and select it.
@@ -26,7 +24,7 @@ public class Program
         public static string storageAccountConnectionString = "<your storage account connection string>";
 
         // Container used to hold the blob containing the list of import/export files.
-        // This is a module-wide variable.
+        // This is a module-wide variable. If this project doesn't find this container, it will create it.
         public static CloudBlobContainer cloudBlobContainer;
 
         // Name of blob container holding the work data.
@@ -38,11 +36,11 @@ public class Program
 
         public static void Main(string[] args)
         {
-            //To use this sample, uncomment the bits you want to see run.
+            //To use this sample, uncomment the bits you want to run.
 
             //The size of the hub you are using should be able to manage the number of devices 
             //  you want to create and test with.
-            //For example, if you want to create a million devices, don't use a hub with a Basic sku.
+            //For example, if you want to create a million devices, don't use a hub with a Basic sku!
 
             // You must run this; it creates the blob storage resource.
             string containerURI = PrepareStorageForImportExport();
@@ -51,27 +49,31 @@ public static void Main(string[] args)
             // Add devices to the hub; specify how many. This creates a number of devices
             //   with partially random hub names. 
             // This is a good way to test the import -- create a bunch of devices on one hub,
-            //    then use this the Copy feature to copy the devices to the other hub.
+            //    then use this the Copy feature to copy the devices to another hub.
             // Number of devices to create and add. Default is 10.
             //int NumToAdd =  5; 
             //IoTHubDevices.GenerateAndAddDevices(IoTHubConnectionString, cloudBlobContainer, 
             //   containerURI, NumToAdd, deviceListFile).Wait();
 
-            //** you can use this if you want to add a bunch of devices, then dump them and look at them in a file (in blob storage).
+            //  This exports the devices to a file in blob storag.e 
+            //  You can use this to add a bunch of new devices, then export them and look at them in a file (in blob storage).
             //Console.WriteLine("Read devices from the original hub, write to blob storage.");
             // Read the list of registered devices for the IoT Hub.
             // Write them to blob storage.
             //IoTHubDevices.ExportDevices(containerURI, IoTHubConnectionString).Wait();
 
-            Console.WriteLine("Copy devices from the original hub to the new hub.");
-            // Copy devices from an existing hub to the new hub.
+            Console.WriteLine("Copy devices from the original hub to a new hub.");
+            // Copy devices from an existing hub to a new hub.
             IoTHubDevices.CopyAllDevicesToNewHub(IoTHubConnectionString, DestIoTHubConnectionString, 
                 cloudBlobContainer, containerURI, deviceListFile).Wait();
 
-            //** uncomment this if you want to delete all the devices registered to the original hub **
+            //** uncomment this if you want to delete all the devices registered to a hub **
+
+            // Delete devices from the source hub.
             //Console.WriteLine("Delete all devices from the source hub.");
             //IoTHubDevices.DeleteAllDevicesFromHub(IoTHubConnectionString, cloudBlobContainer, containerURI, deviceListFile).Wait();
 
+            // Delete devices from the destination hub.
             //Console.WriteLine("Delete all devices from the destination hub.");
             //IoTHubDevices.DeleteAllDevicesFromHub(DestIoTHubConnectionString, cloudBlobContainer, containerURI, deviceListFile).Wait();