az search admin-key
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
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
The type (primary or secondary) of the admin key.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the search service.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az search admin-key show
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the search service.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |