SearchServiceResource.CreateQueryKey Method

Definition

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}
  • Operation Id: QueryKeys_Create
  • Default Api Version: 2024-03-01-preview
public virtual Azure.Response<Azure.ResourceManager.Search.Models.SearchServiceQueryKey> CreateQueryKey (string name, Azure.ResourceManager.Search.Models.SearchManagementRequestOptions searchManagementRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateQueryKey : string * Azure.ResourceManager.Search.Models.SearchManagementRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Search.Models.SearchServiceQueryKey>
override this.CreateQueryKey : string * Azure.ResourceManager.Search.Models.SearchManagementRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Search.Models.SearchServiceQueryKey>
Public Overridable Function CreateQueryKey (name As String, Optional searchManagementRequestOptions As SearchManagementRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SearchServiceQueryKey)

Parameters

name
String

The name of the new query API key.

searchManagementRequestOptions
SearchManagementRequestOptions

Parameter group.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

name is null.

Applies to