From 56c818d89cfd74bae0e16e889d76c976019440e6 Mon Sep 17 00:00:00 2001 From: Azad Abbasi Date: Tue, 2 Jun 2020 14:07:15 -0700 Subject: [PATCH 1/8] Update root readme file --- .../Azure.DigitalTwins.Core/README.md | 57 ++++++++++++++++--- 1 file changed, 48 insertions(+), 9 deletions(-) diff --git a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md index 01761e88e9a2..73ebd4100933 100644 --- a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md +++ b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md @@ -6,26 +6,38 @@ This library provides access to the Azure Digital Twins service for managing twi ## Getting started -### Authenticate the Client +The complete Microsoft Azure SDK can be downloaded from the [Microsoft Azure Downloads][[microsoft_sdk_download]] Page and ships with support for building deployment packages, integrating with tooling, rich command line tooling, and more. -### Install the package +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. + +## Prerequisites + +- Microsoft Azure Subscription: To call Microsoft Azure services, you need to create an [Azure subscription][azure_sub] +- Azure Digital Twin instance: In order to use the Azure Digital Twin SDK, you need to first create a Digital Twin instance using one of many options: + - Using [Azure portal][azure_portal] + - Using [Azure Management APIs][azure_rest_api] + - Using [Azure CLI][azure_cli]: You will need to install azure cli and the [Azure IoT extension][iot_cli_extension] for Azure CLI. Refer to [IoT CLI Documentation][iot_cli_doc] for more information on how to create and interact with your Digital Twin instance. + +## Install the package Install the Azure Digital Twins client library for .NET with [NuGet][nuget]: ```PowerShell Install-Package Azure.DigitalTwins.Core ``` -### Prerequisites -* An [Azure subscription][azure_sub]. +## Authenticate the Client +In order to interact with the Azure Digital Twin service, you will need to create an instance of a [ClientSecretCredential][client_secret_credential] and pass it to the constructor of your [DigitalTwinClient][digital_twin_client]. ## Key concepts +Azure Digital Twins Preview is an Azure IoT service that creates comprehensive models of the physical environment. It can create spatial intelligence graphs to model the relationships and interactions between people, spaces, and devices. -## Examples +You can learn more about Azure Digital Twins by visiting [Azure Digital Twins Documentation][digital_twins_documentation] -## Developer guide +## Examples +You can familiarize yourself with different APIs using [samples for Digital Twin](./samples/). -### Source code folder structure +## Source code folder structure ### /src The digital twins public client `DigitalTwinsClient` and the additional configuration options that can be sent to the digital twins service `DigitalTwinsClientOptions`. @@ -57,8 +69,24 @@ Serialization helpers provided to help serialize/deseralize commonly used types Any time the client library code is updated, you will need to run the script [here](./../Export-AdtApis.ps1), which will update the corresponding API surface. ## Troubleshooting +All Azure Digital Twin service operations will throw a RequestFailedException on failure with helpful ErrorCodes. + +For example, if you use the ```GetModelAsync``` operation and the model you are looking for doesn't exist, you can catch that specific [HttpStatusCode][http_status_code] to decide the operation that follows in that case. +```csharp +try +{ + Response sampleModel = await DigitalTwinsClient.GetModelAsync(sampleModelId).ConfigureAwait(false); +} +catch (RequestFailedException ex) when (ex.Status == (int)HttpStatusCode.NotFound) +{ + // Model does not exist. + // Create the model +} + +``` ## Next steps +Get started with our [Azure Digital Twins samples](./samples) ## Contributing @@ -69,10 +97,21 @@ When you submit a pull request, a CLA-bot will automatically determine whether y This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments. +[microsoft_sdk_download]:https://azure.microsoft.com/en-us/downloads/?sdk=net +[azure_sdk_target_frameworks]: https://github.com/azure/azure-sdk-for-net#target-frameworks [azure_cli]: https://docs.microsoft.com/cli/azure [azure_sub]: https://azure.microsoft.com/free/ -[source]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/iot/adt -[package]: https://www.nuget.org/packages/Azure.IoT.DigitalTwins +[source]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/digitaltwins +[package]: https://www.nuget.org/packages/Azure.DigitalTwins.Core [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ [nuget]: https://www.nuget.org/ +[azure_portal]: https://portal.azure.com/ +[azure_rest_api]: https://docs.microsoft.com/en-us/rest/api/azure/ [azure_core_library]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/core/Azure.Core +[client_secret_credential]: https://docs.microsoft.com/en-us/dotnet/api/azure.identity.clientsecretcredential?view=azure-dotnet +[digital_twin_client]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs +[digital_twins_documentation]: https://docs.microsoft.com/en-us/azure/digital-twins/ +[azure_cli]: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest +[iot_cli_extension]: https://docs.microsoft.com/en-us/azure/iot-pnp/howto-install-pnp-cli#:~:text=The%20Azure%20CLI%20lets%20you,Plug%20and%20Play%20Preview%20devices. +[iot_cli_doc]: https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot?view=azure-cli-latest +[http_status_code]: https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netcore-3.1 \ No newline at end of file From b7930ff3827daf30a5be5264f1f1d1d684c4007e Mon Sep 17 00:00:00 2001 From: Azad Abbasi Date: Tue, 2 Jun 2020 14:10:16 -0700 Subject: [PATCH 2/8] minor casing update --- .../Azure.DigitalTwins.Core/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md index 73ebd4100933..0a94a71398ab 100644 --- a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md +++ b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md @@ -13,7 +13,7 @@ For the best development experience, developers should use the official Microsof ## Prerequisites - Microsoft Azure Subscription: To call Microsoft Azure services, you need to create an [Azure subscription][azure_sub] -- Azure Digital Twin instance: In order to use the Azure Digital Twin SDK, you need to first create a Digital Twin instance using one of many options: +- Azure Digital Twin instance: In order to use the Azure Digital Twins SDK, you need to first create a Digital Twin instance using one of many options: - Using [Azure portal][azure_portal] - Using [Azure Management APIs][azure_rest_api] - Using [Azure CLI][azure_cli]: You will need to install azure cli and the [Azure IoT extension][iot_cli_extension] for Azure CLI. Refer to [IoT CLI Documentation][iot_cli_doc] for more information on how to create and interact with your Digital Twin instance. @@ -27,7 +27,7 @@ Install-Package Azure.DigitalTwins.Core ``` ## Authenticate the Client -In order to interact with the Azure Digital Twin service, you will need to create an instance of a [ClientSecretCredential][client_secret_credential] and pass it to the constructor of your [DigitalTwinClient][digital_twin_client]. +In order to interact with the Azure Digital Twins service, you will need to create an instance of a [ClientSecretCredential][client_secret_credential] and pass it to the constructor of your [DigitalTwinsClient][digital_twins_client]. ## Key concepts Azure Digital Twins Preview is an Azure IoT service that creates comprehensive models of the physical environment. It can create spatial intelligence graphs to model the relationships and interactions between people, spaces, and devices. @@ -35,15 +35,15 @@ Azure Digital Twins Preview is an Azure IoT service that creates comprehensive m You can learn more about Azure Digital Twins by visiting [Azure Digital Twins Documentation][digital_twins_documentation] ## Examples -You can familiarize yourself with different APIs using [samples for Digital Twin](./samples/). +You can familiarize yourself with different APIs using [samples for Digital Twins](./samples/). ## Source code folder structure ### /src -The digital twins public client `DigitalTwinsClient` and the additional configuration options that can be sent to the digital twins service `DigitalTwinsClientOptions`. +The Digital Twins public client `DigitalTwinsClient` and the additional configuration options that can be sent to the Digital Twins service `DigitalTwinsClientOptions`. ### /src/swagger -The swagger file that defines the structure of the REST APIs used by the digital twins client library. +The swagger file that defines the structure of the REST APIs used by the Digital Twins client library. To generate the code, run the powershell script present [here](./src/generate.ps1). @@ -58,18 +58,18 @@ The customzied code written to override the following behavior of auto-generated - Declare some methods to return the response as **strings** instead of **objects**. ### /src/Models -Constants useful for use with the digital twins client. +Constants useful for use with the Digital Twins client. ### /src/Properties Assembly properties required for running unit tests against signed assemblies in Debug mode. ### /src/Serialization -Serialization helpers provided to help serialize/deseralize commonly used types within the digital twins service. +Serialization helpers provided to help serialize/deseralize commonly used types within the Digital Twins service. Any time the client library code is updated, you will need to run the script [here](./../Export-AdtApis.ps1), which will update the corresponding API surface. ## Troubleshooting -All Azure Digital Twin service operations will throw a RequestFailedException on failure with helpful ErrorCodes. +All Azure Digital Twins service operations will throw a RequestFailedException on failure with helpful ErrorCodes. For example, if you use the ```GetModelAsync``` operation and the model you are looking for doesn't exist, you can catch that specific [HttpStatusCode][http_status_code] to decide the operation that follows in that case. ```csharp @@ -109,7 +109,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [azure_rest_api]: https://docs.microsoft.com/en-us/rest/api/azure/ [azure_core_library]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/core/Azure.Core [client_secret_credential]: https://docs.microsoft.com/en-us/dotnet/api/azure.identity.clientsecretcredential?view=azure-dotnet -[digital_twin_client]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs +[digital_twins_client]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs [digital_twins_documentation]: https://docs.microsoft.com/en-us/azure/digital-twins/ [azure_cli]: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest [iot_cli_extension]: https://docs.microsoft.com/en-us/azure/iot-pnp/howto-install-pnp-cli#:~:text=The%20Azure%20CLI%20lets%20you,Plug%20and%20Play%20Preview%20devices. From de20ed43023db2ad91e6dc2260d70a951c0fff53 Mon Sep 17 00:00:00 2001 From: Azad Abbasi Date: Tue, 2 Jun 2020 14:21:59 -0700 Subject: [PATCH 3/8] linter done --- .../Azure.DigitalTwins.Core/README.md | 39 +++++++++++++------ 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md index 0a94a71398ab..8ed3f4420724 100644 --- a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md +++ b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md @@ -1,22 +1,22 @@ # Azure IoT Digital Twin client library for .NET This library provides access to the Azure Digital Twins service for managing twins, models, relationships, etc. - + [Source code][source] | [Package (nuget)][package] ## Getting started -The complete Microsoft Azure SDK can be downloaded from the [Microsoft Azure Downloads][[microsoft_sdk_download]] Page and ships with support for building deployment packages, integrating with tooling, rich command line tooling, and more. +The complete Microsoft Azure SDK can be downloaded from the [Microsoft Azure Downloads][microsoft_sdk_download] Page and ships with support for building deployment packages, integrating with tooling, rich command line tooling, and more. 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. ## Prerequisites -- Microsoft Azure Subscription: To call Microsoft Azure services, you need to create an [Azure subscription][azure_sub] +- Microsoft Azure Subscription: To call Microsoft Azure services, you need to create an [Azure subscription][azure_sub] - Azure Digital Twin instance: In order to use the Azure Digital Twins SDK, you need to first create a Digital Twin instance using one of many options: - - Using [Azure portal][azure_portal] + - Using [Azure portal][azure_portal] - Using [Azure Management APIs][azure_rest_api] - - Using [Azure CLI][azure_cli]: You will need to install azure cli and the [Azure IoT extension][iot_cli_extension] for Azure CLI. Refer to [IoT CLI Documentation][iot_cli_doc] for more information on how to create and interact with your Digital Twin instance. + - Using [Azure CLI][azure_cli]: You will need to install azure cli and the [Azure IoT extension][iot_cli_extension] for Azure CLI. Refer to [IoT CLI Documentation][iot_cli_doc] for more information on how to create and interact with your Digital Twin instance. ## Install the package @@ -27,51 +27,67 @@ Install-Package Azure.DigitalTwins.Core ``` ## Authenticate the Client -In order to interact with the Azure Digital Twins service, you will need to create an instance of a [ClientSecretCredential][client_secret_credential] and pass it to the constructor of your [DigitalTwinsClient][digital_twins_client]. + +In order to interact with the Azure Digital Twins service, you will need to create an instance of a [TokenCredential class][token_credential] and pass it to the constructor of your [DigitalTwinsClient][digital_twins_client]. ## Key concepts + Azure Digital Twins Preview is an Azure IoT service that creates comprehensive models of the physical environment. It can create spatial intelligence graphs to model the relationships and interactions between people, spaces, and devices. You can learn more about Azure Digital Twins by visiting [Azure Digital Twins Documentation][digital_twins_documentation] ## Examples -You can familiarize yourself with different APIs using [samples for Digital Twins](./samples/). + +You can familiarize yourself with different APIs using [samples for Digital Twins](./samples/). ## Source code folder structure ### /src + The Digital Twins public client `DigitalTwinsClient` and the additional configuration options that can be sent to the Digital Twins service `DigitalTwinsClientOptions`. ### /src/swagger + The swagger file that defines the structure of the REST APIs used by the Digital Twins client library. To generate the code, run the powershell script present [here](./src/generate.ps1). ### /src/Generated -The code generated by autorest using the swagger file defined under /src/swagger. + +The code generated by autorest using the swagger file defined under /src/swagger. ### /src/Customized + The customzied code written to override the following behavior of auto-generated code: + - Rename some of the generated types, eg. [GetModelsOptions](./src/Customized/Models/GetModelsOptions.cs) - Declare some of the generated types as **internal**, instead of the autorest default of **public**. - Declare some methods to accept input parameters as **strings** instead of **objects**. - Declare some methods to return the response as **strings** instead of **objects**. ### /src/Models + Constants useful for use with the Digital Twins client. ### /src/Properties + Assembly properties required for running unit tests against signed assemblies in Debug mode. ### /src/Serialization + Serialization helpers provided to help serialize/deseralize commonly used types within the Digital Twins service. -Any time the client library code is updated, you will need to run the script [here](./../Export-AdtApis.ps1), which will update the corresponding API surface. +Any time the client library code is updated, you will need to run the following scripts + +- [Export-AdtApis](./../Export-AdtApis.ps1), which will update the corresponding API surface. +- [Ipdate-Snippents](./../Update-AdtSnippets.ps1), which will update all the code snippets in the readme files. ## Troubleshooting + All Azure Digital Twins service operations will throw a RequestFailedException on failure with helpful ErrorCodes. -For example, if you use the ```GetModelAsync``` operation and the model you are looking for doesn't exist, you can catch that specific [HttpStatusCode][http_status_code] to decide the operation that follows in that case. +For example, if you use the `GetModelAsync` operation and the model you are looking for doesn't exist, you can catch that specific [HttpStatusCode][http_status_code] to decide the operation that follows in that case. + ```csharp try { @@ -86,6 +102,7 @@ catch (RequestFailedException ex) when (ex.Status == (int)HttpStatusCode.NotFoun ``` ## Next steps + Get started with our [Azure Digital Twins samples](./samples) ## Contributing @@ -108,7 +125,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [azure_portal]: https://portal.azure.com/ [azure_rest_api]: https://docs.microsoft.com/en-us/rest/api/azure/ [azure_core_library]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/core/Azure.Core -[client_secret_credential]: https://docs.microsoft.com/en-us/dotnet/api/azure.identity.clientsecretcredential?view=azure-dotnet +[token_credential]: https://docs.microsoft.com/en-us/dotnet/api/azure.core.tokencredential?view=azure-dotnet [digital_twins_client]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs [digital_twins_documentation]: https://docs.microsoft.com/en-us/azure/digital-twins/ [azure_cli]: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest From 3b336b8f2e97454ace540b0994e6d3935b7398b3 Mon Sep 17 00:00:00 2001 From: Azad Abbasi Date: Tue, 2 Jun 2020 14:23:48 -0700 Subject: [PATCH 4/8] fix link --- sdk/digitaltwins/Azure.DigitalTwins.Core/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md index 8ed3f4420724..f27017c0c029 100644 --- a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md +++ b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md @@ -107,14 +107,14 @@ Get started with our [Azure Digital Twins samples](./samples) ## Contributing -This project welcomes contributions and suggestions. 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. For details, visit https://cla.microsoft.com. +This project welcomes contributions and suggestions. 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. For details, visit 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). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments. -[microsoft_sdk_download]:https://azure.microsoft.com/en-us/downloads/?sdk=net +[microsoft_sdk_download]: https://azure.microsoft.com/en-us/downloads/?sdk=net [azure_sdk_target_frameworks]: https://github.com/azure/azure-sdk-for-net#target-frameworks [azure_cli]: https://docs.microsoft.com/cli/azure [azure_sub]: https://azure.microsoft.com/free/ From 8fe8515f6f3606760565be0b8f053e42b77c185c Mon Sep 17 00:00:00 2001 From: Azad Abbasi Date: Tue, 2 Jun 2020 14:24:22 -0700 Subject: [PATCH 5/8] one final lint warning --- sdk/digitaltwins/Azure.DigitalTwins.Core/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md index f27017c0c029..b7cf6dce343b 100644 --- a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md +++ b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md @@ -131,4 +131,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [azure_cli]: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest [iot_cli_extension]: https://docs.microsoft.com/en-us/azure/iot-pnp/howto-install-pnp-cli#:~:text=The%20Azure%20CLI%20lets%20you,Plug%20and%20Play%20Preview%20devices. [iot_cli_doc]: https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot?view=azure-cli-latest -[http_status_code]: https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netcore-3.1 \ No newline at end of file +[http_status_code]: https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netcore-3.1 From 8ecce3292095f54e49ed8b8dd9962451789f504c Mon Sep 17 00:00:00 2001 From: Azad Abbasi Date: Tue, 2 Jun 2020 14:26:31 -0700 Subject: [PATCH 6/8] digital twinSSSSS --- sdk/digitaltwins/Azure.DigitalTwins.Core/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md index b7cf6dce343b..f89c2920bde8 100644 --- a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md +++ b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md @@ -13,10 +13,10 @@ For the best development experience, developers should use the official Microsof ## Prerequisites - Microsoft Azure Subscription: To call Microsoft Azure services, you need to create an [Azure subscription][azure_sub] -- Azure Digital Twin instance: In order to use the Azure Digital Twins SDK, you need to first create a Digital Twin instance using one of many options: +- Azure Digital Twins instance: In order to use the Azure Digital Twins SDK, you need to first create a Digital Twins instance using one of many options: - Using [Azure portal][azure_portal] - Using [Azure Management APIs][azure_rest_api] - - Using [Azure CLI][azure_cli]: You will need to install azure cli and the [Azure IoT extension][iot_cli_extension] for Azure CLI. Refer to [IoT CLI Documentation][iot_cli_doc] for more information on how to create and interact with your Digital Twin instance. + - Using [Azure CLI][azure_cli]: You will need to install azure cli and the [Azure IoT extension][iot_cli_extension] for Azure CLI. Refer to [IoT CLI Documentation][iot_cli_doc] for more information on how to create and interact with your Digital Twins instance. ## Install the package From a6faf8ecab95096a9b5f4eee988ee9f00c2c5295 Mon Sep 17 00:00:00 2001 From: Azad Abbasi Date: Tue, 2 Jun 2020 15:49:02 -0700 Subject: [PATCH 7/8] address commments --- sdk/digitaltwins/Azure.DigitalTwins.Core/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md index f89c2920bde8..2622f6cef7eb 100644 --- a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md +++ b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md @@ -1,4 +1,4 @@ -# Azure IoT Digital Twin client library for .NET +# Azure IoT Digital Twins client library for .NET This library provides access to the Azure Digital Twins service for managing twins, models, relationships, etc. @@ -75,7 +75,7 @@ Assembly properties required for running unit tests against signed assemblies in ### /src/Serialization -Serialization helpers provided to help serialize/deseralize commonly used types within the Digital Twins service. +Serialization helpers provided to help serialize/deserialize commonly used types within the Digital Twins service. Any time the client library code is updated, you will need to run the following scripts From e8688c92265eb724f62bf1edb9dcd058ded60550 Mon Sep 17 00:00:00 2001 From: Azad Abbasi Date: Tue, 2 Jun 2020 15:50:03 -0700 Subject: [PATCH 8/8] Fix analyze in ci --- sdk/digitaltwins/Azure.DigitalTwins.Core/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md index 2622f6cef7eb..19549d2a28e7 100644 --- a/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md +++ b/sdk/digitaltwins/Azure.DigitalTwins.Core/README.md @@ -10,7 +10,7 @@ The complete Microsoft Azure SDK can be downloaded from the [Microsoft Azure Dow 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. -## Prerequisites +### Prerequisites - Microsoft Azure Subscription: To call Microsoft Azure services, you need to create an [Azure subscription][azure_sub] - Azure Digital Twins instance: In order to use the Azure Digital Twins SDK, you need to first create a Digital Twins instance using one of many options: @@ -18,7 +18,7 @@ For the best development experience, developers should use the official Microsof - Using [Azure Management APIs][azure_rest_api] - Using [Azure CLI][azure_cli]: You will need to install azure cli and the [Azure IoT extension][iot_cli_extension] for Azure CLI. Refer to [IoT CLI Documentation][iot_cli_doc] for more information on how to create and interact with your Digital Twins instance. -## Install the package +### Install the package Install the Azure Digital Twins client library for .NET with [NuGet][nuget]: @@ -26,7 +26,7 @@ Install the Azure Digital Twins client library for .NET with [NuGet][nuget]: Install-Package Azure.DigitalTwins.Core ``` -## Authenticate the Client +### Authenticate the Client In order to interact with the Azure Digital Twins service, you will need to create an instance of a [TokenCredential class][token_credential] and pass it to the constructor of your [DigitalTwinsClient][digital_twins_client].