az search query-key

Manage Azure Search query keys.

Commands

az search query-key create

Generates a new query key for the specified Search service.

az search query-key delete

Deletes the specified query key.

az search query-key list

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

az search query-key create

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
                           [--subscription]

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.

Optional Parameters

--subscription

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

az search query-key delete

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
                           [--subscription]

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.

Optional Parameters

--subscription

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

az search query-key list

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

az search query-key list --resource-group
                         --service-name
                         [--query-examples]
                         [--subscription]

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.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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