SearchService Interface

public abstract QueryKey createQueryKey(String name)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.

Parameters:

Returns:

public abstract Mono createQueryKeyAsync(String name)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.

Parameters:

Returns:

public abstract 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:

public abstract Mono 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:

Returns:

public abstract AdminKeys getAdminKeys()

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

Returns:

public abstract Mono getAdminKeysAsync()

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

Returns:

public abstract 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:

public abstract PagedIterable listQueryKeys()

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

Returns:

public abstract PagedFlux listQueryKeysAsync()

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

Returns:

public abstract int partitionCount()

Returns:

public abstract 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:

public abstract PublicNetworkAccess publicNetworkAccess()

Whether the search service can be accessed from public network.

Returns:

public abstract AdminKeys regenerateAdminKeys(AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.

Parameters:

Returns:

public abstract Mono regenerateAdminKeysAsync(AdminKeyKind keyKind)

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

Parameters:

Returns:

public abstract int replicaCount()

Returns:

public abstract Sku sku()

Returns:

public abstract 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:

public abstract String statusDetails()

Returns: