feat(samples): Twin configurations sample

sdk/iot/Azure.Iot.Hub.Service/samples/IotHubClientSamples/ConfigurationSamples.cs

@@ -0,0 +1,189 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Threading.Tasks;
+using Azure.Iot.Hub.Service.Models;
+
+namespace Azure.Iot.Hub.Service.Samples
+{
+    /// <summary>
+    /// This sample goes through the usage of Configuration on the IoT Hub.
+    /// </summary>
+    internal class ConfigurationSamples
+    {
+        public readonly IotHubServiceClient IoTHubServiceClient;
+        public const int MaxRandomValue = 200;
+        public static readonly Random Random = new Random();
+
+        public ConfigurationSamples(IotHubServiceClient client)
+        {
+            IoTHubServiceClient = client;
+        }
+
+        public async Task RunSampleAsync()
+        {
+            string testConfigurationId = $"configuration{Random.Next(MaxRandomValue)}";
+            TwinConfiguration twinConfiguration = CreateSampleConfig(testConfigurationId);
+
+            // Create a Twin Configuration.
+            await CreateConfiguratioAsync(twinConfiguration);
+
+            // Get the Twin Configuration.
+            await GetConfiguratioAsync(twinConfiguration);
+
+            // Update the Twin Configuration.
+            await UpdateConfiguratioAsync(twinConfiguration);
+
+            // Delete the Twin Configuration.
+            await DeleteConfiguratioAsync(twinConfiguration);
+        }
+
+        /// <summary>
+        /// Creates a new twin configuration.
+        /// </summary>
+        /// <param name="twinConfiguration">Twin Configuration to create.</param>
+        public async Task<TwinConfiguration> CreateConfiguratioAsync(TwinConfiguration twinConfiguration)
+        {
+            SampleLogger.PrintHeader("CREATE TWIN CONFIGURATION");
+            TwinConfiguration createdConfig;
+
+            try
+            {
+                // Create a twin configuration
+                #region Snippet:IotHubCreateConfiguration
+                Response<TwinConfiguration> createResponse =
+                    await IoTHubServiceClient.Configurations.CreateOrUpdateConfigurationAsync(twinConfiguration).ConfigureAwait(false);
+                createdConfig = createResponse.Value;
+
+                Console.WriteLine($"Successfully created a new configuration with Id: '{createdConfig.Id}', ETag: '{createdConfig.Etag}'");
+
+                #endregion Snippet:IotHubCreateConfiguration
+
+                return createdConfig;
+            }
+            catch (Exception ex)
+            {
+                // Try to cleanup before exiting with fatal error.
+                await DeleteConfiguratioAsync(twinConfiguration);
+                SampleLogger.FatalError($"Failed to create twin configuration due to:\n{ex}");
+                throw;
+            }
+        }
+
+        /// <summary>
+        /// Get a twin configuration.
+        /// </summary>
+        /// <param name="twinConfiguration">Twin Configuration</param>
+        public async Task<TwinConfiguration> GetConfiguratioAsync(TwinConfiguration twinConfiguration)
+        {
+            SampleLogger.PrintHeader("GET A CONFIGURATION");
+
+            try
+            {
+                Console.WriteLine($"Getting twin configuration with Id: '{twinConfiguration.Id}'\n");
+
+                #region Snippet:IotHubGetConfiguration
+
+                Response<TwinConfiguration> getResponse = await IoTHubServiceClient.Configurations.GetConfigurationAsync(twinConfiguration.Id).ConfigureAwait(false);
+
+                TwinConfiguration responseConfiguration = getResponse.Value;
+
+                SampleLogger.PrintSuccess($"\t- Configuration Id: '{responseConfiguration.Id}', ETag: '{responseConfiguration.Etag}'");
+
+                #endregion Snippet:IotHubGetConfiguration
+
+                return responseConfiguration;
+            }
+            catch (Exception ex)
+            {
+                // Try to cleanup before exiting with fatal error.
+                await DeleteConfiguratioAsync(twinConfiguration);
+                SampleLogger.FatalError($"Failed to get a twin configuration due to:\n{ex}");
+                throw;
+            }
+        }
+
+        /// <summary>
+        /// Update a twin configuration.
+        /// </summary>
+        /// <param name="twinConfiguration">Twin Configuration to to be updated.</param>
+        public async Task<TwinConfiguration> UpdateConfiguratioAsync(TwinConfiguration twinConfiguration)
+        {
+            SampleLogger.PrintHeader("UPDATE A CONFIGURATION");
+
+            try
+            {
+                #region Snippet:IotHubUpdateConfiguration
+
+                twinConfiguration.Priority = Random.Next(MaxRandomValue);
+                Console.WriteLine($"Updating twin configuration with Id: '{twinConfiguration.Id}''s priority to: '{twinConfiguration.Priority}'");
+                Response < TwinConfiguration > response = await IoTHubServiceClient.Configurations.CreateOrUpdateConfigurationAsync(twinConfiguration, IfMatchPrecondition.UnconditionalIfMatch).ConfigureAwait(false);
+
+                TwinConfiguration updatedConfiguration = response.Value;
+
+                SampleLogger.PrintSuccess($"Successfully updated twin configuration: Id: '{updatedConfiguration.Id}', Priority: '{updatedConfiguration.Priority}', ETag: '{updatedConfiguration.Etag}'");
+
+                #endregion Snippet:IotHubUpdateConfiguration
+
+                return updatedConfiguration;
+            }
+            catch (Exception ex)
+            {
+                // Try to cleanup before exiting with fatal error.
+                await DeleteConfiguratioAsync(twinConfiguration);
+                SampleLogger.FatalError($"Failed to update a twin configuration due to:\n{ex}");
+                throw;
+            }
+        }
+
+        /// <summary>
+        /// Deletes a twin configuration.
+        /// </summary>
+        /// <param name="twinConfiguration">Twin Configuration to deletec.</param>
+        public async Task DeleteConfiguratioAsync(TwinConfiguration twinConfiguration)
+        {
+            SampleLogger.PrintHeader("DELETE A CONFIGURATION");
+
+            try
+            {
+
+                Console.WriteLine($"Deleting twin configuration with Id: '{twinConfiguration.Id}'");
+
+                #region Snippet:IotHubDeleteConfiguration
+
+                Response response = await IoTHubServiceClient.Configurations.DeleteConfigurationAsync(twinConfiguration, IfMatchPrecondition.UnconditionalIfMatch).ConfigureAwait(false);
+
+                SampleLogger.PrintSuccess($"Successfully deleted twin configuration with Id: '{twinConfiguration.Id}'");
+
+                #endregion Snippet:IotHubDeleteConfiguration
+            }
+            catch (Exception ex)
+            {
+                SampleLogger.FatalError($"Failed to delete twin configuration due to:\n{ex}");
+            }
+        }
+
+        private TwinConfiguration CreateSampleConfig(string testConfigurationId)
+        {
+            var twinConfiguration =
+                new TwinConfiguration
+                {
+                    Id = testConfigurationId
+                };
+
+            // Labels are optional but adding here due to null check failure in deserialization
+            // Also note that we are not setting Host Platform value from Environment since that'll fail in our build pipeline
+            twinConfiguration.Labels.Add("HostPlatform", "SomeValue");
+            twinConfiguration.Content = new ConfigurationContent();
+            twinConfiguration.Content.DeviceContent.Add("properties.desired.deviceContent_key", $"deviceContent_value-{twinConfiguration.Id}");
+
+            // Specifying '*' to target all devices
+            twinConfiguration.TargetCondition = "*";
+
+            // Assign any integer value for priority
+            twinConfiguration.Priority = Random.Next(MaxRandomValue);
+            return twinConfiguration;
+        }
+    }
+}

sdk/iot/Azure.Iot.Hub.Service/samples/IotHubClientSamples/Program.cs

@@ -62,6 +62,9 @@ public static async Task Main(string[] args)
             var statisticsSample = new StatisticsSamples(hubClient);
             await statisticsSample.RunSampleAsync();
 
+            var configurationsSample = new ConfigurationSamples(hubClient);
+            await configurationsSample.RunSampleAsync();
+
             // Get SAS token to 'jobs' container in the  storage account.
             Uri containerSasUri = await GetSasUriAsync(options.StorageAccountConnectionString, "jobs").ConfigureAwait(false);