query_keys

Creates, updates, deletes, gets or lists a query_keys resource.

Overview

Name	query_keys
Type	Resource
Id	azure.search.query_keys

Fields

The following fields are returned by SELECT queries:

list_by_search_service

Name	Datatype	Description
name	string	The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used.
key	string	The value of the query API key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_search_service	select	resource_group_name, search_service_name, subscription_id		Returns the list of query API keys for the given Azure AI Search service.
create	insert	resource_group_name, search_service_name, name, subscription_id		Generates a new query key for the specified search service. You can create up to 50 query keys per service.
delete	delete	resource_group_name, search_service_name, key_name, subscription_id		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. Returns 200 (OK) on successful deletion, 204 (No Content) if the service exists but the query keys not found, or 404 (Not Found) if the service is not found. NOTE: The behavior of returning 404 is inconsistent with ARM guidelines. Clients should expect a 204 response in future versions and avoid new dependencies on the 404 response.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
key_name	string	The query key to be deleted. Query keys are identified by value, not by name. Required.
name	string	The name of the new query API key. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
search_service_name	string	The name of the Azure AI Search service associated with the specified resource group. Required.
subscription_id	string

SELECT examples

list_by_search_service

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

SELECT
name,
key
FROM azure.search.query_keys
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND search_service_name = '{{ search_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Generates a new query key for the specified search service. You can create up to 50 query keys per service.

INSERT INTO azure.search.query_keys (
resource_group_name,
search_service_name,
name,
subscription_id
)
SELECT 
'{{ resource_group_name }}',
'{{ search_service_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
name,
key
;

Manifest

# Description fields are for documentation purposes
- name: query_keys
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the query_keys resource.
  - name: search_service_name
    value: "{{ search_service_name }}"
    description: Required parameter for the query_keys resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the query_keys resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the query_keys resource.

DELETE examples

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. Returns 200 (OK) on successful deletion, 204 (No Content) if the service exists but the query keys not found, or 404 (Not Found) if the service is not found. NOTE: The behavior of returning 404 is inconsistent with ARM guidelines. Clients should expect a 204 response in future versions and avoid new dependencies on the 404 response.

DELETE FROM azure.search.query_keys
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND search_service_name = '{{ search_service_name }}' --required
AND key_name = '{{ key_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;