az search service admin-key

Manage Admin Key.

Commands

Name	Description	Type	Status
az search service admin-key list	Gets the primary and secondary admin API keys for the specified Azure AI Search service.	Core	GA
az search service admin-key regenerate	Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.	Core	GA

az search service admin-key list

Edit

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

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

Required Parameters

--resource-group -g

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

--search-service-name

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az search service admin-key regenerate

Edit

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

az search service admin-key regenerate [--ids]
                                       [--key-kind --name {primary, secondary}]
                                       [--resource-group]
                                       [--search-service-name]
                                       [--subscription]

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--key-kind --name -n

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

Property	Value
Parameter group:	Resource Id Arguments
Accepted values:	primary, secondary

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--search-service-name

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?