|
| 1 | +# Azure IoT Time Series Insights client library for .NET |
| 2 | + |
| 3 | +This library provides access to the Azure Time Series Insights service. |
| 4 | + |
| 5 | + [Source code]<!--(https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/timeseriesinsights)--> |
| 6 | + |
| 7 | +## Getting started |
| 8 | + |
| 9 | +The complete Microsoft Azure SDK can be downloaded from the [Microsoft Azure downloads][microsoft_sdk_download] page, and it ships with support for building deployment packages, integrating with tooling, rich command line tooling, and more. |
| 10 | + |
| 11 | +For the best development experience, developers should use the official Microsoft NuGet packages for libraries. NuGet packages are regularly updated with new functionality and hotfixes. |
| 12 | + |
| 13 | +### Install the package |
| 14 | + |
| 15 | +No package has been published for this client library yet. |
| 16 | + |
| 17 | +### Prerequisites |
| 18 | + |
| 19 | +- A Microsoft Azure Subscription |
| 20 | + - To call Microsoft Azure services, create an [Azure subscription][azure_sub]. |
| 21 | + |
| 22 | +### Authenticate the Client |
| 23 | + |
| 24 | +In order to interact with the Azure Time Series Insights service, you will need to create an instance of a [TokenCredential class][token_credential] and pass it to the constructor of your [TimeSeriesInsightsClient]<!--(https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/timeseriesinsights/Azure.Iot.TimeSeriesInsights/src/TimeSeriesInsightsClient.cs)-->. |
| 25 | + |
| 26 | +## Key concepts |
| 27 | + |
| 28 | +Coming soon. |
| 29 | + |
| 30 | +## Examples |
| 31 | + |
| 32 | +Coming soon. |
| 33 | + |
| 34 | +## Source code folder structure |
| 35 | + |
| 36 | +### /src |
| 37 | + |
| 38 | +The Time Series Insights public client, `TimeSeriesInsightsClient`, and the additional configuration options, `TimeSeriesInsightsClientOptions`, that can be sent to the Time Series Insights service. |
| 39 | + |
| 40 | +### /src/Generated |
| 41 | + |
| 42 | +The code generated by autorest using the swagger file defined in the autorest config file. |
| 43 | + |
| 44 | +To regenerate the code, run the powershell script [generate.ps1]<!--(https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/timeseriesinsights/Azure.Iot.TimeSeriesInsights/src/generate.ps1)-->. |
| 45 | + |
| 46 | +Any time the client library code is updated, the following scripts need to be run: |
| 47 | + |
| 48 | +- [Export-AdtApis.ps1]<!--(https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/timeseriesinsights/Export-AdtApis.ps1)-->, which will update the [API surface document]<!--(https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/timeseriesinsights/Azure.Iot.TimeSeriesInsights/api/Azure.Iot.TimeSeriesInsights.netstandard2.0.cs)-->. |
| 49 | +- [Update-Snippets.ps1]<!--(https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/timeseriesinsights/Update-TsiSnippets.ps1)-->, which will update all the code snippets in the readme files and in the client documentation comments. |
| 50 | + |
| 51 | +### /src/Customized |
| 52 | + |
| 53 | +The customzied code written to override the following behavior of auto-generated code: |
| 54 | + |
| 55 | +- Declare some of the generated types as **internal**, instead of the autorest default of **public**. |
| 56 | + |
| 57 | +### /src/Models |
| 58 | + |
| 59 | +Model classes useful for use with the Time Series Insights client operations. |
| 60 | + |
| 61 | +### /src/Properties |
| 62 | + |
| 63 | +Assembly properties required for running unit tests. |
| 64 | + |
| 65 | +## Troubleshooting |
| 66 | + |
| 67 | +Coming soon. |
| 68 | + |
| 69 | +## Next steps |
| 70 | + |
| 71 | +See implementation examples with our [code samples]<!--(https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/timeseriesinsights/Azure.Iot.TimeSeriesInsights/samples)-->. |
| 72 | + |
| 73 | +## Contributing |
| 74 | + |
| 75 | +This project welcomes contributions and suggestions. |
| 76 | +Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. |
| 77 | +For details, visit <https://cla.microsoft.com.> |
| 78 | + |
| 79 | +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). |
| 80 | +Simply follow the instructions provided by the bot. |
| 81 | +You will only need to do this once across all repos using our CLA. |
| 82 | + |
| 83 | +This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. |
| 84 | +For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments. |
| 85 | + |
| 86 | +<!-- LINKS --> |
| 87 | +[microsoft_sdk_download]: https://azure.microsoft.com/downloads/?sdk=net |
| 88 | +[azure_sdk_target_frameworks]: https://github.com/azure/azure-sdk-for-net#target-frameworks |
| 89 | +[azure_cli]: https://docs.microsoft.com/cli/azure |
| 90 | +[azure_sub]: https://azure.microsoft.com/free/ |
| 91 | +[package]: https://www.nuget.org/packages/Azure.Iot.TimeSeriesInsights |
| 92 | +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ |
| 93 | +[nuget]: https://www.nuget.org/ |
| 94 | +[azure_portal]: https://portal.azure.com/ |
| 95 | +[azure_rest_api]: https://docs.microsoft.com/rest/api/azure/ |
| 96 | +[azure_core_library]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/core/Azure.Core |
| 97 | +[token_credential]: https://docs.microsoft.com/dotnet/api/azure.core.tokencredential?view=azure-dotnet |
| 98 | +[azure_cli]: https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest |
| 99 | +[iot_cli_extension]: https://github.com/Azure/azure-iot-cli-extension/releases |
| 100 | +[iot_cli_doc]: https://docs.microsoft.com/cli/azure/ext/azure-iot/dt?view=azure-cli-latest |
| 101 | +[http_status_code]: https://docs.microsoft.com/dotnet/api/system.net.httpstatuscode?view=netcore-3.1 |
| 102 | +[tsi_nuget]: https://www.nuget.org/packages/Azure.Iot.TimeSeriesInsights |
0 commit comments