adt(doc): specify code snippet language (Azure#20395)

Author: David R. Williamson

sdk/digitaltwins/Azure.DigitalTwins.Core/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Release History
 
+## 1.3.0-beta.1 (Unreleased)
+
+
 ## 1.2.2 (2021-04-12)
 
 ### Fixes and improvements

sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs

@@ -53,7 +53,7 @@ public class DigitalTwinsClient
         /// For more samples, see <see href="https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/digitaltwins/Azure.DigitalTwins.Core/samples">our repo samples</see>.
         /// </remarks>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleCreateServiceClientWithClientSecret">
+        /// <code snippet="Snippet:DigitalTwinsSampleCreateServiceClientWithClientSecret" language="csharp">
         /// // DefaultAzureCredential supports different authentication mechanisms and determines the appropriate credential type based of the environment it is executing in.
         /// // It attempts to use multiple credential types in an order until it finds a working credential.
         /// TokenCredential tokenCredential = new DefaultAzureCredential();
@@ -138,7 +138,7 @@ protected DigitalTwinsClient()
         /// <example>
         /// This sample demonstrates getting and deserializing a digital twin into a custom data type.
         ///
-        /// <code snippet="Snippet:DigitalTwinsSampleGetCustomDigitalTwin">
+        /// <code snippet="Snippet:DigitalTwinsSampleGetCustomDigitalTwin" language="csharp">
         /// Response&lt;CustomDigitalTwin&gt; getCustomDtResponse = await client.GetDigitalTwinAsync&lt;CustomDigitalTwin&gt;(customDtId);
         /// CustomDigitalTwin customDt = getCustomDtResponse.Value;
         /// Console.WriteLine($&quot;Retrieved and deserialized digital twin {customDt.Id}:\n\t&quot; +
@@ -255,7 +255,7 @@ public virtual Response<T> GetDigitalTwin<T>(string digitalTwinId, CancellationT
         /// The exception is thrown when <paramref name="digitalTwinId"/> or <paramref name="digitalTwin"/> is <c>null</c>.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleCreateCustomTwin">
+        /// <code snippet="Snippet:DigitalTwinsSampleCreateCustomTwin" language="csharp">
         /// var customTwin = new CustomDigitalTwin
         /// {
         ///     Id = customDtId,
@@ -393,7 +393,7 @@ public virtual Response<T> CreateOrReplaceDigitalTwin<T>(
         /// To delete a digital twin, any relationships referencing it must be deleted first.
         /// </remarks>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleDeleteTwin">
+        /// <code snippet="Snippet:DigitalTwinsSampleDeleteTwin" language="csharp">
         /// await client.DeleteDigitalTwinAsync(digitalTwinId);
         /// Console.WriteLine($&quot;Deleted digital twin &apos;{digitalTwinId}&apos;.&quot;);
         /// </code>
@@ -558,7 +558,7 @@ public virtual Response UpdateDigitalTwin(string digitalTwinId, JsonPatchDocumen
         /// The exception is thrown when <paramref name="digitalTwinId"/> or <paramref name="componentName"/> is <c>null</c>.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleGetComponent">
+        /// <code snippet="Snippet:DigitalTwinsSampleGetComponent" language="csharp">
         /// await client.GetComponentAsync&lt;MyCustomComponent&gt;(basicDtId, SamplesConstants.ComponentName);
         /// Console.WriteLine($&quot;Retrieved component for digital twin &apos;{basicDtId}&apos;.&quot;);
         /// </code>
@@ -653,7 +653,7 @@ public virtual Response<T> GetComponent<T>(string digitalTwinId, string componen
         /// <exception cref="ArgumentNullException">
         /// The exception is thrown when <paramref name="digitalTwinId"/> or <paramref name="componentName"/> is <c>null</c>.
         /// </exception>
-        /// <code snippet="Snippet:DigitalTwinsSampleUpdateComponent">
+        /// <code snippet="Snippet:DigitalTwinsSampleUpdateComponent" language="csharp">
         /// // Update Component1 by replacing the property ComponentProp1 value,
         /// // using an optional utility to build the payload.
         /// var componentJsonPatchDocument = new JsonPatchDocument();
@@ -770,7 +770,7 @@ public virtual Response UpdateComponent(
         /// </exception>
         /// <example>
         /// This sample demonstrates iterating over outgoing relationships and deserializing relationship strings into BasicRelationship objects.
-        /// <code snippet="Snippet:DigitalTwinsSampleGetAllRelationships">
+        /// <code snippet="Snippet:DigitalTwinsSampleGetAllRelationships" language="csharp">
         /// AsyncPageable&lt;BasicRelationship&gt; relationships = client.GetRelationshipsAsync&lt;BasicRelationship&gt;(&quot;buildingTwinId&quot;);
         /// await foreach (BasicRelationship relationship in relationships)
         /// {
@@ -936,7 +936,7 @@ Page<T> NextPageFunc(string nextLink, int? pageSizeHint)
         /// The exception is thrown when <paramref name="digitalTwinId"/> is <c>null</c>.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleGetIncomingRelationships">
+        /// <code snippet="Snippet:DigitalTwinsSampleGetIncomingRelationships" language="csharp">
         /// AsyncPageable&lt;IncomingRelationship&gt; incomingRelationships = client.GetIncomingRelationshipsAsync(&quot;buildingTwinId&quot;);
         ///
         /// await foreach (IncomingRelationship incomingRelationship in incomingRelationships)
@@ -1086,7 +1086,7 @@ Page<IncomingRelationship> NextPageFunc(string nextLink, int? pageSizeHint)
         /// </exception>
         /// <example>
         /// This sample demonstrates getting and deserializing a digital twin relationship into a custom data type.
-        /// <code snippet="Snippet:DigitalTwinsSampleGetCustomRelationship">
+        /// <code snippet="Snippet:DigitalTwinsSampleGetCustomRelationship" language="csharp">
         /// Response&lt;CustomRelationship&gt; getCustomRelationshipResponse = await client.GetRelationshipAsync&lt;CustomRelationship&gt;(
         ///     &quot;floorTwinId&quot;,
         ///     &quot;floorBuildingRelationshipId&quot;);
@@ -1285,7 +1285,7 @@ public virtual Response DeleteRelationship(string digitalTwinId, string relation
         /// The exception is thrown when <paramref name="digitalTwinId"/> or <paramref name="relationshipId"/> is <c>null</c>.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleCreateCustomRelationship">
+        /// <code snippet="Snippet:DigitalTwinsSampleCreateCustomRelationship" language="csharp">
         /// var floorBuildingRelationshipPayload = new CustomRelationship
         /// {
         ///     Id = &quot;floorBuildingRelationshipId&quot;,
@@ -1529,7 +1529,7 @@ public virtual Response UpdateRelationship(
         /// The exception that captures the errors from the service. Check the <see cref="RequestFailedException.ErrorCode"/> and <see cref="RequestFailedException.Status"/> properties for more details.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleGetModels">
+        /// <code snippet="Snippet:DigitalTwinsSampleGetModels" language="csharp">
         /// AsyncPageable&lt;DigitalTwinsModelData&gt; allModels = client.GetModelsAsync();
         /// await foreach (DigitalTwinsModelData model in allModels)
         /// {
@@ -1689,7 +1689,7 @@ Page<DigitalTwinsModelData> NextPageFunc(string nextLink, int? pageSizeHint)
         /// The exception is thrown when <paramref name="modelId"/> is <c>null</c>.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleGetModel">
+        /// <code snippet="Snippet:DigitalTwinsSampleGetModel" language="csharp">
         /// Response&lt;DigitalTwinsModelData&gt; sampleModelResponse = await client.GetModelAsync(sampleModelId);
         /// Console.WriteLine($&quot;Retrieved model &apos;{sampleModelResponse.Value.Id}&apos;.&quot;);
         /// </code>
@@ -1771,7 +1771,7 @@ public virtual Response<DigitalTwinsModelData> GetModel(string modelId, Cancella
         /// The exception is thrown when <paramref name="modelId"/> is <c>null</c>.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleDecommisionModel">
+        /// <code snippet="Snippet:DigitalTwinsSampleDecommisionModel" language="csharp">
         /// try
         /// {
         ///     await client.DecommissionModelAsync(sampleModelId);
@@ -1866,7 +1866,7 @@ public virtual Response DecommissionModel(string modelId, CancellationToken canc
         /// </remarks>
         /// <seealso href="https://docs.microsoft.com/en-us/azure/digital-twins/concepts-models" />
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleCreateModels">
+        /// <code snippet="Snippet:DigitalTwinsSampleCreateModels" language="csharp">
         /// await client.CreateModelsAsync(new[] { newComponentModelPayload, newModelPayload });
         /// Console.WriteLine($&quot;Created models &apos;{componentModelId}&apos; and &apos;{sampleModelId}&apos;.&quot;);
         /// </code>
@@ -1967,7 +1967,7 @@ public virtual Response<DigitalTwinsModelData[]> CreateModels(IEnumerable<string
         /// The exception is thrown when <paramref name="modelId"/> is <c>null</c>.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleDeleteModel">
+        /// <code snippet="Snippet:DigitalTwinsSampleDeleteModel" language="csharp">
         /// try
         /// {
         ///     await client.DeleteModelAsync(sampleModelId);
@@ -2058,7 +2058,7 @@ public virtual Response DeleteModel(string modelId, CancellationToken cancellati
         /// The exception that captures the errors from the service. Check the <see cref="RequestFailedException.ErrorCode"/> and <see cref="RequestFailedException.Status"/> properties for more details.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleQueryTwins">
+        /// <code snippet="Snippet:DigitalTwinsSampleQueryTwins" language="csharp">
         /// // This code snippet demonstrates the simplest way to iterate over the digital twin results, where paging
         /// // happens under the covers.
         /// AsyncPageable&lt;BasicDigitalTwin&gt; asyncPageableResponse = client.QueryAsync&lt;BasicDigitalTwin&gt;(&quot;SELECT * FROM digitaltwins&quot;);
@@ -2277,7 +2277,7 @@ Page<T> NextPageFunc(string nextLink, int? pageSizeHint)
         /// The exception that captures the errors from the service. Check the <see cref="RequestFailedException.ErrorCode"/> and <see cref="RequestFailedException.Status"/> properties for more details.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleGetEventRoutes">
+        /// <code snippet="Snippet:DigitalTwinsSampleGetEventRoutes" language="csharp">
         /// AsyncPageable&lt;DigitalTwinsEventRoute&gt; response = client.GetEventRoutesAsync();
         /// await foreach (DigitalTwinsEventRoute er in response)
         /// {
@@ -2509,7 +2509,7 @@ public virtual Response<DigitalTwinsEventRoute> GetEventRoute(string eventRouteI
         /// The exception is thrown when <paramref name="eventRouteId"/> is <c>null</c>.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleCreateEventRoute">
+        /// <code snippet="Snippet:DigitalTwinsSampleCreateEventRoute" language="csharp">
         /// string eventFilter = &quot;$eventType = &apos;DigitalTwinTelemetryMessages&apos; or $eventType = &apos;DigitalTwinLifecycleNotification&apos;&quot;;
         /// var eventRoute = new DigitalTwinsEventRoute(eventhubEndpointName, eventFilter);
         ///
@@ -2587,7 +2587,7 @@ public virtual Response CreateOrReplaceEventRoute(string eventRouteId, DigitalTw
         /// The exception is thrown when <paramref name="eventRouteId"/> is <c>null</c>.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleDeleteEventRoute">
+        /// <code snippet="Snippet:DigitalTwinsSampleDeleteEventRoute" language="csharp">
         /// await client.DeleteEventRouteAsync(_eventRouteId);
         /// Console.WriteLine($&quot;Deleted event route &apos;{_eventRouteId}&apos;.&quot;);
         /// </code>
@@ -2665,7 +2665,7 @@ public virtual Response DeleteEventRoute(string eventRouteId, CancellationToken
         /// The exception is thrown when <paramref name="digitalTwinId"/> or <paramref name="payload"/> is <c>null</c>.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSamplePublishTelemetry">
+        /// <code snippet="Snippet:DigitalTwinsSamplePublishTelemetry" language="csharp">
         /// // construct your json telemetry payload by hand.
         /// await client.PublishTelemetryAsync(twinId, Guid.NewGuid().ToString(), &quot;{\&quot;Telemetry1\&quot;: 5}&quot;);
         /// Console.WriteLine($&quot;Published telemetry message to twin &apos;{twinId}&apos;.&quot;);
@@ -2788,7 +2788,7 @@ public virtual Response PublishTelemetry(
         /// The exception is thrown when <paramref name="digitalTwinId"/> or <paramref name="componentName"/> or <paramref name="payload"/> is <c>null</c>.
         /// </exception>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSamplePublishComponentTelemetry">
+        /// <code snippet="Snippet:DigitalTwinsSamplePublishComponentTelemetry" language="csharp">
         /// // construct your json telemetry payload by serializing a dictionary.
         /// var telemetryPayload = new Dictionary&lt;string, int&gt;
         /// {

sdk/digitaltwins/Azure.DigitalTwins.Core/src/Models/BasicDigitalTwin.cs

@@ -20,7 +20,7 @@ namespace Azure.DigitalTwins.Core
     /// <example>
     /// Here's an example of  how to use the BasicDigitalTwin helper class to serialize and create a digital twin.
     ///
-    /// <code snippet="Snippet:DigitalTwinsSampleCreateBasicTwin">
+    /// <code snippet="Snippet:DigitalTwinsSampleCreateBasicTwin" language="csharp">
     /// // Create digital twin with component payload using the BasicDigitalTwin serialization helper
     ///
     /// var basicTwin = new BasicDigitalTwin
@@ -55,7 +55,7 @@ namespace Azure.DigitalTwins.Core
     ///
     /// Here's an example of  how to use the BasicDigitalTwin helper class to get and deserialize a digital twin.
     ///
-    /// <code snippet="Snippet:DigitalTwinsSampleGetBasicDigitalTwin">
+    /// <code snippet="Snippet:DigitalTwinsSampleGetBasicDigitalTwin" language="csharp">
     /// Response&lt;BasicDigitalTwin&gt; getBasicDtResponse = await client.GetDigitalTwinAsync&lt;BasicDigitalTwin&gt;(basicDtId);
     /// BasicDigitalTwin basicDt = getBasicDtResponse.Value;
     ///
@@ -101,7 +101,7 @@ public class BasicDigitalTwin
         /// If the property is a component, use the <see cref="BasicDigitalTwinComponent"/> class to deserialize the payload.
         /// </remarks>
         /// <example>
-        /// <code snippet="Snippet:DigitalTwinsSampleGetBasicDigitalTwin">
+        /// <code snippet="Snippet:DigitalTwinsSampleGetBasicDigitalTwin" language="csharp">
         /// Response&lt;BasicDigitalTwin&gt; getBasicDtResponse = await client.GetDigitalTwinAsync&lt;BasicDigitalTwin&gt;(basicDtId);
         /// BasicDigitalTwin basicDt = getBasicDtResponse.Value;
         ///

sdk/digitaltwins/Azure.DigitalTwins.Core/src/Models/BasicRelationship.cs

@@ -23,7 +23,7 @@ namespace Azure.DigitalTwins.Core
     /// <example>
     /// Here's an example of how to use the BasicRelationship helper class to serialize and create a relationship from a building digital twin to a floor digital twin.
     ///
-    /// <code snippet="Snippet:DigitalTwinsSampleCreateBasicRelationship">
+    /// <code snippet="Snippet:DigitalTwinsSampleCreateBasicRelationship" language="csharp">
     /// var buildingFloorRelationshipPayload = new BasicRelationship
     /// {
     ///     Id = &quot;buildingFloorRelationshipId&quot;,
@@ -45,7 +45,7 @@ namespace Azure.DigitalTwins.Core
     ///
     /// Here's an example of how to use the BasicRelationship helper class to get and deserialize a relationship.
     ///
-    /// <code snippet="Snippet:DigitalTwinsSampleGetBasicRelationship">
+    /// <code snippet="Snippet:DigitalTwinsSampleGetBasicRelationship" language="csharp">
     /// Response&lt;BasicRelationship&gt; getBasicRelationshipResponse = await client.GetRelationshipAsync&lt;BasicRelationship&gt;(
     ///     &quot;buildingTwinId&quot;,
     ///     &quot;buildingFloorRelationshipId&quot;);
@@ -98,6 +98,7 @@ public class BasicRelationship
         [JsonExtensionData]
 #pragma warning disable CA2227 // Collection properties should be readonly
         public IDictionary<string, object> Properties { get; set; } = new Dictionary<string, object>();
+
 #pragma warning restore CA2227 // Collection properties should be readonly
     }
 }

sdk/digitaltwins/Azure.DigitalTwins.Core/src/Queries/QueryChargeHelper.cs

@@ -24,7 +24,7 @@ public static class QueryChargeHelper
         /// <remarks>
         /// For more samples, see <see href="https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/digitaltwins/Azure.DigitalTwins.Core/samples">our repo samples</see>.
         /// </remarks>
-        /// <code snippet="Snippet:DigitalTwinsSampleQueryTwinsWithQueryCharge">
+        /// <code snippet="Snippet:DigitalTwinsSampleQueryTwinsWithQueryCharge" language="csharp">
         /// // This code snippet demonstrates how you could extract the query charges incurred when calling
         /// // the query API. It iterates over the response pages first to access to the query-charge header,
         /// // and then the digital twin results within each page.