SearchServiceUpdate interface

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.

authOptions?: DataPlaneAuthOptions

Property Value

Configure this property to support the search service using either the Default Compute or Azure Confidential Compute.

computeType?: string

Property Value

A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future.

dataExfiltrationProtections?: string[]

Property Value

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.

disableLocalAuth?: boolean

Property Value

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

encryptionWithCmk?: EncryptionWithCmk

Property Value

The endpoint of the Azure AI Search service.

endpoint?: string

Property Value

A system generated property representing the service's etag that can be for optimistic concurrency control during updates.

eTag?: string

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

hostingMode?: HostingMode

Property Value

Details about the search service identity. A null value indicates that the search service has no identity assigned.

identity?: Identity

Property Value

Specifies the billing plan for agentic retrieval on the Azure AI Search service. This configuration is only available for certain pricing tiers in certain regions.

knowledgeRetrieval?: string

Property Value

The geographic location of the resource. This must be one of the supported and registered Azure geo regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.

location?: string

Property Value

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

networkRuleSet?: NetworkRuleSet

Property Value

The number of partitions in the dedicated 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.

partitionCount?: number

Property Value

The list of private endpoint connections to the Azure AI Search service.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

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.

provisioningState?: ProvisioningState

Property Value

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.

publicNetworkAccess?: string

Property Value

The number of replicas in the dedicated 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.

replicaCount?: number

Property Value

Specifies the availability and billing plan for semantic search on the Azure AI Search service. This configuration is only available for certain pricing tiers in certain regions.

semanticSearch?: string

Property Value

The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time.

serviceUpgradedAt?: Date

Property Value

The list of shared private link resources managed by the Azure AI Search service.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Property Value

The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service.

sku?: Sku

Property Value

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.

status?: SearchServiceStatus

Property Value

The details of the search service status.

statusDetails?: string

Property Value

Tags to help categorize the resource in the Azure portal.

tags?: Record<string, string>

Property Value

Indicates if the search service has an upgrade available.

upgradeAvailable?: string

Property Value

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

Inherited From Resource.id

The name of the resource

name?: string

Property Value

Inherited From Resource.name

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From Resource.systemData

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

Inherited From Resource.type