Share via

az search admin-key

  • Reference

Manage Azure 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 Cognitive Search service.

 Core GA

az search admin-key renew

Edit

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.

az search admin-key renew --key-kind
                          --resource-group
                          --service-name

Required Parameters

--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az search admin-key show

Edit

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

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

Required Parameters

--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.