SearchServiceResource.DeleteQueryKeyAsync Method

Definition

Namespace:

Azure.ResourceManager.Search

Assembly:

Azure.ResourceManager.Search.dll

Package:

Azure.ResourceManager.Search v1.2.3

Source:

SearchServiceResource.cs

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 System.Threading.Tasks.Task<Azure.Response> DeleteQueryKeyAsync (string key, Azure.ResourceManager.Search.Models.SearchManagementRequestOptions searchManagementRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteQueryKeyAsync : string * Azure.ResourceManager.Search.Models.SearchManagementRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteQueryKeyAsync : string * Azure.ResourceManager.Search.Models.SearchManagementRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteQueryKeyAsync (key As String, Optional searchManagementRequestOptions As SearchManagementRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

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

Task<Response>

Exceptions

ArgumentException

key is an empty string, and was expected to be non-empty.

ArgumentNullException

key is null.