Share via

SearchServiceInner Class

  • Reference
Package:
com.azure.resourcemanager.search.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-search:2.44.0

public final class SearchServiceInner
extends Resource

Describes a search service and its current state.

Constructor Summary

Constructor Description
SearchServiceInner()

Creates an instance of SearchServiceInner class.

Method Summary

Modifier and Type Method and Description
DataPlaneAuthOptions authOptions()

Get the authOptions property: Defines the options for how the data plane API of a search service authenticates requests.
Boolean disableLocalAuth()

Get the disableLocalAuth property: When set to true, calls to the search service will not be permitted to utilize API keys for authentication.
EncryptionWithCmk encryptionWithCmk()

Get the encryptionWithCmk property: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
static SearchServiceInner fromJson(JsonReader jsonReader)

Reads an instance of SearchServiceInner from the JsonReader.
HostingMode hostingMode()

Get the hostingMode property: Applicable only for the standard3 SKU.
String id()

Get the id property: Fully qualified resource Id for the resource.
Identity identity()

Get the identity property: The identity of the resource.
String name()

Get the name property: The name of the resource.
NetworkRuleSet networkRuleSet()

Get the networkRuleSet property: Network-specific rules that determine how the search service may be reached.
Integer partitionCount()

Get the partitionCount property: The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12.
List<PrivateEndpointConnectionInner> privateEndpointConnections()

Get the privateEndpointConnections property: The list of private endpoint connections to the search service.
ProvisioningState provisioningState()

Get the provisioningState property: The state of the last provisioning operation performed on the search service.
PublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates.
Integer replicaCount()

Get the replicaCount property: The number of replicas in the search service.
SearchSemanticSearch semanticSearch()

Get the semanticSearch property: Sets options that control the availability of semantic search.
List<SharedPrivateLinkResourceInner> sharedPrivateLinkResources()

Get the sharedPrivateLinkResources property: The list of shared private link resources managed by the search service.
Sku sku()

Get the sku property: The SKU of the search service, which determines billing rate and capacity limits.
SearchServiceStatus status()

Get the status property: The status of the search service.
String statusDetails()

Get the statusDetails property: The details of the search service status.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
void validate()

Validates the instance.
SearchServiceInner withAuthOptions(DataPlaneAuthOptions authOptions)

Set the authOptions property: Defines the options for how the data plane API of a search service authenticates requests.
SearchServiceInner withDisableLocalAuth(Boolean disableLocalAuth)

Set the disableLocalAuth property: When set to true, calls to the search service will not be permitted to utilize API keys for authentication.
SearchServiceInner withEncryptionWithCmk(EncryptionWithCmk encryptionWithCmk)

Set the encryptionWithCmk property: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
SearchServiceInner withHostingMode(HostingMode hostingMode)

Set the hostingMode property: Applicable only for the standard3 SKU.
SearchServiceInner withIdentity(Identity identity)

Set the identity property: The identity of the resource.
SearchServiceInner withLocation(String location)
SearchServiceInner withNetworkRuleSet(NetworkRuleSet networkRuleSet)

Set the networkRuleSet property: Network-specific rules that determine how the search service may be reached.
SearchServiceInner withPartitionCount(Integer partitionCount)

Set the partitionCount property: The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12.
SearchServiceInner withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates.
SearchServiceInner withReplicaCount(Integer replicaCount)

Set the replicaCount property: The number of replicas in the search service.
SearchServiceInner withSemanticSearch(SearchSemanticSearch semanticSearch)

Set the semanticSearch property: Sets options that control the availability of semantic search.
SearchServiceInner withSku(Sku sku)

Set the sku property: The SKU of the search service, which determines billing rate and capacity limits.
SearchServiceInner withTags(Map<String,String> tags)

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchServiceInner

public SearchServiceInner()

Creates an instance of SearchServiceInner class.

Method Details

authOptions

public DataPlaneAuthOptions authOptions()

Get the authOptions property: 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.

Returns:

the authOptions value.

disableLocalAuth

public Boolean disableLocalAuth()

Get the disableLocalAuth property: 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.

Returns:

the disableLocalAuth value.

encryptionWithCmk

public EncryptionWithCmk encryptionWithCmk()

Get the encryptionWithCmk property: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.

Returns:

the encryptionWithCmk value.

fromJson

public static SearchServiceInner fromJson(JsonReader jsonReader)

Reads an instance of SearchServiceInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SearchServiceInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

hostingMode

public HostingMode hostingMode()

Get the hostingMode property: 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 hostingMode value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

SearchServiceInner.id()

Returns:

the id value.

