QueryKeysOperations interface

Package:

@azure/arm-search

Interface representing a QueryKeys operations.

Properties

create	Generates a new query key for the specified search service. You can create up to 50 query keys per service.
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.
listBySearchService	Returns the list of query API keys for the given Azure AI Search service.

Property Details

create

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

create: (resourceGroupName: string, searchServiceName: string, name: string, options?: QueryKeysCreateOptionalParams) => Promise<QueryKey>

Property Value

(resourceGroupName: string, searchServiceName: string, name: string, options?: QueryKeysCreateOptionalParams) => Promise<QueryKey>

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: (resourceGroupName: string, searchServiceName: string, key: string, options?: QueryKeysDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, searchServiceName: string, key: string, options?: QueryKeysDeleteOptionalParams) => Promise<void>

listBySearchService

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

listBySearchService: (resourceGroupName: string, searchServiceName: string, options?: QueryKeysListBySearchServiceOptionalParams) => PagedAsyncIterableIterator<QueryKey, QueryKey[], PageSettings>

Property Value

(resourceGroupName: string, searchServiceName: string, options?: QueryKeysListBySearchServiceOptionalParams) => PagedAsyncIterableIterator<QueryKey, QueryKey[], PageSettings>