SearchService Class

Reference

Describes an Azure Cognitive Search service and its current state.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance: azure.mgmt.search.models._models_py3.TrackedResource

SearchService

Constructor

SearchService(*, location: str, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, identity: _models.Identity | None = None, replica_count: int = 1, partition_count: int = 1, hosting_mode: str | _models.HostingMode = 'default', public_network_access: str | _models.PublicNetworkAccess = 'enabled', network_rule_set: _models.NetworkRuleSet | None = None, encryption_with_cmk: _models.EncryptionWithCmk | None = None, disable_local_auth: bool | None = None, auth_options: _models.DataPlaneAuthOptions | None = None, semantic_search: str | _models.SearchSemanticSearch | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
tags	dict[str, str] Resource tags.
location	str The geo-location where the resource lives. Required.
sku	Sku The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.
identity	Identity The identity of the resource.
replica_count	int 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. Default value: 1
partition_count	int 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. Default value: 1
hosting_mode	str or HostingMode 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'. Known values are: "default" and "highDensity". Default value: default
public_network_access	str or PublicNetworkAccess 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. Known values are: "enabled" and "disabled". Default value: enabled
network_rule_set	NetworkRuleSet Network specific rules that determine how the Azure Cognitive Search service may be reached.
encryption_with_cmk	EncryptionWithCmk Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
disable_local_auth	bool When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
auth_options	DataPlaneAuthOptions Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
semantic_search	str or SearchSemanticSearch Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. Known values are: "disabled", "free", and "standard".

Variables

Name	Description
id	str Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	str The name of the resource.
type	str The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
tags	dict[str, str] Resource tags.
location	str The geo-location where the resource lives. Required.
sku	Sku The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.
identity	Identity The identity of the resource.
replica_count	int 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.
partition_count	int 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.
hosting_mode	str or HostingMode 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'. Known values are: "default" and "highDensity".
public_network_access	str or PublicNetworkAccess 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. Known values are: "enabled" and "disabled".
status	str or SearchServiceStatus 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. Known values are: "running", "provisioning", "deleting", "degraded", "disabled", and "error".
status_details	str The details of the search service status.
provisioning_state	str or 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. Known values are: "succeeded", "provisioning", and "failed".
network_rule_set	NetworkRuleSet Network specific rules that determine how the Azure Cognitive Search service may be reached.
encryption_with_cmk	EncryptionWithCmk Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
disable_local_auth	bool When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
auth_options	DataPlaneAuthOptions Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
private_endpoint_connections	list[PrivateEndpointConnection] The list of private endpoint connections to the Azure Cognitive Search service.
semantic_search	str or SearchSemanticSearch Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. Known values are: "disabled", "free", and "standard".
shared_private_link_resources	list[SharedPrivateLinkResource] The list of shared private link resources managed by the Azure Cognitive Search service.

Share via

SearchService Class

Constructor

Keyword-Only Parameters

Variables

Additional resources