v10

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

Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.

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

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.

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 admin keys were successfully retrieved and are in the response. You can use either the primary or secondary key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform any operations on your Search service, including privileged operations. Privileged operations include managing resources like indexes and data sources as well as uploading, modifying, or deleting data in your indexes.

primaryKeystring

The primary admin API key of the Search service.

secondaryKeystring

The secondary admin API key of the Search service.