|
| 1 | +# Azure FarmBeats client library for .NET |
| 2 | + |
| 3 | +Azure FarmBeats is a business-to-business offering available in Azure Marketplace. It enables aggregation of agriculture data sets across providers. Azure FarmBeats enables you to build artificial intelligence (AI) or machine learning (ML) models based on fused data sets. By using Azure FarmBeats, agriculture businesses can focus on core value-adds instead of the undifferentiated heavy lifting of data engineering. |
| 4 | +**Please rely heavily on the [service's documentation][catalog_product_documentation] and our [protocol client docs][protocol_client_quickstart] to use this library** |
| 5 | + |
| 6 | +[Source code][source_code] | [Package (NuGet)][client_nuget_package] | [Product documentation][product_documentation] |
| 7 | + |
| 8 | +## Getting started |
| 9 | + |
| 10 | +### Install the package |
| 11 | + |
| 12 | +Install the Azure FarmBeats client library for .NET with [NuGet][client_nuget_package]: |
| 13 | + |
| 14 | +``` |
| 15 | +dotnet add package Azure.Verticals.AgriFood.Farming --prerelease |
| 16 | +``` |
| 17 | + |
| 18 | +### Prerequisites |
| 19 | + |
| 20 | +- You must have an [Azure subscription][azure_subscription] and a Farmbeats resource to use this package. |
| 21 | + |
| 22 | +### Authenticate the client |
| 23 | + |
| 24 | +#### Using Azure Active Directory |
| 25 | + |
| 26 | +This document demonstrates using [DefaultAzureCredential][default_cred_ref] to authenticate via Azure Active Directory. However, any of the credentials offered by the [Azure.Identity][azure_identity] will be accepted. See the [Azure.Identity][azure_identity] documentation for more information about other credentials. |
| 27 | + |
| 28 | +Once you have chosen and configured your credential, you can create instances of any client types, for example, `FarmClient`. |
| 29 | + |
| 30 | +```C# |
| 31 | +var credential = new DefaultAzureCredential(); |
| 32 | +var client = new FarmClient(new Url("https://<my-account-name>.farmbeats.azure.net"), credential); |
| 33 | +``` |
| 34 | + |
| 35 | +## Key concepts |
| 36 | + |
| 37 | +### Protocol Methods |
| 38 | + |
| 39 | +Operations exposed by the FarmBeats SDK for .NET use *protocol methods* to expose the underlying REST operations. You can learn more about how to use SDK Clients which use protocol methods in our [documentation][protocol_client_quickstart]. |
| 40 | + |
| 41 | +### Thread safety |
| 42 | + |
| 43 | +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 the recommendation of reusing client instances is always safe, even across threads. |
| 44 | + |
| 45 | +### Additional concepts |
| 46 | +<!-- CLIENT COMMON BAR --> |
| 47 | +[Client options](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) | |
| 48 | +[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) | |
| 49 | +[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) | |
| 50 | +[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) | |
| 51 | +[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md) | |
| 52 | +[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#mocking) | |
| 53 | +[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/) |
| 54 | +<!-- CLIENT COMMON BAR --> |
| 55 | + |
| 56 | +## Examples |
| 57 | + |
| 58 | +The following section shows you how to initialize and authenticate your client, then list all of your data sources. |
| 59 | + |
| 60 | +### List All Farmers |
| 61 | + |
| 62 | +```C# |
| 63 | +var credential = new DefaultAzureCredential(); |
| 64 | +var client = new FamersClient(new Uri("https://<my-account-name>.farmbeats.azure.net"), credential); |
| 65 | + |
| 66 | +var response = await client.ListAsync(); |
| 67 | +var responseDocument = JsonDocument.Parse(response.Content); |
| 68 | +Console.WriteLine(responseDocument.RootElement.GetProperty("value")); |
| 69 | +``` |
| 70 | + |
| 71 | +## Troubleshooting |
| 72 | + |
| 73 | +### Setting up console logging |
| 74 | +The simplest way to see the logs is to enable the console logging. |
| 75 | +To create an Azure SDK log listener that outputs messages to console use AzureEventSourceListener.CreateConsoleLogger method. |
| 76 | + |
| 77 | +```C# |
| 78 | +// Setup a listener to monitor logged events. |
| 79 | +using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(); |
| 80 | +``` |
| 81 | + |
| 82 | +To learn more about other logging mechanisms see [here][azure_core_diagnostics]. |
| 83 | + |
| 84 | +## Next steps |
| 85 | + |
| 86 | +This client SDK exposes operations using *protocol methods*, you can learn more about how to use SDK Clients which use protocol methods in our [documentation][protocol_client_quickstart]. |
| 87 | + |
| 88 | +## Contributing |
| 89 | + |
| 90 | +See the [CONTRIBUTING.md][contributing] for details on building, testing, and contributing to this library. |
| 91 | + |
| 92 | +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 [cla.microsoft.com][cla]. |
| 93 | + |
| 94 | +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. |
| 95 | + |
| 96 | +This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. |
| 97 | + |
| 98 | +<!-- LINKS --> |
| 99 | +[source_code]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/farmbeats/Azure.Verticals.AgriFood.Farming |
| 100 | +[client_nuget_package]: https://www.nuget.org/packages?q=Azure.Verticals.AgriFood.Farming |
| 101 | +[product_documentation]: https://docs.microsoft.com/azure/industry/agriculture/overview-azure-farmbeats |
| 102 | +[azure_identity]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/identity/Azure.Identity |
| 103 | +[protocol_client_quickstart]: https://aka.ms/azsdk/net/protocol/quickstart |
| 104 | +[default_cred_ref]: https://docs.microsoft.com/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet |
| 105 | +[azure_subscription]: https://azure.microsoft.com/free/ |
| 106 | +[azure_core_diagnostics]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md |
| 107 | +[cla]: https://cla.microsoft.com |
| 108 | +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ |
| 109 | +[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ |
| 110 | +[coc_contact]: mailto:opencode@microsoft.com |
| 111 | + |
| 112 | + |
0 commit comments