SearchServiceUpdate interface
用來更新Azure 認知搜尋服務的參數。
- Extends
屬性
auth |
定義搜尋服務資料平面 API 如何驗證要求的選項。 如果 'disableLocalAuth' 設定為 true,則無法設定此設定。 |
disable |
當設定為 true 時,不允許對搜尋服務的呼叫利用 API 金鑰進行驗證。 如果已定義 'dataPlaneAuthOptions',則無法將此設定為 true。 |
encryption |
指定任何有關資源加密的原則 (,例如在搜尋服務中使用客戶經理金鑰) 索引等資源加密。 |
hosting |
僅適用于 standard3 SKU。 您可以設定此屬性來啟用最多 3 個高密度分割區,最多允許 1000 個索引,這遠高於任何其他 SKU 允許的最大索引。 針對 standard3 SKU,此值為 'default' 或 'highDensity'。 對於所有其他 SKU,此值必須是 'default'。 |
identity | 資源的身分識別。 |
location | 資源的地理位置。 這必須是其中一個支援的和已註冊的 Azure 地理區域 (,例如美國西部、美國東部、東南亞等) 。 建立新資源時,需要這個屬性。 |
network |
決定如何連線到Azure 認知搜尋服務的網路特定規則。 |
partition |
搜尋服務中的資料分割數目;如果指定,它可以是 1、2、3、4、6 或 12。 大於 1 的值僅適用于標準 SKU。 對於 hostingMode 設定為 'highDensity' 的 'standard3' 服務,允許的值介於 1 到 3 之間。 |
private |
Azure 認知搜尋服務的私人端點連線清單。 注意:此屬性不會序列化。 它只能由伺服器填入。 |
provisioning |
在搜尋服務上執行的最後一個布建作業狀態。 佈建是一種過渡狀態,當服務容量正在建立時發生。 設定容量之後,provisioningState 會變更為「成功」或「失敗」。 用戶端應用程式可以使用取得搜尋服務作業來查看作業完成的時間, (建議的輪詢間隔是從 30 秒到一分鐘) 輪詢狀態。 如果您使用免費服務,此值通常會直接在建立搜尋服務的呼叫中回復為「成功」。 這是因為免費服務使用早已設定的容量。 注意:此屬性不會序列化。 它只能由伺服器填入。 |
public |
此值可以設定為 「已啟用」,以避免對現有的客戶資源和範本進行重大變更。 如果設定為 「已停用」,則不允許透過公用介面的流量,而且私人端點連線會是獨佔存取方法。 |
replica |
搜尋服務中的複本數目。 如果指定,它必須是標準 SKU 介於 1 到 12 之間的值,或基本 SKU 的 1 到 3 內含值。 |
semantic |
設定控制語意搜尋可用性的選項。 此設定僅適用于特定位置中的特定Azure 認知搜尋 SKU。 |
shared |
Azure 認知搜尋服務所管理的共用私人連結資源清單。 注意:此屬性不會序列化。 它只能由伺服器填入。 |
sku | 搜尋服務的 SKU,決定價格區間和容量限制。 建立新的搜尋服務時,需要這個屬性。 |
status | 搜尋服務的狀態。 可能的值包括:「執行中」:搜尋服務正在執行,且未進行任何布建作業。 「布建」:正在布建或相應增加或減少搜尋服務。 'delete':正在刪除搜尋服務。 「已降級」:搜尋服務已降級。 當基礎搜尋單位狀況不良時,就會發生這種情況。 搜尋服務最有可能運作,但效能可能會變慢,而且可能會捨棄某些要求。 'disabled':搜尋服務已停用。 在此狀態下,此服務將拒絕所有 API 要求。 'error':搜尋服務處於錯誤狀態。 如果您的服務處於降級、已停用或錯誤狀態,表示Azure 認知搜尋小組正在主動調查基礎問題。 根據已佈建的搜尋單位數目,在這些狀態下的專用服務仍需收費。 注意:此屬性不會序列化。 它只能由伺服器填入。 |
status |
搜尋服務狀態的詳細資料。 注意:此屬性不會序列化。 它只能由伺服器填入。 |
tags | 標籤,協助分類Azure 入口網站中的資源。 |
繼承的屬性
id | 資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意:此屬性不會序列化。 它只能由伺服器填入。 |
name | 資源名稱注意:此屬性不會序列化。 它只能由伺服器填入。 |
type | 資源類型。 例如「Microsoft.Compute/virtualMachines」 或 「Microsoft.Storage/storageAccounts」 注意:此屬性不會序列化。 它只能由伺服器填入。 |
屬性詳細資料
authOptions
定義搜尋服務資料平面 API 如何驗證要求的選項。 如果 'disableLocalAuth' 設定為 true,則無法設定此設定。
authOptions?: DataPlaneAuthOptions
屬性值
disableLocalAuth
當設定為 true 時,不允許對搜尋服務的呼叫利用 API 金鑰進行驗證。 如果已定義 'dataPlaneAuthOptions',則無法將此設定為 true。
disableLocalAuth?: boolean
屬性值
boolean
encryptionWithCmk
指定任何有關資源加密的原則 (,例如在搜尋服務中使用客戶經理金鑰) 索引等資源加密。
encryptionWithCmk?: EncryptionWithCmk
屬性值
hostingMode
僅適用于 standard3 SKU。 您可以設定此屬性來啟用最多 3 個高密度分割區,最多允許 1000 個索引,這遠高於任何其他 SKU 允許的最大索引。 針對 standard3 SKU,此值為 'default' 或 'highDensity'。 對於所有其他 SKU,此值必須是 'default'。
hostingMode?: HostingMode
屬性值
identity
location
資源的地理位置。 這必須是其中一個支援的和已註冊的 Azure 地理區域 (,例如美國西部、美國東部、東南亞等) 。 建立新資源時,需要這個屬性。
location?: string
屬性值
string
networkRuleSet
partitionCount
搜尋服務中的資料分割數目;如果指定,它可以是 1、2、3、4、6 或 12。 大於 1 的值僅適用于標準 SKU。 對於 hostingMode 設定為 'highDensity' 的 'standard3' 服務,允許的值介於 1 到 3 之間。
partitionCount?: number
屬性值
number
privateEndpointConnections
Azure 認知搜尋服務的私人端點連線清單。 注意:此屬性不會序列化。 它只能由伺服器填入。
privateEndpointConnections?: PrivateEndpointConnection[]
屬性值
provisioningState
在搜尋服務上執行的最後一個布建作業狀態。 佈建是一種過渡狀態,當服務容量正在建立時發生。 設定容量之後,provisioningState 會變更為「成功」或「失敗」。 用戶端應用程式可以使用取得搜尋服務作業來查看作業完成的時間, (建議的輪詢間隔是從 30 秒到一分鐘) 輪詢狀態。 如果您使用免費服務,此值通常會直接在建立搜尋服務的呼叫中回復為「成功」。 這是因為免費服務使用早已設定的容量。 注意:此屬性不會序列化。 它只能由伺服器填入。
provisioningState?: ProvisioningState
屬性值
publicNetworkAccess
此值可以設定為 「已啟用」,以避免對現有的客戶資源和範本進行重大變更。 如果設定為 「已停用」,則不允許透過公用介面的流量,而且私人端點連線會是獨佔存取方法。
publicNetworkAccess?: PublicNetworkAccess
屬性值
replicaCount
搜尋服務中的複本數目。 如果指定,它必須是標準 SKU 介於 1 到 12 之間的值,或基本 SKU 的 1 到 3 內含值。
replicaCount?: number
屬性值
number
semanticSearch
設定控制語意搜尋可用性的選項。 此設定僅適用于特定位置中的特定Azure 認知搜尋 SKU。
semanticSearch?: string
屬性值
string
sharedPrivateLinkResources
Azure 認知搜尋服務所管理的共用私人連結資源清單。 注意:此屬性不會序列化。 它只能由伺服器填入。
sharedPrivateLinkResources?: SharedPrivateLinkResource[]
屬性值
sku
status
搜尋服務的狀態。 可能的值包括:「執行中」:搜尋服務正在執行,且未進行任何布建作業。 「布建」:正在布建或相應增加或減少搜尋服務。 'delete':正在刪除搜尋服務。 「已降級」:搜尋服務已降級。 當基礎搜尋單位狀況不良時,就會發生這種情況。 搜尋服務最有可能運作,但效能可能會變慢,而且可能會捨棄某些要求。 'disabled':搜尋服務已停用。 在此狀態下,此服務將拒絕所有 API 要求。 'error':搜尋服務處於錯誤狀態。 如果您的服務處於降級、已停用或錯誤狀態,表示Azure 認知搜尋小組正在主動調查基礎問題。 根據已佈建的搜尋單位數目,在這些狀態下的專用服務仍需收費。 注意:此屬性不會序列化。 它只能由伺服器填入。
status?: SearchServiceStatus
屬性值
statusDetails
搜尋服務狀態的詳細資料。 注意:此屬性不會序列化。 它只能由伺服器填入。
statusDetails?: string
屬性值
string
tags
標籤,協助分類Azure 入口網站中的資源。
tags?: {[propertyName: string]: string}
屬性值
{[propertyName: string]: string}
繼承的屬性詳細資料
id
資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意:此屬性不會序列化。 它只能由伺服器填入。
id?: string
屬性值
string
繼承自Resource.id
name
type
資源類型。 例如「Microsoft.Compute/virtualMachines」 或 「Microsoft.Storage/storageAccounts」 注意:此屬性不會序列化。 它只能由伺服器填入。
type?: string
屬性值
string