Skip to content

Commit 0d2996a

Browse files
authored
[TSI] Refactor main and sample readme (Azure#21432)
1 parent 476e7e8 commit 0d2996a

File tree

3 files changed

+17
-39
lines changed

3 files changed

+17
-39
lines changed

sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# Azure IoT Time Series Insights client library for .NET
1+
# Azure Time Series Insights client library for .NET
22

3-
This library provides access to the Azure Time Series Insights service.
3+
Azure Time Series Insights provides data exploration and telemetry tools to help you improve operational analysis. It's a fully managed analytics, storage, and visualization service where you can explore and analyze billions of Internet of Things (IoT) events simultaneously.
44

5-
[Source code](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/timeseriesinsights)
5+
Azure Time Series Insights gives you a global view of your data, so you can quickly validate your IoT solution and avoid costly downtime to mission-critical devices. It can help you discover hidden trends, spot anomalies, and conduct root-cause analysis in near real time.
6+
7+
If you are new to Azure Time Series Insights and would like to learn more about the platform, please make sure you check out the Azure Time Series Insights official [documentation page][tsi_product_documentation].
68

79
## Getting started
810

@@ -25,13 +27,14 @@ In order to interact with the Azure Time Series Insights service, you will need
2527

2628
## Key concepts
2729

28-
The main concepts of Time Series Insights client include:
30+
The Time Series Insights client library for .NET provides the following functionality:
31+
- Retrieving and being able to make changes to the Time Series Insights environment model settings, such as changing the model name or default type ID.
32+
- Retrieving and being able to add, update and remove Time Series instances.
33+
- Retrieving and being able to make changes to the Time Series Insights environment types, such as creating, updating and deleting Time Series types.
34+
- Retrieving and being able to make changes to the Time Series Insights hierarchies, such as creating, updating and deleting Time Series hierarchies.
35+
- Querying raw events, computed series and aggregate series.
2936

30-
- Instances client: To perform operations such as creating, listing, replacing and deleting Time Series instances.
31-
- Types client: To perform operations such as creating, listing, replacing and deleting Time Series types.
32-
- Hierarchies client: To perform operations such as creating, listing, replacing and deleting Time Series hierarchies.
33-
- Model Settings client: To perform operations such as getting and updating Time Series Model configuration settings.
34-
- Query client: To query for events, series and aggregate series on Time Series Insights.
37+
[Source Code][tsi_client_src] | [Package (NuGet)][tsi_nuget] | [Product documentation][tsi_product_documentation] | [Samples][tsi_samples]
3538

3639
### Thread safety
3740
We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that reusing client instances is always safe, even across threads.
@@ -49,7 +52,7 @@ We guarantee that all client instance methods are thread-safe and independent of
4952

5053
## Examples
5154

52-
You can familiarize yourself with different APIs using [samples for Time Series Insights](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/samples).
55+
You can familiarize yourself with different APIs using [samples for Time Series Insights][tsi_samples].
5356

5457
## Source code folder structure
5558

@@ -146,3 +149,6 @@ For more information see the Code of Conduct FAQ or contact opencode@microsoft.c
146149
[iot_cli_doc]: https://docs.microsoft.com/cli/azure/ext/azure-iot/dt?view=azure-cli-latest
147150
[http_status_code]: https://docs.microsoft.com/dotnet/api/system.net.httpstatuscode?view=netcore-3.1
148151
[tsi_nuget]: https://www.nuget.org/packages/Azure.IoT.TimeSeriesInsights
152+
[tsi_client_src]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/src
153+
[tsi_product_documentation]: https://docs.microsoft.com/azure/time-series-insights/
154+
[tsi_samples]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/samples/Readme.md

sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/samples/Readme.md

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,5 @@
11
# Introduction
22

3-
Azure Time Series Insights provides data exploration and telemetry tools to help you improve operational analysis. It's a fully managed analytics, storage, and visualization service where you can explore and analyze billions of Internet of Things (IoT) events simultaneously.
4-
5-
Azure Time Series Insights gives you a global view of your data, so you can quickly validate your IoT solution and avoid costly downtime to mission-critical devices. It can help you discover hidden trends, spot anomalies, and conduct root-cause analysis in near real time.
6-
7-
If you are new to Azure Time Series Insights and would like to learn more about the platform, please make sure you check out the Azure Time Series Insights official [documentation page][tsi_product_documentation].
8-
9-
# Time Series Insights client library for .NET
10-
The Time Series Insights client library for .NET provides the following functionality:
11-
- Retrieving and being able to make changes to the Time Series Insights environment model settings, such as changing the model name or default type ID.
12-
- Retrieving and being able to add, update and remove Time Series instances.
13-
- Retrieving and being able to make changes to the Time Series Insights environment types, such as creating, updating and deleting Time Series types.
14-
- Retrieving and being able to make changes to the Time Series Insights hierarchies, such as creating, updating and deleting Time Series hierarchies.
15-
- Querying raw events, computed series and aggregate series
16-
17-
[Source Code][tsi_client_src] | [Package (NuGet)][tsi_nuget_package] | [Product documentation][tsi_product_documentation] | [Samples][tsi_samples]
18-
19-
# Key concepts
20-
21-
## TimeSeriesInsightsClient
22-
233
A `TimeSeriesInsightsClient` is the primary interface for developers using the Time Series Insights client library. It provides both synchronous and asynchronous operations to perform operations on a Time Series Insights environment. The `TimeSeriesInsightsClient` exposes several properties that a developer will use to perform specific operations on a Time Series Insights environment. For example, `ModelSettings` is the property that a developer can use to perform operations on the model settings of the TSI environment. `Instances` can be used to perform operations on TSI instances. Other properties include `Types`, `Hierarchies` and `Query`.
244

255
## Creating TimeSeriesInsightsClient
@@ -62,7 +42,7 @@ A single Time Series ID value is composed of up to 3 string values that uniquely
6242
var instanceId = new TimeSeriesId("Millennium", "Floor2", "2A01");
6343
```
6444

65-
> **Please note that this sample is set up to work best when the Time Series Insights ID key that is configured with your environment is not one of the default telemetry system properties, such as iothub-connection-device-id. The reason being is that this sample will generate random unique strings for each TSI ID key that you have set up for your TSI environment, and use these randomly generated strings when sending telemetry to IoT Hub. But since the iothub-connection-device-id is already a random identifier for a device, setting up your TSI environment with ID key as iothub-connection-device-id will not make the sample run as expected. For this sample to mimic a more realistic TSI environment, use Building, Floor and Room as properties for your Time Series Insights IDs.**
45+
> **Please note that this sample is set up to work best when the Time Series Insights ID key that is configured with your environment is not one of the default telemetry system properties, such as iothub-connection-device-id. The reason being is that this sample will generate random unique strings for each TSI ID key that you have set up for your TSI environment, and use these randomly generated strings when sending telemetry to IoT Hub. But since the iothub-connection-device-id is already a random identifier for a device, setting up your TSI environment with ID key as iothub-connection-device-id will not make the sample run as expected since TSI will create an instance per device. For this sample to mimic a more realistic TSI environment, use Building, Floor and Room as properties for your Time Series Insights IDs.**
6646
6747
## Time Series Insights Model Settings
6848

@@ -706,10 +686,6 @@ await foreach (TimeSeriesPoint point in query.GetResultsAsync())
706686
```
707687

708688
<!-- LINKS -->
709-
[tsi_client_src]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/src
710-
[tsi_nuget_package]: https://www.bing.com
711-
[tsi_product_documentation]: https://docs.microsoft.com/azure/time-series-insights/
712-
[tsi_samples]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/samples/Readme.md
713689
[DefaultAzureCredential]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/identity/Azure.Identity/README.md
714690
[tsi_instances_learn_more]: https://docs.microsoft.com/azure/time-series-insights/concepts-model-overview#time-series-model-instances
715691
[tsi_id_learn_more]: https://docs.microsoft.com/azure/time-series-insights/how-to-select-tsid

sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/samples/TimeSeriesInsightsClientSample/QuerySamples.cs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@
44
using System;
55
using System.Collections.Generic;
66
using System.Linq;
7-
using System.Text;
8-
using System.Text.Json;
9-
using System.Threading;
107
using System.Threading.Tasks;
11-
using Microsoft.Azure.Devices.Client;
128
using static Azure.IoT.TimeSeriesInsights.Samples.SampleLogger;
139

1410
namespace Azure.IoT.TimeSeriesInsights.Samples

0 commit comments

Comments
 (0)