Search results provided by Azure Search - read how I built it in this post.
Max Melcher

3 minute read

Today I released my first Open Source tool to support the development, testing, debugging of **Azure Search **- the AzureSearchTool.

AzureSearchTool - v.

The tool lets you connect to different indexes and assists you crafting search queries.

As a byproduct it generates a REST URL for you to use in your application or website.

With this it should be easier to develop against the Azure Search REST API - and should speed up the testing time enormously. When I started fiddling with the Azure Search API I was not aware what query options I have and how they play together (even tho the documentation is quite good!).

Download is free of charge: here


In this very early release the tool covers the following areas:

Security / Access

Provide your Azure Search Service and your API Key (currently only Admin or Secondary) work. After connecting the tool will resolve all available indexes.

The tool from now then takes care of the api-key header.


As of now, the tool will show you all available indexes. The schema / fields and types will be visible soon in the “Index” tab. If you want to change the index after you selected one, click in the menu on “Connection” and then on “Index”.

In the Search section of the tool you have the option to craft queries and test them against the selected index. The tool supports you to create a query that uses the important options with an easy interface (try that with Postman - not as convenient, right?).


By now $top, $skip, $filter and api-version are implemented - the rest of the options will follow soon. Maybe I add validation and some examples, too.

Once you have changed the parameters, the URL in the top will be changed so that you can use it in your application.


You need the raw JSON data that is returned by Azure Search? You want it pretty? Click on “Raw” to get the results as it is returned by Azure Search.


As you can see not all options are implemented - I released it early to get early feedback. In the near future I will implement the Search view and all the nice options you have there. Then I will add Suggestions and Facets - because they rock.

Lastly I will develop a nice view where you can upload test data according to the schema of the selected index. Maybe, but right now I doubt it, I will add support of Index operations to create and update an index - but the Azure Portal does that pretty well and the code operations are not too complex - but well, lets see.

Scoring Profiles? Index Statistics - they are on the list, too.


So you read until down here? If so, I would be happy to get some feedback from you. Something does not work? Something missing?

comments powered by Disqus