SearchService interface

包:

@azure/arm-search

介绍 Azure AI 搜索服务及其当前状态。

扩展

TrackedResource

属性

authOptions	定义搜索服务的数据平面 API 如何对请求进行身份验证的选项。 如果“disableLocalAuth”设置为 true，则无法设置此项。
computeType	配置此属性以支持使用默认计算或 Azure 机密计算的搜索服务。
dataExfiltrationProtections	显式禁止搜索服务的数据外泄方案列表。 目前，唯一支持的值是“全部”，用于禁用所有可能的数据导出方案，并计划将来进行更精细的控制。
disableLocalAuth	如果设置为 true，则不允许调用搜索服务以使用 API 密钥进行身份验证。 如果定义了“dataPlaneAuthOptions”，则无法将其设置为 true。
encryptionWithCmk	指定有关使用搜索服务中的客户经理密钥加密资源（如索引）的任何策略。
endpoint	Azure AI 搜索服务的终结点。
eTag	一个系统生成的属性，表示服务 etag，可用于在更新期间进行乐观并发控制。 注意：此属性不会序列化。 它只能由服务器填充。
hostingMode	仅适用于 standard3 SKU。 可以将此属性设置为最多允许 3 个高密度分区，允许最多 1000 个索引，这远远高于任何其他 SKU 允许的最大索引。 对于 standard3 SKU，该值为“default”或“highDensity”。 对于所有其他 SKU，此值必须为“default”。
identity	资源的标识。
networkRuleSet	确定如何访问 Azure AI 搜索服务的网络特定规则。
partitionCount	搜索服务中的分区数;如果指定，则它可以是 1、2、3、4、6 或 12。 大于 1 的值仅适用于标准 SKU。 对于 hostingMode 设置为“highDensity”的“standard3”服务，允许的值介于 1 到 3 之间。
privateEndpointConnections	与 Azure AI 搜索服务的专用终结点连接列表。 注意：此属性不会序列化。 它只能由服务器填充。
provisioningState	对搜索服务执行的最后一个预配作的状态。 预配是在建立服务容量时发生的中间状态。 设置容量后，provisioningState 将更改为“Succeeded”或“Failed”。 客户端应用程序可以使用“获取搜索服务”作来轮询预配状态（建议的轮询间隔为 30 秒到 1 分钟），以查看作何时完成。 如果使用免费服务，此值在调用“创建搜索服务”时倾向于直接返回为“Succeeded”。 这是因为免费服务使用已设置的容量。 注意：此属性不会序列化。 它只能由服务器填充。
publicNetworkAccess	此值可以设置为“已启用”，以避免对现有客户资源和模板进行重大更改。 如果设置为“disabled”，则不允许通过公共接口的流量，专用终结点连接将是独占访问方法。
replicaCount	搜索服务中的副本数。 如果指定，它必须是标准 SKU 的 1 到 12（含 1 到 3）之间的值，对于基本 SKU，该值必须介于 1 和 3 之间。
semanticSearch	设置控制语义搜索可用性的选项。 此配置仅适用于特定位置的某些 Azure AI 搜索 SKU。
serviceUpgradedAt	上次升级搜索服务的日期和时间。 此字段将为 null，直到服务首次升级。 注意：此属性不会序列化。 它只能由服务器填充。
sharedPrivateLinkResources	由 Azure AI 搜索服务管理的共享专用链接资源列表。 注意：此属性不会序列化。 它只能由服务器填充。
sku	搜索服务的 SKU，用于确定价格层和容量限制。 创建新搜索服务时，此属性是必需的。
status	搜索服务的状态。 可能的值包括：“running”：搜索服务正在运行，未执行任何预配作。 “provisioning”：正在预配或纵向扩展或缩减搜索服务。 “delete”：正在删除搜索服务。 “已降级”：搜索服务已降级。 当基础搜索单元不正常时，可能会发生这种情况。 搜索服务最有可能正常运行，但性能可能很慢，某些请求可能会被删除。 “disabled”：已禁用搜索服务。 在此状态下，服务将拒绝所有 API 请求。 “error”：搜索服务处于错误状态。 “stopped”：搜索服务位于已禁用的订阅中。 如果服务处于降级、禁用或错误状态，则意味着 Azure AI 搜索团队正在积极调查根本问题。 根据预配的搜索单位数，这些状态中的专用服务仍可收费。 注意：此属性不会序列化。 它只能由服务器填充。
statusDetails	搜索服务状态的详细信息。 注意：此属性不会序列化。 它只能由服务器填充。
upgradeAvailable	指示搜索服务是否有可用的升级。

继承属性

id	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”注意：此属性不会序列化。 它只能由服务器填充。
location	资源所在的地理位置
name	资源说明的名称：此属性不会序列化。 它只能由服务器填充。
systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。
tags	资源标记。
type	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。

属性详细信息

authOptions

定义搜索服务的数据平面 API 如何对请求进行身份验证的选项。 如果“disableLocalAuth”设置为 true，则无法设置此项。

authOptions?: DataPlaneAuthOptions

属性值

DataPlaneAuthOptions

computeType

配置此属性以支持使用默认计算或 Azure 机密计算的搜索服务。

computeType?: string

属性值

string

dataExfiltrationProtections

显式禁止搜索服务的数据外泄方案列表。 目前，唯一支持的值是“全部”，用于禁用所有可能的数据导出方案，并计划将来进行更精细的控制。

dataExfiltrationProtections?: string[]

