SearchService Class


Describes an Azure Cognitive Search service and its current state.

public class SearchService : Microsoft.Azure.Management.Search.Models.TrackedResource
type SearchService = class
    inherit TrackedResource
Public Class SearchService
Inherits TrackedResource



Initializes a new instance of the SearchService class.

SearchService(String, String, String, String, IDictionary<String, String>, Nullable<Int32>, Nullable<Int32>, Nullable<HostingMode>, Nullable<PublicNetworkAccess>, Nullable<SearchServiceStatus>, String, Nullable<ProvisioningState>, NetworkRuleSet, IList<PrivateEndpointConnection>, IList<SharedPrivateLinkResource>, Sku, Identity)

Initializes a new instance of the SearchService class.



Gets or sets 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'. Possible values include: 'default', 'highDensity'


Gets fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

(Inherited from Resource)

Gets or sets the identity of the resource.


Gets or sets the geo-location where the resource lives

(Inherited from TrackedResource)

Gets the name of the resource

(Inherited from Resource)

Gets or sets network specific rules that determine how the Azure Cognitive Search service may be reached.


Gets or sets the number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.


Gets the list of private endpoint connections to the Azure Cognitive Search service.


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. Possible values include: 'succeeded', 'provisioning', 'failed'


Gets or sets this value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. Possible values include: 'enabled', 'disabled'


Gets or sets the number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.


Gets the list of shared private link resources managed by the Azure Cognitive Search service.


Gets or sets the SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.


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 Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. Possible values include: 'running', 'provisioning', 'deleting', 'degraded', 'disabled', 'error'


Gets the details of the search service status.


Gets or sets resource tags.

(Inherited from TrackedResource)

Gets the type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

(Inherited from Resource)



Validate the object.

Applies to