pablocastro / vscode-azurecognitivesearch

Azure Cognitive Search extension for VS Code (Preview)

Azure Cognitive Search for Visual Studio Code (Preview)

Azure Cognitive Search is a search-as-a-service cloud solution that gives developers APIs and tools for adding a rich search experience over private, heterogeneous content in web, mobile, and enterprise applications.

This VS Code extension makes it easy to manage your search service with the full capabilities of the REST APIs while providing rich intellisense and snippets to make it easier to take advantage of the full range of capabilities. With the extension, you can create and update indexes and other components, add documents, search, and more. Check out the gifs and images below to see the extension in action.

Features

Browse all of your Azure Cognitive Search services

Create new indexes, indexers, data sources, skillsets and synonym maps

Take advantage of rich intellisense

Edit or delete indexes, indexers, data sources, skillsets and synonym maps

Add or update documents in the search index

Query your search services

Get started

1. Browse for Azure Cognitive Search in Extensions and install it.

2. On View > Command palette, scroll or type Azure: Sign in.

3. After signing in, select the Azure button on the bottom left. You should get the list of installed Azure extensions on the right in extension explorer.

4. Expand Cognitive Search, your subscription, and your search service to access content. You need Contribute permissions or above to access the content.

To filter the subscriptions that show up in the extension's explorer, select Select Subscriptions... button on any subscription node (indicated by a filter icon when you hover over it), or select View > Command palette and search for Azure: Select Subscriptions. Note that the filter will apply to all VS Code extensions that support the Azure Account and Sign-In extension.

If you don't have an Azure Account, you can sign up for one today for free and receive $200 in credits by selecting Create a Free Azure Account..." or selecting View > Command palette and searching for Azure: Create an Account.

To sign out, search for Azure: Sign out in View > Command palette.

Contributing

There are several ways you can contribute to our repo:

• Ideas, feature requests and bugs: We are open to all ideas and we want to get rid of bugs! Use the Issues section to report a new issue, provide your ideas or contribute to existing threads.
• Documentation: Found a typo or strangely worded sentences? Submit a PR!
• Code: Contribute bug fixes, features or design changes:
  • Clone the repository locally and open in VS Code.
  • Open the terminal (press CTRL+`) and run npm install.
  • To build, press F1 and type in Tasks: Run Build Task.
  • Debug: press F5 to start debugging the extension.

Legal

Before we can accept your pull request, you will need to sign a Contribution License Agreement. All you need to do is to submit a pull request, then the PR will get appropriately labelled (e.g. cla-required, cla-norequired, cla-signed, cla-already-signed). If you already signed the agreement, we will proceed with the PR, otherwise the system will tell you how you can sign the CLA. Once you sign the CLA, all future PR's will be labeled as cla-signed.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.

Telemetry

VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more. If you don't wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. Learn more in our FAQ.

License

MIT