az search query-key

  • Reference

Manage Azure Search query keys.

Commands

Name Description Type Status
az search query-key create

Generates a new query key for the specified search service.

 Core GA
az search query-key delete

Deletes the specified query key.

 Core GA
az search query-key list

Returns the list of query API keys for the given Azure Cognitive Search service.

 Core GA

az search query-key create

Edit

Generates a new query key for the specified search service.

You can create up to 50 query keys per service.

az search query-key create --name
                           --resource-group
                           --service-name

Required Parameters

--name -n

The name of the query 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 query-key delete

Edit

Deletes the specified query key.

Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.

az search query-key delete --key-value
                           --resource-group
                           --service-name

Required Parameters

--key-value

The value of the query 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 query-key list

Edit

Returns the list of query API keys for the given Azure Cognitive Search service.

az search query-key list --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.