Sign in

v10

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

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

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

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.

keyKind'primary' | 'secondary' required

Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.

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 specified admin key was successfully regenerated. Both admin keys are included in the response, including the newly-regenerated key.

primaryKeystring

The primary admin API key of the Search service.

secondaryKeystring

The secondary admin API key of the Search service.