ISearchService Interface

Reference

Definition

Namespace:: Microsoft.Azure.Management.Search.Fluent

Assembly:: Microsoft.Azure.Management.Search.Fluent.dll

Package:: Microsoft.Azure.Management.Search.Fluent v1.38.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An immutable client-side representation of an Azure registry.

public interface ISearchService : Microsoft.Azure.Management.ResourceManager.Fluent.Core.IBeta, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IGroupableResource<Microsoft.Azure.Management.Search.Fluent.ISearchManager,Microsoft.Azure.Management.Search.Fluent.Models.SearchServiceInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasInner<Microsoft.Azure.Management.Search.Fluent.Models.SearchServiceInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasManager<Microsoft.Azure.Management.Search.Fluent.ISearchManager>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IRefreshable<Microsoft.Azure.Management.Search.Fluent.ISearchService>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IUpdatable<Microsoft.Azure.Management.Search.Fluent.SearchService.Update.IUpdate>

type ISearchService = interface
    interface IBeta
    interface IGroupableResource<ISearchManager, SearchServiceInner>
    interface IResource
    interface IIndexable
    interface IHasId
    interface IHasName
    interface IHasResourceGroup
    interface IHasManager<ISearchManager>
    interface IHasInner<SearchServiceInner>
    interface IRefreshable<ISearchService>
    interface IUpdatable<IUpdate>

Public Interface ISearchService
Implements IBeta, IGroupableResource(Of ISearchManager, SearchServiceInner), IHasInner(Of SearchServiceInner), IHasManager(Of ISearchManager), IRefreshable(Of ISearchService), IUpdatable(Of IUpdate)

Implements: IBeta IGroupableResource<ISearchManager,SearchServiceInner> IHasId IHasInner<InnerT> IHasInner<SearchServiceInner> IHasManager<ManagerT> IHasManager<ISearchManager> IHasName IHasResourceGroup IResource IIndexable IRefreshable<ISearchService> IUpdatable<IUpdate>

Properties

HostingMode	Gets 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'.
Id	Gets the resource id string (Inherited from IHasId)
Inner	(Inherited from IHasInner<T>)
Key	(Inherited from IIndexable)
Manager	Gets the manager client type of this resource type. (Inherited from IHasManager<ManagerT>)
Name	Gets the name of the resource (Inherited from IHasName)
PartitionCount	Gets the number of partitions used by the service.
ProvisioningState	Gets 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.
Region	(Inherited from IResource)
RegionName	(Inherited from IResource)
ReplicaCount	Gets the number of replicas used by the service.
ResourceGroupName	(Inherited from IHasResourceGroup)
Sku	Gets the SKU type of the service.
Status	Gets 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.
StatusDetails	Gets the details of the status.
Tags	(Inherited from IResource)
Type	(Inherited from IResource)

Methods

CreateQueryKey(String)	Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
CreateQueryKeyAsync(String, CancellationToken)	Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
DeleteQueryKey(String)	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.
DeleteQueryKeyAsync(String, CancellationToken)	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.
GetAdminKeys()	The primary and secondary admin API keys for the specified Azure Search service.
GetAdminKeysAsync(CancellationToken)	The primary and secondary admin API keys for the specified Azure Search service.
ListQueryKeys()	Returns the list of query API keys for the given Azure Search service.
ListQueryKeysAsync(CancellationToken)	Returns the list of query API keys for the given Azure Search service.
Refresh()	Refreshes the resource to sync with Azure. (Inherited from IRefreshable<T>)
RefreshAsync(CancellationToken)	Refreshes the resource to sync with Azure. (Inherited from IRefreshable<T>)
RegenerateAdminKeys(AdminKeyKind)	Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
RegenerateAdminKeysAsync(AdminKeyKind, CancellationToken)	Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
Update()	(Inherited from IUpdatable<T>)

Applies to

Share via

ISearchService Interface

Definition

Properties

Methods

Applies to

Additional resources