SearchServiceUpdate interface

套件:

@azure/arm-search

用來更新 Azure AI 搜尋服務的參數。

Extends

Resource

屬性

authOptions	定義搜尋服務數據平面 API 如何驗證要求的選項。 如果 'disableLocalAuth' 設定為 true，則無法設定此設定。
computeType	設定此屬性以支援使用預設計算或 Azure 機密計算的搜尋服務。
dataExfiltrationProtections	明確不允許搜尋服務的數據外流案例清單。 目前，唯一支援的值是 『All』，以停用所有可能的數據匯出案例，並針對未來規劃更精細的控制。
disableLocalAuth	當設定為 true 時，不允許對搜尋服務的呼叫利用 API 金鑰進行驗證。 如果已定義 『dataPlaneAuthOptions』，則無法設定為 true。
encryptionWithCmk	指定在搜尋服務中使用客戶經理密鑰加密資源（例如索引）的任何原則。
endpoint	Azure AI 搜尋服務的端點。
eTag	系統產生的屬性，表示服務 etag，可在更新期間進行開放式並行控制。 注意：這個屬性不會串行化。 它只能由伺服器填入。
hostingMode	僅適用於 standard3 SKU。 您可以設定此屬性來啟用最多 3 個高密度分割區，允許最多 1000 個索引，這遠高於任何其他 SKU 允許的最大索引。 針對 standard3 SKU，此值為 'default' 或 'highDensity'。 對於所有其他 SKU，此值必須是 'default'。
identity	搜尋服務身分識別的詳細數據。 Null 值表示搜尋服務未指派任何身分識別。
location	資源的地理位置。 這必須是其中一個支援的和已註冊的 Azure 地理區域（例如美國西部、美國東部、東南亞等等）。 建立新資源時需要這個屬性。
networkRuleSet	決定如何觸達 Azure AI 搜尋服務的網路特定規則。
partitionCount	搜尋服務中的分割區數目;如果指定，它可以是 1、2、3、4、6 或 12。 大於 1 的值僅適用於標準 SKU。 對於 hostingMode 設定為 'highDensity' 的 'standard3' 服務，允許的值介於 1 到 3 之間。
privateEndpointConnections	Azure AI 搜尋服務的私人端點連線清單。 注意：這個屬性不會串行化。 它只能由伺服器填入。
provisioningState	在搜尋服務上執行的最後一個布建作業狀態。 布建是在建立服務容量時發生的中繼狀態。 設定容量之後，provisioningState 會變更為「成功」或「失敗」。 用戶端應用程式可以使用取得搜尋服務作業，來輪詢布建狀態（建議的輪詢間隔是從 30 秒到 1 分鐘），以查看作業何時完成。 如果您使用免費服務，此值通常會直接在呼叫建立搜尋服務時回復為「成功」。 這是因為免費服務會使用已設定的容量。 注意：這個屬性不會串行化。 它只能由伺服器填入。
publicNetworkAccess	此值可以設定為 「已啟用」，以避免現有客戶資源和範本發生重大變更。 如果設定為 『disabled』，則不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。
replicaCount	搜尋服務中的複本數目。 如果指定，它必須是標準 SKU 的 1 到 12 之間的值，或基本 SKU 的 1 到 3 之間。
semanticSearch	設定控制語意搜尋可用性的選項。 此設定僅適用於特定位置的特定 Azure AI 搜尋 SKU。
serviceUpgradedAt	上次升級搜尋服務的日期和時間。 此欄位將會是 Null，直到服務第一次升級為止。 注意：這個屬性不會串行化。 它只能由伺服器填入。
sharedPrivateLinkResources	Azure AI 搜尋服務所管理的共用私人鏈接資源清單。 注意：這個屬性不會串行化。 它只能由伺服器填入。
sku	搜尋服務的 SKU，決定價格區間和容量限制。 建立新的搜尋服務時，需要這個屬性。
status	搜尋服務的狀態。 可能的值包括：「執行中」：搜尋服務正在執行，且未進行任何布建作業。 「布建」：正在布建或相應增加或相應減少搜尋服務。 'delete'： 正在刪除搜尋服務。 「已降級」：搜尋服務已降級。 當基礎搜尋單位狀況不良時，就會發生這種情況。 搜尋服務最有可能運作，但效能可能很慢，而且可能會捨棄某些要求。 'disabled'：已停用搜尋服務。 在此狀態下，服務會拒絕所有 API 要求。 'error'：搜尋服務處於錯誤狀態。 「已停止」：搜尋服務位於已停用的訂用帳戶中。 如果您的服務處於降級、停用或錯誤狀態，表示 Azure AI 搜尋小組正在積極調查根本問題。 這些狀態中的專用服務仍會根據布建的搜尋單位數目收費。 注意：這個屬性不會串行化。 它只能由伺服器填入。
statusDetails	搜尋服務狀態的詳細數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
tags	標籤可協助在 Azure 入口網站中分類資源。
upgradeAvailable	指出搜尋服務是否有可用的升級。

