az search admin-key

Manage Azure AI Search admin keys.

Commands

Name	Description	Type	Status
az search admin-key renew	Regenerates either the primary or secondary admin API key.	Core	GA
az search admin-key show	Gets the primary and secondary admin API keys for the specified Azure AI Search service.	Core	GA

Edit

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time. .. seealso:: - https://aka.ms/search-manage.

az search admin-key renew --key-kind
 --resource-group
 --service-name
 [--acquire-policy-token]
 [--change-reference]

--key-kind

The type (primary or secondary) of the admin key.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name

The name of the search service.

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

Edit

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

az search admin-key show --resource-group
 --service-name

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name

The name of the search service.

Was this page helpful?