Share via

SearchServices Interface

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

Implements

SupportsDeletingByResourceGroup SupportsGettingById<SearchService> SupportsGettingByResourceGroup<SearchService> SupportsListingByResourceGroup<SearchService> HasManager<SearchServiceManager> SupportsBatchCreation<SearchService> SupportsCreating<Blank> SupportsDeletingById SupportsListing<SearchService>

public interface SearchServices
extends SupportsCreating<Blank>, SupportsListing<SearchService>, SupportsListingByResourceGroup<SearchService>, SupportsGettingByResourceGroup<SearchService>, SupportsGettingById<SearchService>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsBatchCreation<SearchService>, HasManager<SearchServiceManager>

Entry point to Cognitive Search service management API in Azure.

Method Summary

Modifier and Type Method and Description
abstract CheckNameAvailabilityOutput checkNameAvailability(String name)

Checks if the specified Search service name is valid and available.
abstract Mono<CheckNameAvailabilityOutput> checkNameAvailabilityAsync(String name)

Checks if Search service name is valid and is not in use asynchronously.
abstract QueryKey createQueryKey(String resourceGroupName, String searchServiceName, String name)

Regenerates either the primary or secondary admin API key.
abstract Mono<QueryKey> createQueryKeyAsync(String resourceGroupName, String searchServiceName, String name)

Regenerates either the primary or secondary admin API key.
abstract void deleteQueryKey(String resourceGroupName, String searchServiceName, String key)

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

Deletes the specified query key.
abstract AdminKeys getAdminKeys(String resourceGroupName, String searchServiceName)

Gets the primary and secondary admin API keys for the specified Azure Search service.
abstract Mono<AdminKeys> getAdminKeysAsync(String resourceGroupName, String searchServiceName)

Gets the primary and secondary admin API keys for the specified Azure Search service.
abstract PagedIterable<QueryKey> listQueryKeys(String resourceGroupName, String searchServiceName)

Returns the list of query API keys for the given Azure Search service.
abstract PagedFlux<QueryKey> listQueryKeysAsync(String resourceGroupName, String searchServiceName)

Returns the list of query API keys for the given Azure Search service.
abstract AdminKeys regenerateAdminKeys(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key.
abstract Mono<AdminKeys> regenerateAdminKeysAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key.

Method Details

checkNameAvailability

public abstract CheckNameAvailabilityOutput checkNameAvailability(String name)

Checks if the specified Search service name is valid and available.

Parameters:

name - the Search service name to check

Returns:

whether the name is available and other info if not

checkNameAvailabilityAsync

public abstract Mono checkNameAvailabilityAsync(String name)

Checks if Search service name is valid and is not in use asynchronously.

Parameters:

name - the Search service name to check

Returns:

a representation of the deferred computation of this call, returning whether the name is available or other info if not

createQueryKey

public abstract QueryKey createQueryKey(String resourceGroupName, String searchServiceName, String name)

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

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

Returns:

the QueryKey object if successful.

createQueryKeyAsync

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

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

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

Returns:

a representation of the future computation of this call

deleteQueryKey

public abstract void deleteQueryKey(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 Azure Search service associated with the specified resource group.
key - The query key to be deleted. Query keys are identified by value, not by name.

deleteQueryKeyAsync

public abstract Mono deleteQueryKeyAsync(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 Azure 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 representation of the future computation of this call

getAdminKeys

public abstract AdminKeys getAdminKeys(String resourceGroupName, String searchServiceName)

Gets the primary and secondary admin API keys for the specified Azure 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 Azure Search service associated with the specified resource group

Returns:

the AdminKeys object if successful

getAdminKeysAsync

public abstract Mono getAdminKeysAsync(String resourceGroupName, String searchServiceName)

Gets the primary and secondary admin API keys for the specified Azure 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 Azure Search service associated with the specified resource group

Returns:

a representation of the future computation of this call

listQueryKeys

public abstract PagedIterable listQueryKeys(String resourceGroupName, String searchServiceName)

Returns the list of query API keys for the given Azure 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 Azure Search service associated with the specified resource group

Returns:

the List<QueryKey> object if successful

listQueryKeysAsync

public abstract PagedFlux listQueryKeysAsync(String resourceGroupName, String searchServiceName)

Returns the list of query API keys for the given Azure 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 Azure Search service associated with the specified resource group.

Returns:

a representation of the future computation of this call

regenerateAdminKeys

public abstract AdminKeys regenerateAdminKeys(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

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 Azure Search service associated with the specified resource group.
keyKind - Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. Possible values include: 'primary', 'secondary'

Returns:

the AdminKeys object if successful.

regenerateAdminKeysAsync

public abstract Mono regenerateAdminKeysAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

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 Azure Search service associated with the specified resource group.
keyKind - Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. Possible values include: 'primary', 'secondary'

Returns:

the observable to the AdminKeyResultInner object

Applies to