com.microsoft.azure.management.search

Interface SearchService

All Superinterfaces:

GroupableResource<com.microsoft.azure.management.search.implementation.SearchServiceManager,com.microsoft.azure.management.search.implementation.SearchServiceInner>, HasId, HasInner<com.microsoft.azure.management.search.implementation.SearchServiceInner>, HasManager<com.microsoft.azure.management.search.implementation.SearchServiceManager>, HasName, HasResourceGroup, Indexable, Refreshable<SearchService>, Resource, Updatable<SearchService.Update>

@Beta(value=V1_2_0)
public interface SearchService
extends GroupableResource<com.microsoft.azure.management.search.implementation.SearchServiceManager,com.microsoft.azure.management.search.implementation.SearchServiceInner>, Refreshable<SearchService>, Updatable<SearchService.Update>

An immutable client-side representation of an Azure registry.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SearchService.Definition The entirety of the Search service definition.
static interface	SearchService.DefinitionStages Grouping of virtual network definition stages.
static interface	SearchService.Update The template for a Search service update operation, containing all the settings that can be modified.
static interface	SearchService.UpdateStages Grouping of all the Search service update stages.

Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Method Summary

Modifier and Type	Method and Description
QueryKey	createQueryKey(String name) Regenerates either the primary or secondary admin API key.
rx.Observable<QueryKey>	createQueryKeyAsync(String name) Regenerates either the primary or secondary admin API key.
void	deleteQueryKey(String key) Deletes the specified query key.
rx.Completable	deleteQueryKeyAsync(String key) Deletes the specified query key.
AdminKeys	getAdminKeys() The primary and secondary admin API keys for the specified Azure Search service.
rx.Observable<AdminKeys>	getAdminKeysAsync() The primary and secondary admin API keys for the specified Azure Search service.
HostingMode	hostingMode() The hosting mode value.
List<QueryKey>	listQueryKeys() Returns the list of query API keys for the given Azure Search service.
rx.Observable<QueryKey>	listQueryKeysAsync() Returns the list of query API keys for the given Azure Search service.
int	partitionCount()
ProvisioningState	provisioningState() The state of the last provisioning operation performed on the Search service.
AdminKeys	regenerateAdminKeys(AdminKeyKind keyKind) Regenerates either the primary or secondary admin API key.
rx.Observable<AdminKeys>	regenerateAdminKeysAsync(AdminKeyKind keyKind) Regenerates either the primary or secondary admin API key.
int	replicaCount()
Sku	sku()
SearchServiceStatus	status() The status of the Search service.
String	statusDetails()

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

region, regionName, tags, type

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasId

id

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasName

name

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup

resourceGroupName

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner

inner

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable

update

Method Detail

hostingMode

HostingMode hostingMode()

The hosting mode value.

Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.

Returns:

the hosting mode value.

partitionCount

int partitionCount()

Returns:

the number of partitions used by the service

provisioningState

ProvisioningState provisioningState()

The state of the last provisioning operation performed on the Search service.

Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create Search service. This is because the free service uses capacity that is already set up.

Returns:

the provisioning state of the resource

replicaCount

int replicaCount()

Returns:

the number of replicas used by the service

sku

Sku sku()

Returns:

the SKU type of the service

status

SearchServiceStatus status()

The status of the Search service.

Possible values include: 'running': the Search service is running and no provisioning operations are underway. 'provisioning': the Search service is being provisioned or scaled up or down. 'deleting': the Search service is being deleted. 'degraded': the Search service is degraded. This can occur when the underlying search units are not healthy. The Search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': the Search service is disabled. In this state, the service will reject all API requests. 'error': the Search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.

Returns:

the status of the service

statusDetails

String statusDetails()

Returns:

the details of the status.

getAdminKeys

AdminKeys getAdminKeys()

The primary and secondary admin API keys for the specified Azure Search service.

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

rx.Observable<AdminKeys> getAdminKeysAsync()

The primary and secondary admin API keys for the specified Azure Search service.

Returns:

a representation of the future computation of this call

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listQueryKeys

List<QueryKey> listQueryKeys()

Returns the list of query API keys for the given Azure Search service.

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

rx.Observable<QueryKey> listQueryKeysAsync()

Returns the list of query API keys for the given Azure Search service.

Returns:

the observable to the List<QueryKey> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

regenerateAdminKeys

AdminKeys regenerateAdminKeys(AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.

Parameters:

keyKind - specifies which key to regenerate

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

rx.Observable<AdminKeys> regenerateAdminKeysAsync(AdminKeyKind keyKind)

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

Parameters:

keyKind - Specifies which key to regenerate

Returns:

a representation of the future computation of this call

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createQueryKey

QueryKey createQueryKey(String name)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.

Parameters:

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

rx.Observable<QueryKey> createQueryKeyAsync(String name)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.

Parameters:

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

void deleteQueryKey(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:

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

rx.Completable deleteQueryKeyAsync(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:

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