Sign in

v10

latestSwagger 2.0raw.githubusercontent.com2021-02-05141544.2 KB
QueryKeys

Generates a new query key for the specified Search service. You can create up to 50 query keys per service.

post/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}

Path parameters

resourceGroupNamestring required

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

searchServiceNamestring required

The name of the Azure Cognitive Search service associated with the specified resource group.

namestring required

The name of the new query API key.

subscriptionIdstring required

The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.

Query parameters

api-versionstring required

The API version to use for each request. The current version is 2015-08-19.

Headers

x-ms-client-request-idstring uuid

A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Response

The query key was successfully created and is in the response. You can use the query key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.

namestring

The name of the query API key; may be empty.

keystring

The value of the query API key.