|
| 1 | +# Azure IoT Models Repository client library for .NET |
| 2 | + |
| 3 | +This library provides functionality for interacting with the [Azure IoT Models Repository][modelsrepository_iot_endpoint]. It also aims to provide a consistent experience working with digital twin model repositories following Azure IoT conventions. |
| 4 | + |
| 5 | +[Source code][source] | Package (nuget) |
| 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 bug fixes. |
| 12 | + |
| 13 | +### Install the package |
| 14 | + |
| 15 | +Install the Azure IoT Models Repository client library for .NET with [NuGet][nuget]: |
| 16 | + |
| 17 | +```PowerShell |
| 18 | +Install-Package Azure.Iot.ModelsRepository |
| 19 | +``` |
| 20 | + |
| 21 | +View the package details at nuget.org. |
| 22 | + |
| 23 | +### Prerequisites |
| 24 | + |
| 25 | +- A models repository following [Azure IoT conventions][modelsrepository_conventions] |
| 26 | + - The models repository can be located on the local filesystem or hosted on a webserver. |
| 27 | + - Azure IoT hosts the global [Azure IoT Models Repository][modelsrepository_iot_endpoint] which the client will point to by default if no URI is provided. |
| 28 | + |
| 29 | +### Authenticate the client |
| 30 | + |
| 31 | +Currently no authentication mechanisms are supported in the client. The global endpoint is not tied to an Azure subscription and does not support auth. All models published are meant for anonymous public consumption. |
| 32 | + |
| 33 | +## Key concepts |
| 34 | + |
| 35 | +The Azure IoT Models Repository enables builders to manage and share digital twin models. The models are [JSON-LD][json_ld_reference] documents defined using the Digital Twins Definition Language ([DTDL][dtdlv2_reference]). |
| 36 | + |
| 37 | +The repository defines a pattern to store DTDL interfaces in a directory structure based on the Digital Twin Model Identifier (DTMI). You can locate an interface in the repository by converting the DTMI to a relative path. For example, the DTMI "`dtmi:com:example:Thermostat;1`" translates to `/dtmi/com/example/thermostat-1.json`. |
| 38 | + |
| 39 | +### Thread safety |
| 40 | + |
| 41 | +We guarantee that all client instance methods are thread-safe and independent of each other. See thread safety [guideline][thread_safety_guideline]. This ensures that the recommendation of reusing client instances is always safe, even across threads. |
| 42 | + |
| 43 | +### Additional concepts |
| 44 | + |
| 45 | +<!-- CLIENT COMMON BAR --> |
| 46 | +[Client options](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) | |
| 47 | +[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) | |
| 48 | +[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) | |
| 49 | +[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) | |
| 50 | +[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md) | |
| 51 | +[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#mocking) | |
| 52 | +[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/) |
| 53 | +<!-- CLIENT COMMON BAR --> |
| 54 | + |
| 55 | +## Examples |
| 56 | + |
| 57 | +You can familiarize yourself with the client using [samples for IoT Models Repository][modelsrepository_samples]. |
| 58 | + |
| 59 | +## Troubleshooting |
| 60 | + |
| 61 | +All service operations will throw RequestFailedException on failure, with helpful error codes and other information. The client also produces diagnostic events and logging which can be listened to with an [EventListener][eventsourcelistener_reference]. |
| 62 | + |
| 63 | +## Next steps |
| 64 | + |
| 65 | +See implementation examples with our [code samples][modelsrepository_samples]. |
| 66 | + |
| 67 | +## Contributing |
| 68 | + |
| 69 | +This project welcomes contributions and suggestions. |
| 70 | +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. |
| 71 | +For details, visit <https://cla.microsoft.com> |
| 72 | + |
| 73 | +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). |
| 74 | +Simply follow the instructions provided by the bot. |
| 75 | +You will only need to do this once across all repos using our CLA. |
| 76 | + |
| 77 | +This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. |
| 78 | +For more information see the [Code of Conduct FAQ ][code_of_conduct_faq] or contact [email protected] with any additional questions or comments. |
| 79 | + |
| 80 | +<!-- LINKS --> |
| 81 | +[microsoft_sdk_download]: https://azure.microsoft.com/downloads/?sdk=net |
| 82 | +[azure_sdk_target_frameworks]: https://github.com/azure/azure-sdk-for-net#target-frameworks |
| 83 | +[source]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/modelsrepository/Azure.Iot.ModelsRepository/src |
| 84 | +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ |
| 85 | +[code_of_conduct_faq]: https://opensource.microsoft.com/codeofconduct/faq/ |
| 86 | +[nuget]: https://www.nuget.org/ |
| 87 | +[azure_core_library]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/core/Azure.Core |
| 88 | +[modelsrepository_conventions]: https://github.com/Azure/iot-plugandplay-models-tools/wiki |
| 89 | +[modelsrepository_iot_endpoint]: https://devicemodels.azure.com/ |
| 90 | +[modelsrepository_samples]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/modelsrepository/Azure.Iot.ModelsRepository/samples |
| 91 | +[thread_safety_guideline]: https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety |
| 92 | +[json_ld_reference]: https://json-ld.org |
| 93 | +[dtdlv2_reference]: https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md |
| 94 | +[eventsourcelistener_reference]: https://docs.microsoft.com/dotnet/api/azure.core.diagnostics.azureeventsourcelistener?view=azure-dotnet |
0 commit comments