diff --git a/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs b/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs index ddb016caab17..c9f31ba076d9 100644 --- a/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs +++ b/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs @@ -98,7 +98,7 @@ protected DigitalTwinsClient() } /// - /// Gets a digital twin asynchronously. After the task completes, the result will be set to . + /// Gets a digital twin asynchronously. /// /// /// @@ -112,7 +112,7 @@ protected DigitalTwinsClient() /// /// The Id of the digital twin. /// The cancellation token. - /// The application/json digital twin and the http response. + /// The application/json digital twin and the http response . /// /// The exception that captures the errors from the service. Check the and properties for more details. /// @@ -142,7 +142,7 @@ public virtual Task> GetDigitalTwinAsync(string digitalTwinId, } /// - /// Gets a digital twin synchronously. After the task completes, the result will be set to . + /// Gets a digital twin synchronously. /// /// /// @@ -156,7 +156,7 @@ public virtual Task> GetDigitalTwinAsync(string digitalTwinId, /// /// The Id of the digital twin. /// The cancellation token. - /// The application/json digital twin and the http response. + /// The application/json digital twin and the http response . /// /// The exception that captures the errors from the service. Check the and properties for more details. /// @@ -169,12 +169,12 @@ public virtual Response GetDigitalTwin(string digitalTwinId, Cancellatio } /// - /// Creates a digital twin asynchronously. After the task completes, the result will be set to . + /// Creates a digital twin asynchronously. /// /// The Id of the digital twin. /// The application/json digital twin to create. /// The cancellation token. - /// The created application/json digital twin and the http response. + /// The created application/json digital twin and the http response . /// /// For more samples, see our repo samples. /// @@ -210,12 +210,12 @@ public virtual Task> CreateDigitalTwinAsync(string digitalTwinI } /// - /// Creates a digital twin synchronously. After the task completes, the result will be set to . + /// Creates a digital twin synchronously. /// /// The Id of the digital twin. /// The application/json digital twin to create. /// The cancellation token. - /// The created application/json digital twin and the http response. + /// The created application/json digital twin and the http response . /// /// For more samples, see our repo samples. /// @@ -231,12 +231,12 @@ public virtual Response CreateDigitalTwin(string digitalTwinId, string d } /// - /// Deletes a digital twin asynchronously. After the task completes, the result will be set to . + /// Deletes a digital twin asynchronously. /// /// The Id of the digital twin to delete. /// The optional settings for this request. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -260,12 +260,12 @@ public virtual Task DeleteDigitalTwinAsync(string digitalTwinId, Reque } /// - /// Deletes a digital twin synchronously. After the task completes, the result will be set to . + /// Deletes a digital twin synchronously. /// /// The Id of the digital twin to delete. /// The optional settings for this request. /// The cancellation token. - /// The http response. + /// The http response . /// /// /// To delete a digital twin, any relationships referencing it must be deleted first. @@ -286,13 +286,13 @@ public virtual Response DeleteDigitalTwin(string digitalTwinId, RequestOptions r } /// - /// Updates a digital twin asynchronously. After the task completes, the result will be set to . + /// Updates a digital twin asynchronously. /// /// The Id of the digital twin to update. /// The application/json-patch+json operations to be performed on the specified digital twin. /// The optional settings for this request. /// The cancellationToken. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -308,13 +308,13 @@ public virtual Task> UpdateDigitalTwinAsync(string digitalTwinI } /// - /// Updates a digital twin synchronously. After the task completes, the result will be set to . + /// Updates a digital twin synchronously. /// /// The Id of the digital twin to update. /// The application/json-patch+json operations to be performed on the specified digital twin. /// The optional settings for this request. /// The cancellationToken. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -333,12 +333,12 @@ public virtual Response UpdateDigitalTwin(string digitalTwinId, string d } /// - /// Gets a component on a digital twin asynchronously. After the task completes, the result will be set to . + /// Gets a component on a digital twin asynchronously. /// /// The Id of the digital twin. /// The component being retrieved. /// The cancellation token. - /// Json string representation of the component corresponding to the provided componentPath and the HTTP response. + /// Json string representation of the component corresponding to the provided componentPath and the HTTP response . /// /// For more samples, see our repo samples. /// @@ -361,12 +361,12 @@ public virtual Task> GetComponentAsync(string digitalTwinId, st } /// - /// Gets a component on a digital twin synchronously. After the task completes, the result will be set to . + /// Gets a component on a digital twin synchronously. /// /// The Id of the digital twin. /// The component being retrieved. /// The cancellation token. - /// Json string representation of the component corresponding to the provided componentPath and the HTTP response. + /// Json string representation of the component corresponding to the provided componentPath and the HTTP response . /// /// For more samples, see our repo samples. /// @@ -385,14 +385,14 @@ public virtual Response GetComponent(string digitalTwinId, string compon } /// - /// Updates properties of a component on a digital twin asynchronously. After the task completes, the result will be set to . + /// Updates properties of a component on a digital twin asynchronously. /// /// The Id of the digital twin. /// The component being modified. /// The application/json-patch+json operations to be performed on the specified digital twin's component. /// The optional settings for this request. /// The cancellation token. - /// The HTTP response. + /// The HTTP response . /// /// For more samples, see our repo samples. /// @@ -421,14 +421,14 @@ public virtual Task> UpdateComponentAsync(string digitalTwinId, } /// - /// Updates properties of a component on a digital twin synchronously. After the task completes, the result will be set to . + /// Updates properties of a component on a digital twin synchronously. /// /// The Id of the digital twin. /// The component being modified. /// The application/json-patch+json operations to be performed on the specified digital twin's component. /// The optional settings for this request. /// The cancellation token. - /// The HTTP response. + /// The HTTP response . /// /// For more samples, see our repo samples. /// @@ -447,12 +447,12 @@ public virtual Response UpdateComponent(string digitalTwinId, string com } /// - /// Gets all the relationships on a digital twin by iterating through a collection asynchronously . + /// 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. /// The cancellation token. - /// The pageable list of application/json relationships belonging to the specified digital twin and the http response. + /// The pageable list of application/json relationships belonging to the specified digital twin and the http response. /// /// For more samples, see our repo samples. /// @@ -510,12 +510,12 @@ async Task> NextPageFunc(string nextLink, int? pageSizeHint) } /// - /// Gets all the relationships on a digital twin by iterating through a collection synchronously . + /// 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. /// The cancellation token. - /// The pageable list of application/json relationships belonging to the specified digital twin and the http response. + /// The pageable list of application/json relationships belonging to the specified digital twin and the http response. /// /// For more samples, see our repo samples. /// @@ -571,11 +571,11 @@ Page NextPageFunc(string nextLink, int? pageSizeHint) } /// - /// Gets all the relationships referencing a digital twin as a target by iterating through a collection asynchronously . + /// 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. - /// The pageable list of application/json relationships directed towards the specified digital twin and the http response. + /// The pageable list of application/json relationships directed towards the specified digital twin and the http response. /// /// For more samples, see our repo samples. /// @@ -628,11 +628,11 @@ async Task> NextPageFunc(string nextLink, int? pageSi } /// - /// Gets all the relationships referencing a digital twin as a target by iterating through a collection synchronously . + /// 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. - /// The pageable list of application/json relationships directed towards the specified digital twin and the http response. + /// The pageable list of application/json relationships directed towards the specified digital twin and the http response. /// /// For more samples, see our repo samples. /// @@ -683,12 +683,12 @@ Page NextPageFunc(string nextLink, int? pageSizeHint) } /// - /// Gets a relationship on a digital twin asynchronously. After the task completes, the result will be set to . + /// Gets a relationship on a digital twin asynchronously. /// /// The Id of the source digital twin. /// The Id of the relationship to retrieve. /// The cancellation token. - /// The application/json relationship corresponding to the provided relationshipId and the http response. + /// The application/json relationship corresponding to the provided relationshipId and the http response . /// /// For more samples, see our repo samples. /// @@ -704,12 +704,12 @@ public virtual Task> GetRelationshipAsync(string digitalTwinId, } /// - /// Gets a relationship on a digital twin synchronously. After the task completes, the result will be set to . + /// Gets a relationship on a digital twin synchronously. /// /// The Id of the source digital twin. /// The Id of the relationship to retrieve. /// The cancellation token. - /// The application/json relationship corresponding to the provided relationshipId and the http response. + /// The application/json relationship corresponding to the provided relationshipId and the http response . /// /// For more samples, see our repo samples. /// @@ -728,13 +728,13 @@ public virtual Response GetRelationship(string digitalTwinId, string rel } /// - /// Deletes a relationship on a digital twin asynchronously. After the task completes, the result will be set to . + /// Deletes a relationship on a digital twin asynchronously. /// /// The Id of the source digital twin. /// The Id of the relationship to delete. /// The optional settings for this request. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -750,13 +750,13 @@ public virtual Task DeleteRelationshipAsync(string digitalTwinId, stri } /// - /// Deletes a relationship on a digital twin synchronously. After the task completes, the result will be set to . + /// Deletes a relationship on a digital twin synchronously. /// /// The Id of the source digital twin. /// The Id of the relationship to delete. /// The optional settings for this request. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -775,13 +775,13 @@ public virtual Response DeleteRelationship(string digitalTwinId, string relation } /// - /// Creates a relationship on a digital twin asynchronously. After the task completes, the result will be set to . + /// Creates a relationship on a digital twin asynchronously. /// /// The Id of the source digital twin. /// The Id of the relationship which is being created. /// The application/json relationship to be created. /// The cancellation token. - /// The http response. + /// The http response . /// /// /// Relationships are a one-way link from a source digital twin to another, as described at creation time of the assigned model of the digital twin. @@ -826,13 +826,13 @@ public virtual Task> CreateRelationshipAsync(string digitalTwin } /// - /// Creates a relationship on a digital twin synchronously. After the task completes, the result will be set to . + /// Creates a relationship on a digital twin synchronously. /// /// The Id of the source digital twin. /// The Id of the relationship to delete. /// The application/json relationship to be created. /// The cancellation token. - /// The http response. + /// The http response . /// /// /// Relationships are a one-way link from a source digital twin to another, as described at creation time of the assigned model of the digital twin. @@ -856,14 +856,14 @@ public virtual Response CreateRelationship(string digitalTwinId, string } /// - /// Updates the properties of a relationship on a digital twin asynchronously. After the task completes, the result will be set to . + /// Updates the properties of a relationship on a digital twin asynchronously. /// /// The Id of the source digital twin. /// The Id of the relationship to be updated. /// The application/json-patch+json operations to be performed on the specified digital twin's relationship. /// The optional settings for this request. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -880,14 +880,14 @@ public virtual Task UpdateRelationshipAsync(string digitalTwinId, stri } /// - /// Updates the properties of a relationship on a digital twin synchronously. After the task completes, the result will be set to . + /// Updates the properties of a relationship on a digital twin synchronously. /// /// The Id of the source digital twin. /// The Id of the relationship to be updated. /// The application/json-patch+json operations to be performed on the specified digital twin's relationship. /// The optional settings for this request. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -906,13 +906,13 @@ public virtual Response UpdateRelationship(string digitalTwinId, string relation } /// - /// Gets the list of models by iterating through a collection asynchronously . + /// 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. /// The options to follow when listing the models. For example, the page size hint can be specified. /// The cancellation token. - /// A pageable set of application/json models and the http response. + /// The pageable list of application/json models and the http response. /// /// For more samples, see our repo samples. /// @@ -966,13 +966,13 @@ async Task> NextPageFunc(string nextLink, int? pageSizeHint) } /// - /// Gets the list of models by iterating through a collection synchronously . + /// 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. /// The options to follow when listing the models. For example, the page size hint can be specified. /// The cancellation token. - /// A pageable set of application/json models and the http response. + /// The pageable list of application/json models and the http response. /// /// For more samples, see our repo samples. /// @@ -1020,11 +1020,11 @@ Page NextPageFunc(string nextLink, int? pageSizeHint) } /// - /// Gets a model, including the model metadata and the model definition asynchronously. After the task completes, the result will be set to . + /// Gets a model, including the model metadata and the model definition asynchronously. /// /// The Id of the model. /// The cancellation token. - /// The application/json model and the http response. + /// The application/json model and the http response . /// /// For more samples, see our repo samples. /// @@ -1046,11 +1046,11 @@ public virtual Task> GetModelAsync(string modelId, Cancellat } /// - /// Gets a model, including the model metadata and the model definition synchronously. After the task completes, the result will be set to . + /// Gets a model, including the model metadata and the model definition synchronously. /// /// The Id of the model. /// The cancellation token. - /// The application/json model and the http response. + /// The application/json model and the http response . /// /// For more samples, see our repo samples. /// @@ -1070,11 +1070,11 @@ public virtual Response GetModel(string modelId, CancellationToken ca } /// - /// Decommissions a model asynchronously. After the task completes, the result will be set to . + /// Decommissions a model asynchronously. /// /// The Id of the model to decommission. /// The cancellation token. - /// The http response. + /// The http response . /// /// /// When a model is decomissioned, new digital twins will no longer be able to be defined by this model. @@ -1110,11 +1110,11 @@ public virtual Task DecommissionModelAsync(string modelId, Cancellatio } /// - /// Decommissions a model synchronously. After the task completes, the result will be set to . + /// Decommissions a model synchronously. /// /// The Id of the model to decommission. /// The cancellation token. - /// The http response. + /// The http response . /// /// /// When a model is decomissioned, new digital twins will no longer be able to be defined by this model. @@ -1140,11 +1140,11 @@ public virtual Response DecommissionModel(string modelId, CancellationToken canc } /// - /// Creates one or many models asynchronously. After the task completes, the result will be set to . + /// Creates one or many models asynchronously. /// /// The set of models to create. Each string corresponds to exactly one model. /// The cancellation token. - /// The created models and the http response. + /// The created models and the http response . /// /// The exception that captures the errors from the service. Check the and properties for more details. /// @@ -1171,11 +1171,11 @@ public virtual Task>> CreateModelsAsync(IEnume } /// - /// Creates one or many models synchronously. After the task completes, the result will be set to . + /// Creates one or many models synchronously. /// /// The set of models to create. Each string corresponds to exactly one model. /// The cancellation token. - /// The created models and the http response. + /// The created models and the http response . /// /// /// Bulk model creation is useful when several models have references to each other. @@ -1199,11 +1199,11 @@ public virtual Response> CreateModels(IEnumerable - /// Deletes a model asynchronously. After the task completes, the result will be set to . + /// Deletes a model asynchronously. /// /// The id for the model. The id is globally unique and case sensitive. /// The cancellation token to use. - /// The http response. + /// The http response . /// /// /// A model can only be deleted if no other models reference it. @@ -1243,11 +1243,11 @@ public virtual Task DeleteModelAsync(string modelId, CancellationToken } /// - /// Deletes a model synchronously. After the task completes, the result will be set to . + /// Deletes a model synchronously. /// /// The id for the model. The id is globally unique and case sensitive. /// The cancellation token to use. - /// The http response. + /// The http response . /// /// /// A model can only be deleted if no other models reference it. @@ -1276,11 +1276,11 @@ public virtual Response DeleteModel(string modelId, CancellationToken cancellati } /// - /// Queries for digital twins by iterating through a collection asynchronously . + /// Queries for digital twins by iterating through a collection asynchronously. /// /// The query string, in SQL-like syntax. /// The cancellation token. - /// The pageable list of query results. + /// The pageable list of query results. /// /// For more samples, see our repo samples. /// @@ -1351,11 +1351,11 @@ async Task> NextPageFunc(string nextLink, int? pageSizeHint) } /// - /// Queries for digital twins by iterating through a collection synchronously . + /// Queries for digital twins by iterating through a collection synchronously. /// /// The query string, in SQL-like syntax. /// The cancellation token. - /// The pageable list of query results. + /// The pageable list of query results. /// /// For more samples, see our repo samples. /// @@ -1416,11 +1416,11 @@ Page NextPageFunc(string nextLink, int? pageSizeHint) } /// . - /// Lists the event routes in a digital twins instance by iterating through a collection asynchronously . + /// 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. - /// A pageable set of application/json event routes and the http response. + /// The pageable list of application/json event routes and the http response. /// /// For more samples, see our repo samples. /// @@ -1474,11 +1474,11 @@ async Task> NextPageFunc(string nextLink, int? pageSizeHint) } /// . - /// Lists the event routes in a digital twins instance by iterating through a collection synchronously . + /// 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. - /// A pageable set of application/json event routes and the http response. + /// The pageable list of application/json event routes and the http response. /// /// For more samples, see our repo samples. /// @@ -1526,11 +1526,11 @@ Page NextPageFunc(string nextLink, int? pageSizeHint) } /// - /// Gets an event route by Id asynchronously. After the task completes, the result will be set to . + /// Gets an event route by Id asynchronously. /// /// The Id of the event route. /// The cancellation token. - /// The application/json event routes and the http response. + /// The application/json event routes and the http response . /// /// For more samples, see our repo samples. /// @@ -1546,11 +1546,11 @@ public virtual Task> GetEventRouteAsync(string eventRouteId } /// - /// Gets an event route by Id synchronously. After the task completes, the result will be set to . + /// Gets an event route by Id synchronously. /// /// The Id of the event route. /// The cancellation token. - /// The application/json event routes and the http response. + /// The application/json event routes and the http response . /// /// For more samples, see our repo samples. /// @@ -1569,12 +1569,12 @@ public virtual Response GetEventRoute(string eventRouteId, Cancellat } /// - /// Creates an event route asynchronously. After the task completes, the result will be set to . + /// Creates an event route asynchronously. /// /// The Id of the event route to create. /// The event route data containing the endpoint and optional filter. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -1601,12 +1601,12 @@ public virtual Task CreateEventRouteAsync(string eventRouteId, EventRo } /// - /// Creates an event route synchronously. After the task completes, the result will be set to . + /// Creates an event route synchronously. /// /// The Id of the event route to create. /// The event route data containing the endpoint and optional filter. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -1625,11 +1625,11 @@ public virtual Response CreateEventRoute(string eventRouteId, EventRoute eventRo } /// - /// Deletes an event route asynchronously. After the task completes, the result will be set to . + /// Deletes an event route asynchronously. /// /// The Id of the event route to delete. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -1650,11 +1650,11 @@ public virtual Task DeleteEventRouteAsync(string eventRouteId, Cancell } /// - /// Deletes an event route synchronously. After the task completes, the result will be set to . + /// Deletes an event route synchronously. /// /// The Id of the event route to delete. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -1673,7 +1673,7 @@ public virtual Response DeleteEventRoute(string eventRouteId, CancellationToken } /// - /// Publishes telemetry from a digital twin asynchronously. After the task completes, the result will be set to . + /// Publishes telemetry from a digital twin asynchronously. /// 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. /// @@ -1681,7 +1681,7 @@ public virtual Response DeleteEventRoute(string eventRouteId, CancellationToken /// The application/json telemetry payload to be sent. /// The additional information to be used when processing a telemetry request. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -1708,7 +1708,7 @@ public virtual Task PublishTelemetryAsync(string digitalTwinId, string } /// - /// Publishes telemetry from a digital twin synchronously. After the task completes, the result will be set to . + /// Publishes telemetry from a digital twin synchronously. /// 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. /// @@ -1716,7 +1716,7 @@ public virtual Task PublishTelemetryAsync(string digitalTwinId, string /// The application/json telemetry payload to be sent. /// The additional information to be used when processing a telemetry request. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -1738,7 +1738,7 @@ public virtual Response PublishTelemetry(string digitalTwinId, string payload, T } /// - /// Publishes telemetry from a digital twin's component asynchronously. After the task completes, the result will be set to . + /// Publishes telemetry from a digital twin's component asynchronously. /// 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. /// @@ -1747,7 +1747,7 @@ public virtual Response PublishTelemetry(string digitalTwinId, string payload, T /// The application/json telemetry payload to be sent. /// The additional information to be used when processing a telemetry request. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. /// @@ -1781,7 +1781,7 @@ public virtual Task PublishComponentTelemetryAsync(string digitalTwinI } /// - /// Publishes telemetry from a digital twin's component synchronously. After the task completes, the result will be set to . + /// Publishes telemetry from a digital twin's component synchronously. /// 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. /// @@ -1790,7 +1790,7 @@ public virtual Task PublishComponentTelemetryAsync(string digitalTwinI /// The application/json telemetry payload to be sent. /// The additional information to be used when processing a telemetry request. /// The cancellation token. - /// The http response. + /// The http response . /// /// For more samples, see our repo samples. ///