属性值

string[]

disableLocalAuth

如果设置为 true，则不允许调用搜索服务以使用 API 密钥进行身份验证。 如果定义了“dataPlaneAuthOptions”，则无法将其设置为 true。

disableLocalAuth?: boolean

属性值

boolean

encryptionWithCmk

指定有关使用搜索服务中的客户经理密钥加密资源（如索引）的任何策略。

encryptionWithCmk?: EncryptionWithCmk

属性值

EncryptionWithCmk

endpoint

Azure AI 搜索服务的终结点。

endpoint?: string

属性值

string

eTag

一个系统生成的属性，表示服务 etag，可用于在更新期间进行乐观并发控制。 注意：此属性不会序列化。 它只能由服务器填充。

eTag?: string

属性值

string

hostingMode

仅适用于 standard3 SKU。 可以将此属性设置为最多允许 3 个高密度分区，允许最多 1000 个索引，这远远高于任何其他 SKU 允许的最大索引。 对于 standard3 SKU，该值为“default”或“highDensity”。 对于所有其他 SKU，此值必须为“default”。

hostingMode?: HostingMode

属性值

HostingMode

identity

资源的标识。

identity?: Identity

属性值

Identity

networkRuleSet

确定如何访问 Azure AI 搜索服务的网络特定规则。

networkRuleSet?: NetworkRuleSet

属性值

NetworkRuleSet

partitionCount

搜索服务中的分区数;如果指定，则它可以是 1、2、3、4、6 或 12。 大于 1 的值仅适用于标准 SKU。 对于 hostingMode 设置为“highDensity”的“standard3”服务，允许的值介于 1 到 3 之间。

partitionCount?: number

属性值

number

privateEndpointConnections

与 Azure AI 搜索服务的专用终结点连接列表。 注意：此属性不会序列化。 它只能由服务器填充。

privateEndpointConnections?: PrivateEndpointConnection[]

属性值

PrivateEndpointConnection[]

provisioningState

对搜索服务执行的最后一个预配作的状态。 预配是在建立服务容量时发生的中间状态。 设置容量后，provisioningState 将更改为“Succeeded”或“Failed”。 客户端应用程序可以使用“获取搜索服务”作来轮询预配状态（建议的轮询间隔为 30 秒到 1 分钟），以查看作何时完成。 如果使用免费服务，此值在调用“创建搜索服务”时倾向于直接返回为“Succeeded”。 这是因为免费服务使用已设置的容量。 注意：此属性不会序列化。 它只能由服务器填充。

provisioningState?: ProvisioningState

属性值

ProvisioningState

publicNetworkAccess

此值可以设置为“已启用”，以避免对现有客户资源和模板进行重大更改。 如果设置为“disabled”，则不允许通过公共接口的流量，专用终结点连接将是独占访问方法。

publicNetworkAccess?: string

属性值

string

replicaCount

搜索服务中的副本数。 如果指定，它必须是标准 SKU 的 1 到 12（含 1 到 3）之间的值，对于基本 SKU，该值必须介于 1 和 3 之间。

replicaCount?: number

属性值

number

semanticSearch

设置控制语义搜索可用性的选项。 此配置仅适用于特定位置的某些 Azure AI 搜索 SKU。

semanticSearch?: string

属性值

string

serviceUpgradedAt

上次升级搜索服务的日期和时间。 此字段将为 null，直到服务首次升级。 注意：此属性不会序列化。 它只能由服务器填充。

serviceUpgradedAt?: Date

属性值

Date

sharedPrivateLinkResources

由 Azure AI 搜索服务管理的共享专用链接资源列表。 注意：此属性不会序列化。 它只能由服务器填充。

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

属性值

SharedPrivateLinkResource[]

sku

搜索服务的 SKU，用于确定价格层和容量限制。 创建新搜索服务时，此属性是必需的。

sku?: Sku

属性值

Sku

status

搜索服务的状态。 可能的值包括：“running”：搜索服务正在运行，未执行任何预配作。 “provisioning”：正在预配或纵向扩展或缩减搜索服务。 “delete”：正在删除搜索服务。 “已降级”：搜索服务已降级。 当基础搜索单元不正常时，可能会发生这种情况。 搜索服务最有可能正常运行，但性能可能很慢，某些请求可能会被删除。 “disabled”：已禁用搜索服务。 在此状态下，服务将拒绝所有 API 请求。 “error”：搜索服务处于错误状态。 “stopped”：搜索服务位于已禁用的订阅中。 如果服务处于降级、禁用或错误状态，则意味着 Azure AI 搜索团队正在积极调查根本问题。 根据预配的搜索单位数，这些状态中的专用服务仍可收费。 注意：此属性不会序列化。 它只能由服务器填充。

status?: SearchServiceStatus

属性值

SearchServiceStatus

statusDetails

搜索服务状态的详细信息。 注意：此属性不会序列化。 它只能由服务器填充。

statusDetails?: string

属性值

string

upgradeAvailable

指示搜索服务是否有可用的升级。

upgradeAvailable?: string

属性值

string

继承属性详细信息

id

资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”注意：此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自 TrackedResource.id 的

location

资源所在的地理位置

location: string

属性值

string

继承自TrackedResource.location

name

资源说明的名称：此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自 TrackedResource.name 的

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。

systemData?: SystemData

属性值

SystemData

继承自TrackedResource.systemData

tags

资源标记。

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自TrackedResource.tags

type

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自TrackedResource.type