Share via

QueryKeysClient Interface

  • Reference
Package:
com.azure.resourcemanager.search.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-search:2.44.0

public interface QueryKeysClient

An instance of this class provides access to all the operations defined in QueryKeysClient.

Method Summary

Modifier and Type Method and Description
abstract QueryKeyInner create(String resourceGroupName, String searchServiceName, String name)

Generates a new query key for the specified search service.
abstract Mono<QueryKeyInner> createAsync(String resourceGroupName, String searchServiceName, String name)

Generates a new query key for the specified search service.
abstract Response<QueryKeyInner> createWithResponse(String resourceGroupName, String searchServiceName, String name, UUID clientRequestId, Context context)

Generates a new query key for the specified search service.
abstract Mono<Response<QueryKeyInner>> createWithResponseAsync(String resourceGroupName, String searchServiceName, String name, UUID clientRequestId)

Generates a new query key for the specified search service.
abstract void delete(String resourceGroupName, String searchServiceName, String key)

Deletes the specified query key.
abstract Mono<Void> deleteAsync(String resourceGroupName, String searchServiceName, String key)

Deletes the specified query key.
abstract Response<Void> deleteWithResponse(String resourceGroupName, String searchServiceName, String key, UUID clientRequestId, Context context)

Deletes the specified query key.
abstract Mono<Response<Void>> deleteWithResponseAsync(String resourceGroupName, String searchServiceName, String key, UUID clientRequestId)

Deletes the specified query key.
abstract PagedIterable<QueryKeyInner> listBySearchService(String resourceGroupName, String searchServiceName)

Returns the list of query API keys for the given search service.
abstract PagedIterable<QueryKeyInner> listBySearchService(String resourceGroupName, String searchServiceName, UUID clientRequestId, Context context)

Returns the list of query API keys for the given search service.
abstract PagedFlux<QueryKeyInner> listBySearchServiceAsync(String resourceGroupName, String searchServiceName)

Returns the list of query API keys for the given search service.
abstract PagedFlux<QueryKeyInner> listBySearchServiceAsync(String resourceGroupName, String searchServiceName, UUID clientRequestId)

Returns the list of query API keys for the given search service.

Method Details

create

public abstract QueryKeyInner create(String resourceGroupName, String searchServiceName, String name)

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

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.
name - The name of the new query API key.

Returns:

describes an API key for a given search service that has permissions for query operations only.

createAsync

public abstract Mono createAsync(String resourceGroupName, String searchServiceName, String name)

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

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.
name - The name of the new query API key.

Returns:

describes an API key for a given search service that has permissions for query operations only on successful completion of Mono.

createWithResponse

public abstract Response createWithResponse(String resourceGroupName, String searchServiceName, String name, UUID clientRequestId, Context context)

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

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.
name - The name of the new query API key.
clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
context - The context to associate with this operation.

Returns:

describes an API key for a given search service that has permissions for query operations only along with Response<T>.

createWithResponseAsync

public abstract Mono> createWithResponseAsync(String resourceGroupName, String searchServiceName, String name, UUID clientRequestId)

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

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.
name - The name of the new query API key.
clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

describes an API key for a given search service that has permissions for query operations only along with Response<T> on successful completion of Mono.

delete

public abstract void delete(String resourceGroupName, String searchServiceName, String key)

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.

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.
key - The query key to be deleted. Query keys are identified by value, not by name.

deleteAsync

public abstract Mono deleteAsync(String resourceGroupName, String searchServiceName, String key)

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.

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.
key - The query key to be deleted. Query keys are identified by value, not by name.

Returns:

A Mono that completes when a successful response is received.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String searchServiceName, String key, UUID clientRequestId, Context context)

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.

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.
key - The query key to be deleted. Query keys are identified by value, not by name.
clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
context - The context to associate with this operation.

Returns:

deleteWithResponseAsync

public abstract Mono> deleteWithResponseAsync(String resourceGroupName, String searchServiceName, String key, UUID clientRequestId)

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.

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.
key - The query key to be deleted. Query keys are identified by value, not by name.
clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

the Response<T> on successful completion of Mono.

listBySearchService

public abstract PagedIterable listBySearchService(String resourceGroupName, String searchServiceName)

Returns the list of query API keys for the given search service.

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.

Returns:

response containing the query API keys for a given search service as paginated response with PagedIterable<T>.

listBySearchService

public abstract PagedIterable listBySearchService(String resourceGroupName, String searchServiceName, UUID clientRequestId, Context context)

Returns the list of query API keys for the given search service.

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.
clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
context - The context to associate with this operation.

Returns:

response containing the query API keys for a given search service as paginated response with PagedIterable<T>.

listBySearchServiceAsync

public abstract PagedFlux listBySearchServiceAsync(String resourceGroupName, String searchServiceName)

Returns the list of query API keys for the given search service.

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.

Returns:

response containing the query API keys for a given search service as paginated response with PagedFlux<T>.

listBySearchServiceAsync

public abstract PagedFlux listBySearchServiceAsync(String resourceGroupName, String searchServiceName, UUID clientRequestId)

Returns the list of query API keys for the given search service.

Parameters:

resourceGroupName - 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 - The name of the search service associated with the specified resource group.
clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

response containing the query API keys for a given search service as paginated response with PagedFlux<T>.

Applies to