繼承的屬性

id	資源的完整資源標識碼。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” 附注：此屬性將不會串行化。 它只能由伺服器填入。
name	資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。
systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
type	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。

屬性詳細資料

authOptions

定義搜尋服務數據平面 API 如何驗證要求的選項。 如果 'disableLocalAuth' 設定為 true，則無法設定此設定。

authOptions?: DataPlaneAuthOptions

屬性值

DataPlaneAuthOptions

computeType

設定此屬性以支援使用預設計算或 Azure 機密計算的搜尋服務。

computeType?: string

屬性值

string

dataExfiltrationProtections

明確不允許搜尋服務的數據外流案例清單。 目前，唯一支援的值是 『All』，以停用所有可能的數據匯出案例，並針對未來規劃更精細的控制。

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

搜尋服務身分識別的詳細數據。 Null 值表示搜尋服務未指派任何身分識別。

identity?: Identity

屬性值

Identity

location

資源的地理位置。 這必須是其中一個支援的和已註冊的 Azure 地理區域（例如美國西部、美國東部、東南亞等等）。 建立新資源時需要這個屬性。

location?: string

屬性值

string

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 會變更為「成功」或「失敗」。 用戶端應用程式可以使用取得搜尋服務作業，來輪詢布建狀態（建議的輪詢間隔是從 30 秒到 1 分鐘），以查看作業何時完成。 如果您使用免費服務，此值通常會直接在呼叫建立搜尋服務時回復為「成功」。 這是因為免費服務會使用已設定的容量。 注意：這個屬性不會串行化。 它只能由伺服器填入。

provisioningState?: ProvisioningState

屬性值

ProvisioningState

publicNetworkAccess

此值可以設定為 「已啟用」，以避免現有客戶資源和範本發生重大變更。 如果設定為 『disabled』，則不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。

publicNetworkAccess?: string

屬性值

string

replicaCount

搜尋服務中的複本數目。 如果指定，它必須是標準 SKU 的 1 到 12 之間的值，或基本 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

搜尋服務的狀態。 可能的值包括：「執行中」：搜尋服務正在執行，且未進行任何布建作業。 「布建」：正在布建或相應增加或相應減少搜尋服務。 'delete'： 正在刪除搜尋服務。 「已降級」：搜尋服務已降級。 當基礎搜尋單位狀況不良時，就會發生這種情況。 搜尋服務最有可能運作，但效能可能很慢，而且可能會捨棄某些要求。 'disabled'：已停用搜尋服務。 在此狀態下，服務會拒絕所有 API 要求。 'error'：搜尋服務處於錯誤狀態。 「已停止」：搜尋服務位於已停用的訂用帳戶中。 如果您的服務處於降級、停用或錯誤狀態，表示 Azure AI 搜尋小組正在積極調查根本問題。 這些狀態中的專用服務仍會根據布建的搜尋單位數目收費。 注意：這個屬性不會串行化。 它只能由伺服器填入。

status?: SearchServiceStatus

屬性值

SearchServiceStatus

statusDetails

搜尋服務狀態的詳細數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。

statusDetails?: string

屬性值

string

tags

標籤可協助在 Azure 入口網站中分類資源。

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

屬性值

{[propertyName: string]: string}

upgradeAvailable

指出搜尋服務是否有可用的升級。

upgradeAvailable?: string

屬性值

string

繼承的屬性詳細資料

id

資源的完整資源標識碼。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” 附注：此屬性將不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自Resource.id

name

資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自Resource.name

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。

systemData?: SystemData

屬性值

SystemData

繼承自Resource.systemData

type

資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自Resource.type