Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az search query-key

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

 Core GA

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. .. seealso:: - https://aka.ms/search-manage.

az search query-key create --name
 --resource-group
 --service-name
 [--acquire-policy-token]
 [--change-reference]

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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments

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. .. seealso:: - https://aka.ms/search-manage.

az search query-key delete --key-value
 --resource-group
 --service-name
 [--acquire-policy-token]
 [--change-reference]

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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments

az search query-key list

Returns the list of query API keys for the given Azure AI 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.

Feedback

Was this page helpful?