AdminKeys interface

Package:

@azure/arm-search

Interface representing a AdminKeys.

Methods

get(string, string, AdminKeysGetOptionalParams)	Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.
regenerate(string, string, AdminKeyKind, AdminKeysRegenerateOptionalParams)	Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

Method Details

get(string, string, AdminKeysGetOptionalParams)

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

function get(resourceGroupName: string, searchServiceName: string, options?: AdminKeysGetOptionalParams): Promise<AdminKeyResult>

Parameters

resourceGroupName

string

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

searchServiceName

string

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

options

AdminKeysGetOptionalParams

The options parameters.

Returns

Promise<AdminKeyResult>

regenerate(string, string, AdminKeyKind, AdminKeysRegenerateOptionalParams)

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

function regenerate(resourceGroupName: string, searchServiceName: string, keyKind: AdminKeyKind, options?: AdminKeysRegenerateOptionalParams): Promise<AdminKeyResult>

Parameters

resourceGroupName

string

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

searchServiceName

string

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

keyKind

AdminKeyKind

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

options

AdminKeysRegenerateOptionalParams

The options parameters.

Returns

Promise<AdminKeyResult>