SearchServiceResource.DeleteQueryKey Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}
- Operation Id: QueryKeys_Delete
- Default Api Version: 2024-03-01-preview
public virtual Azure.Response DeleteQueryKey (string key, Azure.ResourceManager.Search.Models.SearchManagementRequestOptions searchManagementRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteQueryKey : string * Azure.ResourceManager.Search.Models.SearchManagementRequestOptions * System.Threading.CancellationToken -> Azure.Response
override this.DeleteQueryKey : string * Azure.ResourceManager.Search.Models.SearchManagementRequestOptions * System.Threading.CancellationToken -> Azure.ResponsePublic Overridable Function DeleteQueryKey (key As String, Optional searchManagementRequestOptions As SearchManagementRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ResponseParameters
- key
- String
The query key to be deleted. Query keys are identified by value, not by name.
- searchManagementRequestOptions
- SearchManagementRequestOptions
Parameter group.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
key is an empty string, and was expected to be non-empty.
key is null.
