Azure.Provisioning.Search Namespace

Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true.

Describes a policy that determines how resources within the search service are to be encrypted with customer managed keys.

Parameter group.

SearchPrivateEndpointConnection.

Supported SearchPrivateEndpointConnection resource versions.

A class representing the SearchPrivateEndpointConnection data model. Describes an existing private endpoint connection to the Azure AI Search service.

SearchService.

Supported SearchService resource versions.

The IP restriction rule of the Azure AI Search service.

Network specific rules that determine how the Azure AI Search service may be reached.

Describes the properties of an existing private endpoint connection to the search service.

Describes the current state of an existing Azure Private Link service connection to the private endpoint.

SharedSearchServicePrivateLink.

Supported SharedSearchServicePrivateLink resource versions.

A class representing the SharedSearchServicePrivateLinkResource data model. Describes a shared private link resource managed by the Azure AI Search service.

Describes the properties of an existing Shared Private Link Resource managed by the search service.

Built-in Search roles that you can assign to users, groups, service principals, and managed identities.

Describes what response the data plane API of a search service would send for requests that failed authentication.

Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.

A specific data exfiltration scenario that is disabled for the service.

Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.

Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key.

The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations.

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'.

Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

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.

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.

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.

The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'.

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. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.