API versions of Management REST APIs

This article lists the current and past versions of the Management REST APIs for Azure Cognitive Search.

Stable versions

API version Specification API updates
2020-08-01 (Latest) Swagger specification Release note
2020-03-13 Swagger specification Release note
2015-08-19 Swagger specification Release note

Preview versions

Preview versions are released to test new functionality, gather feedback, and discover and fix issues. Preview APIs are available under Supplemental Terms of Use, and are not recommended for production workloads.

API version Specification API updates
2021-04-01-Preview (Latest) Swagger specification Release note
2020-08-01-Preview Swagger specification Release note
2019-10-01-Preview Swagger specification Release note

Release notes

2021-04-01-Preview

This preview API has all of the features of the previous preview API, and adds the following functionality:

  • Enable or disable Azure role-based access (Azure RBAC), currently in public preview. In addition to the original key-based authentication, you can now use Azure Active Directory (Azure AD) authentication and Azure RBAC authorization for data plane operations. In this preview management REST API, use Create or Update Services to enabled or disable RBAC.

  • Enable or disable semantic search. Semantic search is a premium feature that runs on Standard tier services. In this preview management REST API, use Create or Update Services to disable semantic search at the service level to prohibit any query that invokes semantic ranking. You can also enable this feature on search services on the free tier for a small number of free queries.

  • Enforce encryption of data plane resources via Customer Managed Keys (CMK). Use Create or Update Services to configure this option. Existing search services that don't meet this requirement will be marked as non-compliant.

  • Disable workloads that push data from Azure Cognitive Search to external resources. Use Create or Update Services to set properties.disabledDataExfiltrationOptions to "All" or null (default). Disabling all workloads turns off the following capabilities:

2020-08-01-Preview

This preview API is equivalent to the generally available version 2020-08-01, and and adds the following functionality:

  • Added sharedPrivateLinkResources support for two new resource types. New groupId values include mysqlServer (Azure database for MySQL) and sites (Azure Functions/app services).

2020-08-01

This generally available version added Shared Private Link Resources support for all outbound-accessed resources except those noted in the preview version

2020-03-13

This generally available version added support for Private Endpoint Connections through Azure Private Link, and network IP rules for new services.

2019-10-01-Preview

This is the first preview version. There were no preview features introduced in this list. This preview is functionally equivalent to 2020-03-13. It remains available. Any script or code that calls that version will work, but we recommend customers to update to using a more recent API version (either a Generally available or preview API version) to get the same results.

2015-08-19

This is the initial release of the Management REST API. It provided APIs for service creation and deletion, provisioning replicas and partitions, and managing API keys.

See also