diff --git a/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs b/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs
index d82597e05fa9..128a67bf9f5b 100644
--- a/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs
+++ b/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs
@@ -28,7 +28,7 @@ public class DigitalTwinsClient
private readonly QueryRestClient _queryClient;
///
- /// Initializes a new instance of the class.
+ /// Creates a new instance of the class.
///
/// The Azure digital twins service instance URI to connect to.
/// The implementation which will be used to request for the authentication token.
@@ -53,7 +53,7 @@ public DigitalTwinsClient(Uri endpoint, TokenCredential credential)
}
///
- /// Initializes a new instance of the class.
+ /// Creates a new instance of the class.
///
/// The Azure digital twins service instance URI to connect to.
/// The implementation which will be used to request for the authentication token.
@@ -96,7 +96,7 @@ public DigitalTwinsClient(Uri endpoint, TokenCredential credential, DigitalTwins
}
///
- /// Initializes a new instance of the class.
+ /// Creates a new instance of the class.
///
protected DigitalTwinsClient()
{
@@ -104,7 +104,7 @@ protected DigitalTwinsClient()
}
///
- /// Get a digital twin.
+ /// Gets a digital twin asynchronously. After the task completes, the result will be set to .
///
///
/// The returned application/json string can always be deserialized into an instance of .
@@ -134,7 +134,7 @@ public virtual Task> GetDigitalTwinAsync(string digitalTwinId,
}
///
- /// Get a digital twin.
+ /// Gets a digital twin synchronously. After the task completes, the result will be set to .
///
///
/// The returned application/json string can always be deserialized into an instance of .
@@ -150,7 +150,7 @@ public virtual Response GetDigitalTwin(string digitalTwinId, Cancellatio
}
///
- /// Create a digital twin.
+ /// Creates a digital twin asynchronously. After the task completes, the result will be set to .
///
/// The Id of the digital twin.
/// The application/json digital twin to create.
@@ -185,7 +185,7 @@ public virtual Task> CreateDigitalTwinAsync(string digitalTwinI
}
///
- /// Create a digital twin.
+ /// Creates a digital twin synchronously. After the task completes, the result will be set to .
///
/// The Id of the digital twin.
/// The application/json digital twin to create.
@@ -198,7 +198,7 @@ public virtual Response CreateDigitalTwin(string digitalTwinId, string d
}
///
- /// Delete a digital twin.
+ /// Deletes a digital twin asynchronously. After the task completes, the result will be set to .
///
/// The Id of the digital twin to delete.
/// The optional settings for this request.
@@ -218,7 +218,7 @@ public virtual Task DeleteDigitalTwinAsync(string digitalTwinId, Reque
}
///
- /// Delete a digital twin.
+ /// Deletes a digital twin synchronously. After the task completes, the result will be set to .
///
/// The Id of the digital twin to delete.
/// The optional settings for this request.
@@ -233,7 +233,7 @@ public virtual Response DeleteDigitalTwin(string digitalTwinId, RequestOptions r
}
///
- /// Update a digital twin.
+ /// Updates a digital twin asynchronously. After the task completes, the result will be set to .
///
/// The Id of the digital twin to update.
/// The application/json-patch+json operations to be performed on the specified digital twin.
@@ -247,7 +247,7 @@ public virtual Task> UpdateDigitalTwinAsync(string digitalTwinI
}
///
- /// Update a digital twin.
+ /// Updates a digital twin synchronously. After the task completes, the result will be set to .
///
/// The Id of the digital twin to update.
/// The application/json-patch+json operations to be performed on the specified digital twin.
@@ -260,7 +260,7 @@ public virtual Response UpdateDigitalTwin(string digitalTwinId, string d
}
///
- /// Gets a component on a digital twin.
+ /// Gets a component on a digital twin asynchronously. After the task completes, the result will be set to .
///
/// The Id of the digital twin.
/// The component being retrieved.
@@ -279,7 +279,7 @@ public virtual Task> GetComponentAsync(string digitalTwinId, st
}
///
- /// Gets a component on a digital twin.
+ /// Gets a component on a digital twin synchronously. After the task completes, the result will be set to .
///
/// The Id of the digital twin.
/// The component being retrieved.
@@ -291,7 +291,7 @@ public virtual Response GetComponent(string digitalTwinId, string compon
}
///
- /// Updates properties of a component on a digital twin.
+ /// Updates properties of a component on a digital twin asynchronously. After the task completes, the result will be set to .
///
/// The Id of the digital twin.
/// The component being modified.
@@ -318,7 +318,7 @@ public virtual Task> UpdateComponentAsync(string digitalTwinId,
}
///
- /// Updates properties of a component on a digital twin.
+ /// Updates properties of a component on a digital twin synchronously. After the task completes, the result will be set to .
///
/// The Id of the digital twin.
/// The component being modified.
@@ -332,7 +332,7 @@ public virtual Response UpdateComponent(string digitalTwinId, string com
}
///
- /// Gets all the relationships on a digital twin.
+ /// Gets all the relationships on a digital twin by iterating through a collection asynchronously .
///
/// The Id of the source digital twin.
/// The name of a relationship to filter to. If null, all relationships for the digital twin will be returned.
@@ -386,7 +386,7 @@ async Task> NextPageFunc(string nextLink, int? pageSizeHint)
}
///
- /// Gets all the relationships on a digital twin.
+ /// Gets all the relationships on a digital twin by iterating through a collection synchronously .
///
/// The Id of the source digital twin.
/// The name of a relationship to filter to. If null, all relationships for the digital twin will be returned.
@@ -435,7 +435,7 @@ Page NextPageFunc(string nextLink, int? pageSizeHint)
}
///
- /// Gets all the relationships referencing a digital twin as a target.
+ /// Gets all the relationships referencing a digital twin as a target by iterating through a collection asynchronously .
///
/// The Id of the target digital twin.
/// The cancellation token.
@@ -483,7 +483,7 @@ async Task> NextPageFunc(string nextLink, int? pageSi
}
///
- /// Gets all the relationships referencing a digital twin as a target.
+ /// Gets all the relationships referencing a digital twin as a target by iterating through a collection synchronously .
///
/// The Id of the target digital twin.
/// The cancellation token.
@@ -526,7 +526,7 @@ Page NextPageFunc(string nextLink, int? pageSizeHint)
}
///
- /// Get a relationship on a digital twin.
+ /// Gets a relationship on a digital twin asynchronously. After the task completes, the result will be set to .
///
/// The Id of the source digital twin.
/// The Id of the relationship to retrieve.
@@ -539,7 +539,7 @@ public virtual Task> GetRelationshipAsync(string digitalTwinId,
}
///
- /// Get a relationship on a digital twin.
+ /// Gets a relationship on a digital twin synchronously. After the task completes, the result will be set to .
///
/// The Id of the source digital twin.
/// The Id of the relationship to retrieve.
@@ -552,7 +552,7 @@ public virtual Response GetRelationship(string digitalTwinId, string rel
}
///
- /// Delete a relationship on a digital twin.
+ /// Deletes a relationship on a digital twin asynchronously. After the task completes, the result will be set to .
///
/// The Id of the source digital twin.
/// The Id of the relationship to delete.
@@ -565,7 +565,7 @@ public virtual Task DeleteRelationshipAsync(string digitalTwinId, stri
}
///
- /// Delete a relationship on a digital twin.
+ /// Deletes a relationship on a digital twin synchronously. After the task completes, the result will be set to .
///
/// The Id of the source digital twin.
/// The Id of the relationship to delete.
@@ -578,7 +578,7 @@ public virtual Response DeleteRelationship(string digitalTwinId, string relation
}
///
- /// Create a relationship on a digital twin.
+ /// Creates a relationship on a digital twin asynchronously. After the task completes, the result will be set to .
///
/// The Id of the source digital twin.
/// The Id of the relationship which is being created.
@@ -607,7 +607,7 @@ public virtual Task> CreateRelationshipAsync(string digitalTwin
}
///
- /// Create a relationship on a digital twin.
+ /// Creates a relationship on a digital twin synchronously. After the task completes, the result will be set to .
///
/// The Id of the source digital twin.
/// The Id of the relationship to delete.
@@ -624,7 +624,7 @@ public virtual Response CreateRelationship(string digitalTwinId, string
}
///
- /// Updates the properties of a relationship on a digital twin.
+ /// Updates the properties of a relationship on a digital twin asynchronously. After the task completes, the result will be set to .
///
/// The Id of the source digital twin.
/// The Id of the relationship to be updated.
@@ -639,7 +639,7 @@ public virtual Task UpdateRelationshipAsync(string digitalTwinId, stri
}
///
- /// Updates the properties of a relationship on a digital twin.
+ /// Updates the properties of a relationship on a digital twin synchronously. After the task completes, the result will be set to .
///
/// The Id of the source digital twin.
/// The Id of the relationship to be updated.
@@ -653,7 +653,7 @@ public virtual Response UpdateRelationship(string digitalTwinId, string relation
}
///
- /// Gets the list of models.
+ /// Gets the list of models by iterating through a collection asynchronously .
///
/// The model Ids to have dependencies retrieved.
/// Whether to include the model definition in the result. If false, only the model metadata will be returned.
@@ -707,7 +707,7 @@ async Task> NextPageFunc(string nextLink, int? pageSizeHint)
}
///
- /// Gets the list of models.
+ /// Gets the list of models by iterating through a collection synchronously .
///
/// The model Ids to have dependencies retrieved.
/// Whether to include the model definition in the result. If false, only the model metadata will be returned.
@@ -752,7 +752,7 @@ Page NextPageFunc(string nextLink, int? pageSizeHint)
}
///
- /// Get a model, including the model metadata and the model definition.
+ /// Gets a model, including the model metadata and the model definition asynchronously. After the task completes, the result will be set to .
///
/// The Id of the model.
/// The cancellation token.
@@ -769,7 +769,7 @@ public virtual Task> GetModelAsync(string modelId, Cancellat
}
///
- /// Get a model, including the model metadata and the model definition.
+ /// Gets a model, including the model metadata and the model definition synchronously. After the task completes, the result will be set to .
///
/// The Id of the model.
/// The cancellation token.
@@ -781,7 +781,7 @@ public virtual Response GetModel(string modelId, CancellationToken ca
}
///
- /// Decommission a model.
+ /// Decommissions a model asynchronously. After the task completes, the result will be set to .
///
/// The Id of the model to decommission.
/// The cancellation token.
@@ -811,7 +811,7 @@ public virtual Task DecommissionModelAsync(string modelId, Cancellatio
}
///
- /// Decommission a model.
+ /// Decommissions a model synchronously. After the task completes, the result will be set to .
///
/// The Id of the model to decommission.
/// The cancellation token.
@@ -827,7 +827,7 @@ public virtual Response DecommissionModel(string modelId, CancellationToken canc
}
///
- /// Create one or many models.
+ /// Creates one or many models asynchronously. After the task completes, the result will be set to .
///
/// The set of models to create. Each string corresponds to exactly one model.
/// The cancellation token.
@@ -850,7 +850,7 @@ public virtual Task>> CreateModelsAsync(IEnume
}
///
- /// Create one or many models.
+ /// Creates one or many models synchronously. After the task completes, the result will be set to .
///
/// The set of models to create. Each string corresponds to exactly one model.
/// The cancellation token.
@@ -867,7 +867,7 @@ public virtual Response> CreateModels(IEnumerable
- /// Deletes a model.
+ /// Deletes a model asynchronously. After the task completes, the result will be set to .
///
/// The id for the model. The id is globally unique and case sensitive.
/// The cancellation token to use.
@@ -899,7 +899,7 @@ public virtual Task DeleteModelAsync(string modelId, CancellationToken
}
///
- /// Deletes a model.
+ /// Deletes a model synchronously. After the task completes, the result will be set to .
///
/// The id for the model. The id is globally unique and case sensitive.
/// The cancellation token to use.
@@ -917,7 +917,7 @@ public virtual Response DeleteModel(string modelId, CancellationToken cancellati
}
///
- /// Query for digital twins.
+ /// Queries for digital twins by iterating through a collection asynchronously .
///
/// The query string, in SQL-like syntax.
/// The cancellation token.
@@ -986,7 +986,7 @@ async Task> NextPageFunc(string nextLink, int? pageSizeHint)
}
///
- /// Query for digital twins.
+ /// Queries for digital twins by iterating through a collection synchronously .
///
/// The query string, in SQL-like syntax.
/// The cancellation token.
@@ -1042,7 +1042,7 @@ Page NextPageFunc(string nextLink, int? pageSizeHint)
}
/// .
- /// List the event routes in a digital twins instance.
+ /// Lists the event routes in a digital twins instance by iterating through a collection asynchronously .
///
/// The options to use when listing the event routes. One can set the maximum number of items to retrieve per request, however the service may return less than requested.
/// The cancellation token.
@@ -1094,7 +1094,7 @@ async Task> NextPageFunc(string nextLink, int? pageSizeHint)
}
/// .
- /// List the event routes in a digital twins instance.
+ /// Lists the event routes in a digital twins instance by iterating through a collection synchronously .
///
/// The options to use when listing the event routes. One can set the maximum number of items to retrieve per request, however the service may return less than requested.
/// The cancellation token.
@@ -1137,7 +1137,7 @@ Page NextPageFunc(string nextLink, int? pageSizeHint)
}
///
- /// Get an event route by Id.
+ /// Gets an event route by Id asynchronously. After the task completes, the result will be set to .
///
/// The Id of the event route.
/// The cancellation token.
@@ -1148,7 +1148,7 @@ public virtual Task> GetEventRouteAsync(string eventRouteId
}
///
- /// Get an event route by Id.
+ /// Gets an event route by Id synchronously. After the task completes, the result will be set to .
///
/// The Id of the event route.
/// The cancellation token.
@@ -1159,7 +1159,7 @@ public virtual Response GetEventRoute(string eventRouteId, Cancellat
}
///
- /// Create an event route.
+ /// Creates an event route asynchronously. After the task completes, the result will be set to .
///
/// The Id of the event route to create.
/// The event route data containing the endpoint and optional filter.
@@ -1182,7 +1182,7 @@ public virtual Task CreateEventRouteAsync(string eventRouteId, EventRo
}
///
- /// Create an event route.
+ /// Creates an event route synchronously. After the task completes, the result will be set to .
///
/// The Id of the event route to create.
/// The event route data containing the endpoint and optional filter.
@@ -1194,7 +1194,7 @@ public virtual Response CreateEventRoute(string eventRouteId, EventRoute eventRo
}
///
- /// Delete an event route.
+ /// Deletes an event route asynchronously. After the task completes, the result will be set to .
///
/// The Id of the event route to delete.
/// The cancellation token.
@@ -1210,7 +1210,7 @@ public virtual Task DeleteEventRouteAsync(string eventRouteId, Cancell
}
///
- /// Delete an event route.
+ /// Deletes an event route synchronously. After the task completes, the result will be set to .
///
/// The Id of the event route to delete.
/// The cancellation token.
@@ -1221,7 +1221,8 @@ public virtual Response DeleteEventRoute(string eventRouteId, CancellationToken
}
///
- /// Publish telemetry from a digital twin, which is then consumed by one or many destination endpoints (subscribers) defined under .
+ /// Publishes telemetry from a digital twin asynchronously. After the task completes, the result will be set to .
+ /// The result is then consumed by one or many destination endpoints (subscribers) defined under .
/// These event routes need to be set before publishing a telemetry message, in order for the telemetry message to be consumed.
///
/// The Id of the digital twin.
@@ -1246,7 +1247,8 @@ public virtual Task PublishTelemetryAsync(string digitalTwinId, string
}
///
- /// Publish telemetry from a digital twin, which is then consumed by one or many destination endpoints (subscribers) defined under .
+ /// Publishes telemetry from a digital twin synchronously. After the task completes, the result will be set to .
+ /// The result is then consumed by one or many destination endpoints (subscribers) defined under .
/// These event routes need to be set before publishing a telemetry message, in order for the telemetry message to be consumed.
///
/// The Id of the digital twin.
@@ -1263,7 +1265,8 @@ public virtual Response PublishTelemetry(string digitalTwinId, string payload, T
}
///
- /// Publish telemetry from a digital twin's component, which is then consumed by one or many destination endpoints (subscribers) defined under .
+ /// Publishes telemetry from a digital twin's component asynchronously. After the task completes, the result will be set to .
+ /// The result is then consumed by one or many destination endpoints (subscribers) defined under .
/// These event routes need to be set before publishing a telemetry message, in order for the telemetry message to be consumed.
///
/// The Id of the digital twin.
@@ -1293,7 +1296,8 @@ public virtual Task PublishComponentTelemetryAsync(string digitalTwinI
}
///
- /// Publish telemetry from a digital twin's component, which is then consumed by one or many destination endpoints (subscribers) defined under .
+ /// Publishes telemetry from a digital twin's component synchronously. After the task completes, the result will be set to .
+ /// The result is then consumed by one or many destination endpoints (subscribers) defined under .
/// These event routes need to be set before publishing a telemetry message, in order for the telemetry message to be consumed.
///
/// The Id of the digital twin.