Skip to content

Commit aea7421

Browse files
Add migration guide in search (Azure#18008)
* Add migration guide in search The important link in the guide is to the Azure search upgrade doc * Remove the lang part of the link
1 parent c14fc0f commit aea7421

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Migrate from Microsoft.Azure.Search to Azure.Search.Documents
2+
3+
This guide is intended to assist in the migration to version 11 of the Azure Cognitive Search client library [`Azure.Search.Documents`](https://www.nuget.org/packages/Azure.Search.Documents/) from version 10 of [`Microsoft.Azure.Search`](https://www.nuget.org/packages/Microsoft.Azure.Search/).
4+
5+
To learn more about the Azure Cognitive Search client library for .NET, please refer to the [`Azure.Search.Documents` README](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/search/README.md) and [`Azure.Search.Documents` samples](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/search/Azure.Search.Documents/samples) for the `Azure.Search.Documents` library.
6+
7+
## Migration Guide
8+
Details about the migration can be found in the [upgrade document](https://docs.microsoft.com/azure/search/search-dotnet-sdk-migration-version-11). It describes the API differences, code changes involved in the upgrade and the breaking changes.
9+
10+
## Migration benefits
11+
12+
A natural question to ask when considering whether or not to adopt a new version or library is what the benefits of doing so would be. As Azure has matured and been embraced by a more diverse group of developers, we have been focused on learning the patterns and practices to best support developer productivity and to understand the gaps that the .NET client libraries have.
13+
14+
There were several areas of consistent feedback expressed across the Azure client library ecosystem. One of the most important is that the client libraries for different Azure services have not had a consistent approach to organization, naming, and API structure. Additionally, many developers have felt that the learning curve was difficult, and the APIs did not offer a good, approachable, and consistent onboarding story for those learning Azure or exploring a specific Azure service.
15+
16+
To try and improve the development experience across Azure services, including Cognitive Search, a set of uniform [design guidelines](https://azure.github.io/azure-sdk/general_introduction.html) was created for all languages to drive a consistent experience with established API patterns for all services. A set of [.NET-specific guidelines](https://azure.github.io/azure-sdk/dotnet_introduction.html) was also introduced to ensure that .NET clients have a natural and idiomatic feel that mirrors that of the .NET base class libraries. Further details are available in the guidelines for those interested.

0 commit comments

Comments
 (0)