SearchServices Interface

  • Reference
Package:
com.microsoft.azure.management.search

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

Entry point to Search service management API in Azure.

Method Summary

Modifier and Type Method and Description
CheckNameAvailabilityResult checkNameAvailability(String name)

Checks if the specified Search service name is valid and available.
Observable<CheckNameAvailabilityResult> checkNameAvailabilityAsync(String name)

Checks if Search service name is valid and is not in use asynchronously.
ServiceFuture<CheckNameAvailabilityResult> checkNameAvailabilityAsync(String name, ServiceCallback<CheckNameAvailabilityResult> callback)

Checks if Search service name is valid and is not in use asynchronously.
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.
Observable<QueryKey> 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.
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.
Completable 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.
AdminKeys getAdminKeys(String resourceGroupName, String searchServiceName)

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

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

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

Returns the list of query API keys for the given Azure Search service.
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.
Observable<AdminKeys> 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.

Inherited Members

SupportsBatchCreation<ResourceT>.create(Creatable<ResourceT>... creatables) SupportsBatchCreation<ResourceT>.create(List<Creatable<ResourceT>> creatables) SupportsBatchCreation<ResourceT>.createAsync(Creatable<ResourceT>... creatables) SupportsBatchCreation<ResourceT>.createAsync(List<Creatable<ResourceT>> creatables) SupportsBatchCreation<ResourceT>.createAsync(ServiceCallback<CreatedResources<ResourceT>> callback, Creatable<ResourceT>... creatables) SupportsBatchCreation<ResourceT>.createAsync(final ServiceCallback<CreatedResources<ResourceT>> callback, List<Creatable<ResourceT>> creatables) SupportsCreating<T>.define(String name) SupportsDeletingById.deleteById(String id) SupportsDeletingById.deleteByIdAsync(String id, ServiceCallback<Void> callback) SupportsDeletingById.deleteByIdAsync(String id) SupportsDeletingByResourceGroup.deleteByResourceGroup(String resourceGroupName, String name) SupportsDeletingByResourceGroup.deleteByResourceGroupAsync(String resourceGroupName, String name, ServiceCallback<Void> callback) SupportsDeletingByResourceGroup.deleteByResourceGroupAsync(String resourceGroupName, String name) SupportsGettingById<T>.getById(String id) SupportsGettingById<T>.getByIdAsync(String id) SupportsGettingById<T>.getByIdAsync(String id, ServiceCallback<T> callback) SupportsGettingByResourceGroup<T>.getByResourceGroup(String resourceGroupName, String name) SupportsGettingByResourceGroup<T>.getByResourceGroupAsync(String resourceGroupName, String name) SupportsGettingByResourceGroup<T>.getByResourceGroupAsync(String resourceGroupName, String name, ServiceCallback<T> callback) HasInner<T>.inner() SupportsListing<T>.list() SupportsListing<T>.listAsync() SupportsListingByResourceGroup<T>.listByResourceGroup(String resourceGroupName) SupportsListingByResourceGroup<T>.listByResourceGroupAsync(String resourceGroupName) HasManager<ManagerT>.manager()

Method Details

checkNameAvailability

public CheckNameAvailabilityResult 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 Observable 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

checkNameAvailabilityAsync

public ServiceFuture checkNameAvailabilityAsync(String name, ServiceCallback callback)

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

Parameters:

name - the Search service name to check
callback - the callback to call on success or failure

Returns:

a handle to cancel the request

createQueryKey

public 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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createQueryKeyAsync

public Observable 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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteQueryKey

public 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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteQueryKeyAsync

public Completable 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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAdminKeys

public 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

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAdminKeysAsync

public Observable 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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listQueryKeys

public List 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

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listQueryKeysAsync

public Observable 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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

regenerateAdminKeys

public 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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

regenerateAdminKeysAsync

public Observable 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

Throws:

IllegalArgumentException - thrown if parameters fail the validation

Applies to