Skip to main content

admin_keys

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

Overview

Nameadmin_keys
TypeResource
Idazure.search.admin_keys

Fields

NameDatatypeDescription
primaryKeystringThe primary admin API key of the search service.
secondaryKeystringThe secondary admin API key of the search service.

Methods

NameAccessible byRequired ParamsDescription
getSELECTresourceGroupName, searchServiceName, subscriptionIdGets the primary and secondary admin API keys for the specified Azure AI Search service.
regenerateEXECkeyKind, resourceGroupName, searchServiceName, subscriptionIdRegenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

SELECT examples

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

SELECT
primaryKey,
secondaryKey
FROM azure.search.admin_keys
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND searchServiceName = '{{ searchServiceName }}'
AND subscriptionId = '{{ subscriptionId }}';