QueryKeys interface
Interface representing a QueryKeys.
Methods
| create(string, string, string, Query |
Generates a new query key for the specified search service. You can create up to 50 query keys per service. |
| delete(string, string, string, Query |
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. |
| list |
Returns the list of query API keys for the given Azure Cognitive Search service. |
Method Details
create(string, string, string, QueryKeysCreateOptionalParams)
Generates a new query key for the specified search service. You can create up to 50 query keys per service.
function create(resourceGroupName: string, searchServiceName: string, name: string, options?: QueryKeysCreateOptionalParams): Promise<QueryKey>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- name
-
string
The name of the new query API key.
- options
- QueryKeysCreateOptionalParams
The options parameters.
Returns
Promise<QueryKey>
delete(string, string, string, QueryKeysDeleteOptionalParams)
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.
function delete(resourceGroupName: string, searchServiceName: string, key: string, options?: QueryKeysDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- key
-
string
The query key to be deleted. Query keys are identified by value, not by name.
- options
- QueryKeysDeleteOptionalParams
The options parameters.
Returns
Promise<void>
listBySearchService(string, string, QueryKeysListBySearchServiceOptionalParams)
Returns the list of query API keys for the given Azure Cognitive Search service.
function listBySearchService(resourceGroupName: string, searchServiceName: string, options?: QueryKeysListBySearchServiceOptionalParams): PagedAsyncIterableIterator<QueryKey, QueryKey[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
The options parameters.