admin_keys

Creates, updates, deletes, gets or lists an admin_keys resource.

Overview

Name	admin_keys
Type	Resource
Id	azure.search.admin_keys

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
primaryKey	string	The primary admin API key of the search service.
secondaryKey	string	The secondary admin API key of the search service.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, search_service_name, subscription_id		Gets the primary and secondary admin API keys for the specified Azure AI Search service.
regenerate	exec	resource_group_name, search_service_name, key_kind, subscription_id		Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
key_kind	string	Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. Known values are: "primary" and "secondary". Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
search_service_name	string	The name of the Azure AI Search service associated with the specified resource group. Required.
subscription_id	string

SELECT examples

get

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

SELECT
primaryKey,
secondaryKey
FROM azure.search.admin_keys
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND search_service_name = '{{ search_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

regenerate

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

EXEC azure.search.admin_keys.regenerate 
@resource_group_name='{{ resource_group_name }}' --required, 
@search_service_name='{{ search_service_name }}' --required, 
@key_kind='{{ key_kind }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;