你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SearchServiceUpdate interface

包:

@azure/arm-search

用于更新Azure 认知搜索服务的参数。

扩展

Resource

属性

authOptions	定义搜索服务的数据平面 API 如何对请求进行身份验证的选项。 如果“disableLocalAuth”设置为 true，则无法设置此值。
disableLocalAuth	如果设置为 true，则不允许对搜索服务的调用利用 API 密钥进行身份验证。 如果定义了“dataPlaneAuthOptions”，则不能将其设置为 true。
encryptionWithCmk	指定有关使用搜索服务中客户经理密钥) 资源 (（例如索引）加密的任何策略。
hostingMode	仅适用于 standard3 SKU。 可以将此属性设置为启用最多 3 个高密度分区，允许最多 1000 个索引，这远远高于任何其他 SKU 允许的最大索引数。 对于 standard3 SKU，该值为“default”或“highDensity”。 对于所有其他 SKU，此值必须为“default”。
identity	资源的标识。
location	资源的地理位置。 这必须是支持和注册的 Azure 地理区域之一， (例如，美国西部、美国东部、东南亚等) 。 创建新资源时需要此属性。
networkRuleSet	确定如何访问Azure 认知搜索服务的网络特定规则。
partitionCount	搜索服务中的分区数;如果指定，它可以是 1、2、3、4、6 或 12。 大于 1 的值仅对标准 SKU 有效。 对于 hostingMode 设置为“highDensity”的“standard3”服务，允许的值介于 1 和 3 之间。
privateEndpointConnections	与Azure 认知搜索服务的专用终结点连接列表。 注意：此属性不会被序列化。 它只能由服务器填充。
provisioningState	对搜索服务执行的最后一个预配操作的状态。 “正在设置”是一种中间状态，在建立服务容量时出现。 设置容量后，provisioningState 将更改为“succeeded”或“failed”。 客户端应用程序可以使用获取搜索服务操作查看操作完成时间， (建议的轮询间隔为 30 秒到一分钟) 轮询预配状态。 如果使用免费服务，则此值往往在调用创建搜索服务时直接以“成功”的形式返回。 这是因为免费服务使用了已设置的容量。 注意：此属性不会被序列化。 它只能由服务器填充。
publicNetworkAccess	此值可以设置为“已启用”，以避免对现有客户资源和模板进行中断性变更。 如果设置为“disabled”，则不允许通过公共接口的流量，专用终结点连接将是独占访问方法。
replicaCount	搜索服务中的副本数。 如果指定，则对于标准 SKU，该值必须是介于 1 到 12（非独占）之间，对于基本 SKU，该值必须是介于 1 到 3（非独占）之间的值。
semanticSearch	设置控制语义搜索可用性的选项。 此配置仅适用于某些位置的某些Azure 认知搜索 SKU。
sharedPrivateLinkResources	由Azure 认知搜索服务管理的共享专用链接资源的列表。 注意：此属性不会被序列化。 它只能由服务器填充。
sku	搜索服务的 SKU，用于确定价格层和容量限制。 创建新的搜索服务时，此属性是必需的。
status	搜索服务的状态。 可能的值包括：“running”：搜索服务正在运行，并且没有预配操作正在进行中。 “预配”：正在预配或纵向扩展或缩减搜索服务。 “正在删除”：正在删除搜索服务。 “已降级”：搜索服务已降级。 当基础搜索单元不正常时，可能会发生这种情况。 搜索服务最有可能正常运行，但性能可能很慢，某些请求可能会被删除。 “disabled”：搜索服务已禁用。 在此状态下，服务将拒绝所有 API 请求。 “error”：搜索服务处于错误状态。 如果服务处于降级、禁用或错误状态，则表示Azure 认知搜索团队正在积极调查根本问题。 这些状态下的专用服务仍根据预配的搜索单位数收费。 注意：此属性不会被序列化。 它只能由服务器填充。
statusDetails	搜索服务状态的详细信息。 注意：此属性不会被序列化。 它只能由服务器填充。
tags	用于帮助对Azure 门户中的资源进行分类的标记。

继承属性

id	资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会被序列化。 它只能由服务器填充。
name	资源的名称 注意：此属性不会被序列化。 它只能由服务器填充。
type	资源类型。 例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会被序列化。 它只能由服务器填充。

属性详细信息

authOptions

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

authOptions?: DataPlaneAuthOptions

属性值

DataPlaneAuthOptions

disableLocalAuth

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

disableLocalAuth?: boolean

属性值

boolean

encryptionWithCmk

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

encryptionWithCmk?: EncryptionWithCmk

属性值

EncryptionWithCmk

hostingMode

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

hostingMode?: HostingMode

属性值

HostingMode

identity

资源的标识。

identity?: Identity

属性值

Identity

location

资源的地理位置。 这必须是支持和注册的 Azure 地理区域之一， (例如，美国西部、美国东部、东南亚等) 。 创建新资源时需要此属性。

location?: string

属性值

string

networkRuleSet

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

networkRuleSet?: NetworkRuleSet

属性值

NetworkRuleSet

partitionCount

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

partitionCount?: number

属性值

number

privateEndpointConnections

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

privateEndpointConnections?: PrivateEndpointConnection[]

属性值

PrivateEndpointConnection[]

provisioningState

对搜索服务执行的最后一个预配操作的状态。 “正在设置”是一种中间状态，在建立服务容量时出现。 设置容量后，provisioningState 将更改为“succeeded”或“failed”。 客户端应用程序可以使用获取搜索服务操作查看操作完成时间， (建议的轮询间隔为 30 秒到一分钟) 轮询预配状态。 如果使用免费服务，则此值往往在调用创建搜索服务时直接以“成功”的形式返回。 这是因为免费服务使用了已设置的容量。 注意：此属性不会被序列化。 它只能由服务器填充。

provisioningState?: ProvisioningState

属性值

ProvisioningState

publicNetworkAccess

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

publicNetworkAccess?: PublicNetworkAccess

属性值

PublicNetworkAccess

replicaCount

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

replicaCount?: number

属性值

number

semanticSearch

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

semanticSearch?: string

属性值

string

sharedPrivateLinkResources

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

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

属性值

SharedPrivateLinkResource[]

sku

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

sku?: Sku

属性值

Sku

status

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

status?: SearchServiceStatus

属性值

SearchServiceStatus

statusDetails

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

statusDetails?: string

属性值

string

tags

用于帮助对Azure 门户中的资源进行分类的标记。

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

属性值

{[propertyName: string]: string}

继承属性详细信息

id

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

id?: string

属性值

string

继承自Resource.id

name

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

name?: string

属性值

string

继承自Resource.name

type

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

type?: string

属性值

string

继承自Resource.type