identity

public Identity identity()

Get the identity property: The identity of the resource.

Returns:

the identity value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

SearchServiceInner.name()

Returns:

the name value.

networkRuleSet

public NetworkRuleSet networkRuleSet()

Get the networkRuleSet property: Network-specific rules that determine how the search service may be reached.

Returns:

the networkRuleSet value.

partitionCount

public Integer partitionCount()

Get the partitionCount property: 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.

Returns:

the partitionCount value.

privateEndpointConnections

public List privateEndpointConnections()

Get the privateEndpointConnections property: The list of private endpoint connections to the search service.

Returns:

the privateEndpointConnections value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: 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 provisioningState value.

publicNetworkAccess

public PublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: 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.

Returns:

the publicNetworkAccess value.

replicaCount

public Integer replicaCount()

Get the replicaCount property: 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.

Returns:

the replicaCount value.

semanticSearch

public SearchSemanticSearch semanticSearch()

Get the semanticSearch property: Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.

Returns:

the semanticSearch value.

sharedPrivateLinkResources

public List sharedPrivateLinkResources()

Get the sharedPrivateLinkResources property: The list of shared private link resources managed by the search service.

Returns:

the sharedPrivateLinkResources value.

sku

public Sku sku()

Get the sku property: The SKU of the search service, which determines billing rate and capacity limits. This property is required when creating a new search service.

Returns:

the sku value.

status

public SearchServiceStatus status()

Get the status property: 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, Microsoft 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 value.

statusDetails

public String statusDetails()

Get the statusDetails property: The details of the search service status.

Returns:

the statusDetails value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SearchServiceInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

SearchServiceInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAuthOptions

public SearchServiceInner withAuthOptions(DataPlaneAuthOptions authOptions)

Set the authOptions property: 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.

Parameters:

authOptions - the authOptions value to set.

Returns:

the SearchServiceInner object itself.

withDisableLocalAuth

public SearchServiceInner withDisableLocalAuth(Boolean disableLocalAuth)

Set the disableLocalAuth property: 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.

Parameters:

disableLocalAuth - the disableLocalAuth value to set.

Returns:

the SearchServiceInner object itself.

withEncryptionWithCmk

public SearchServiceInner withEncryptionWithCmk(EncryptionWithCmk encryptionWithCmk)

Set the encryptionWithCmk property: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.

Parameters:

encryptionWithCmk - the encryptionWithCmk value to set.

Returns:

the SearchServiceInner object itself.

withHostingMode

public SearchServiceInner withHostingMode(HostingMode hostingMode)

Set the hostingMode property: 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'.

Parameters:

hostingMode - the hostingMode value to set.

Returns:

the SearchServiceInner object itself.

withIdentity

public SearchServiceInner withIdentity(Identity identity)

Set the identity property: The identity of the resource.

Parameters:

identity - the identity value to set.

Returns:

the SearchServiceInner object itself.

withLocation

public SearchServiceInner withLocation(String location)

Overrides:

SearchServiceInner.withLocation(String location)

Parameters:

location

withNetworkRuleSet

public SearchServiceInner withNetworkRuleSet(NetworkRuleSet networkRuleSet)

Set the networkRuleSet property: Network-specific rules that determine how the search service may be reached.

Parameters:

networkRuleSet - the networkRuleSet value to set.

Returns:

the SearchServiceInner object itself.

withPartitionCount

public SearchServiceInner withPartitionCount(Integer partitionCount)

Set the partitionCount property: 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.

Parameters:

partitionCount - the partitionCount value to set.

Returns:

the SearchServiceInner object itself.

withPublicNetworkAccess

public SearchServiceInner withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: 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.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the SearchServiceInner object itself.

withReplicaCount

public SearchServiceInner withReplicaCount(Integer replicaCount)

Set the replicaCount property: 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.

Parameters:

replicaCount - the replicaCount value to set.

Returns:

the SearchServiceInner object itself.

withSemanticSearch

public SearchServiceInner withSemanticSearch(SearchSemanticSearch semanticSearch)

Set the semanticSearch property: Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.

Parameters:

semanticSearch - the semanticSearch value to set.

Returns:

the SearchServiceInner object itself.

withSku

public SearchServiceInner withSku(Sku sku)

Set the sku property: The SKU of the search service, which determines billing rate and capacity limits. This property is required when creating a new search service.

Parameters:

sku - the sku value to set.

Returns:

the SearchServiceInner object itself.

withTags

public SearchServiceInner withTags(Map tags)

Overrides:

SearchServiceInner.withTags(Map<String,String> tags)

Parameters:

tags

Applies to