Microsoft.Search searchServices
Bicep 資源定義
searchServices 資源類型可以使用目標作業進行部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.Search/searchServices 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.Search/searchServices@2023-11-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
identity: {
type: 'string'
}
properties: {
authOptions: {
aadOrApiKey: {
aadAuthFailureMode: 'string'
}
apiKeyOnly: any()
}
disableLocalAuth: bool
encryptionWithCmk: {
enforcement: 'string'
}
hostingMode: 'string'
networkRuleSet: {
ipRules: [
{
value: 'string'
}
]
}
partitionCount: int
publicNetworkAccess: 'string'
replicaCount: int
semanticSearch: 'string'
}
}
屬性值
searchServices
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 | 字串 (必要) |
| location | 資源所在的地理位置 | 字串 (必要) |
| tags | 資源標籤。 | 標記名稱和值的字典。 請參閱 範本中的標記 |
| sku | 搜尋服務的 SKU，決定計費率和容量限制。 建立新的搜尋服務時，需要這個屬性。 | Sku |
| 身分識別 | 資源的身分識別。 | 身分識別 |
| properties | 搜尋服務的屬性。 | SearchServiceProperties |
Identity
| 名称 | 描述 | 值 |
|---|---|---|
| 類型 | 識別類型。 | 'None' 'SystemAssigned' (必要) |
SearchServiceProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| authOptions | 定義搜尋服務數據平面 API 如何驗證要求的選項。 如果 'disableLocalAuth' 設定為 true，則無法設定此設定。 | DataPlaneAuthOptions |
| disableLocalAuth | 設定為 true 時，不允許對搜尋服務的呼叫利用 API 金鑰進行驗證。 如果定義 『dataPlaneAuthOptions』，則無法將此設定為 true。 | bool |
| encryptionWithCmk | 指定任何有關資源加密的原則 (，例如在搜尋服務中使用客戶管理員密鑰) 索引。 | EncryptionWithCmk |
| hostingMode | 僅適用於 standard3 SKU。 您可以設定此屬性來啟用最多 3 個高密度分割區，允許最多 1000 個索引，這比任何其他 SKU 允許的最大索引還要高。 針對 standard3 SKU，此值為 'default' 或 'highDensity'。 對於所有其他 SKU，此值必須是 'default'。 | 'default' 'highDensity' |
| networkRuleSet | 決定如何連線到搜尋服務的網路特定規則。 | NetworkRuleSet |
| partitionCount | 搜尋服務中的數據分割數目;如果指定，它可以是 1、2、3、4、6 或 12。 大於 1 的值僅適用於標準 SKU。 對於 hostingMode 設為 'highDensity' 的 'standard3' 服務，允許的值介於 1 到 3 之間。 | int 約束： 最小值 = 1 最大值 = 12 |
| publicNetworkAccess | 此值可以設定為 「已啟用」，以避免現有客戶資源和範本的重大變更。 如果設定為 『disabled』，則不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。 | 'disabled' 'enabled' |
| replicaCount | 搜尋服務中的複本數目。 如果指定，它必須是標準 SKU 介於 1 到 12 之間的值，或基本 SKU 包含 1 到 3 之間的值。 | int 約束： 最小值 = 1 最大值 = 12 |
| semanticSearch | 設定控制語意搜尋可用性的選項。 此設定僅適用於特定位置中的特定搜尋 SKU。 | 'disabled' 'free' 'standard' |
DataPlaneAuthOptions
| 名稱 | 描述 | 值 |
|---|---|---|
| aadOrApiKey | 表示 API 金鑰或來自 Microsoft Entra ID 租使用者的存取令牌可用於驗證。 | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | 表示只能使用 API 金鑰進行驗證。 | 針對 Bicep，您可以使用 任何 () 函式。 |
DataPlaneAadOrApiKeyAuthOption
| 名稱 | 描述 | 值 |
|---|---|---|
| aadAuthFailureMode | 描述搜尋服務的數據平面 API 會針對驗證失敗的要求傳送哪些回應。 | 'http401WithBearerChallenge' 'http403' |
EncryptionWithCmk
| 名稱 | 描述 | 值 |
|---|---|---|
| 執法 | 描述搜尋服務應如何強制執行一或多個非客戶加密的資源。 | 'Disabled' 'Enabled' 'Unspecified' |
NetworkRuleSet
| 名稱 | 描述 | 值 |
|---|---|---|
| ipRules | 用於IP防火牆的IP限制規則清單。 防火牆會封鎖不符合規則的任何IP。 只有在搜尋服務的 'publicNetworkAccess' 已啟用時，才會套用這些規則。 | IpRule[] |
IpRule
| 名稱 | 描述 | 值 |
|---|---|---|
| 值 | 對應至單一 IPv4 位址的值 (例如 123.1.2.3) 或 CIDR 格式的 IP 範圍 (，例如 123.1.2.3/24) 。 | 字串 |
SKU
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 搜尋服務的 SKU。 有效值包括：『free』：共用服務。 'basic'：最多 3 個複本的專用服務。 'standard'：最多 12 個分割區和 12 個復本的專用服務。 'standard2'：類似於標準，但每個搜尋單位具有更多容量。 'standard3'：如果您也將 hostingMode 屬性設定為 'highDensity') ，則最多 12 個分割區和 12 個復本 (或最多 3 個分割區的標準供應專案。 'storage_optimized_l1'：支援每個分割區 1TB，最多可支援 12 個分割區。 'storage_optimized_l2'：支援每個分割區 2TB，最多 12 個分割區。」 | 'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2' |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
具有 SQL Database、Azure Cosmos DB、Azure 搜尋服務的 Web 應用程式 |
此範本會布建 Web 應用程式、SQL Database、Azure Cosmos DB、Azure 搜尋服務和 Application Insights。 |
| Azure 認知搜尋服務 |
此範本會建立 Azure 認知搜尋 服務 |
| 使用私人端點 Azure 認知搜尋 服務 |
此範本會建立具有私人端點 Azure 認知搜尋 服務。 |
ARM 範本資源定義
searchServices 資源類型可以使用目標作業進行部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Search/searchServices 資源，請將下列 JSON 新增至您的範本。
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2023-11-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"identity": {
"type": "string"
},
"properties": {
"authOptions": {
"aadOrApiKey": {
"aadAuthFailureMode": "string"
},
"apiKeyOnly": {}
},
"disableLocalAuth": "bool",
"encryptionWithCmk": {
"enforcement": "string"
},
"hostingMode": "string",
"networkRuleSet": {
"ipRules": [
{
"value": "string"
}
]
},
"partitionCount": "int",
"publicNetworkAccess": "string",
"replicaCount": "int",
"semanticSearch": "string"
}
}
屬性值
searchServices
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.Search/searchServices' |
| apiVersion | 資源 API 版本 | '2023-11-01' |
| NAME | 資源名稱 | 需要字串 () |
| location | 資源所在的地理位置 | 需要字串 () |
| tags | 資源標籤。 | 標記名稱和值的字典。 請參閱 範本中的標籤 |
| sku | 搜尋服務的 SKU，決定計費率和容量限制。 建立新的搜尋服務時，需要這個屬性。 | Sku |
| 身分識別 | 資源的身分識別。 | 身分識別 |
| properties | 搜尋服務的屬性。 | SearchServiceProperties |
Identity
| 名称 | 描述 | 值 |
|---|---|---|
| 類型 | 識別類型。 | 'None' 需要 『SystemAssigned』 () |
SearchServiceProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| authOptions | 定義搜尋服務數據平面 API 如何驗證要求的選項。 如果 'disableLocalAuth' 設定為 true，則無法設定此設定。 | DataPlaneAuthOptions |
| disableLocalAuth | 當設定為 true 時，不允許對搜尋服務的呼叫利用 API 金鑰進行驗證。 如果已定義 『dataPlaneAuthOptions』，則無法將此設定為 true。 | bool |
| encryptionWithCmk | 指定任何有關資源加密的原則 (，例如在搜尋服務中使用客戶經理密鑰) 索引等資源加密。 | EncryptionWithCmk |
| hostingMode | 僅適用於 standard3 SKU。 您可以設定此屬性來啟用最多 3 個高密度分割區，最多允許 1000 個索引，這遠高於任何其他 SKU 允許的最大索引。 針對 standard3 SKU，此值為 'default' 或 'highDensity'。 對於所有其他 SKU，此值必須是 'default'。 | 'default' 'highDensity' |
| networkRuleSet | 決定搜尋服務如何連線的網路特定規則。 | NetworkRuleSet |
| partitionCount | 搜尋服務中的數據分割數目;如果指定，它可以是 1、2、3、4、6 或 12。 大於 1 的值僅適用於標準 SKU。 對於 hostingMode 設定為 'highDensity' 的 'standard3' 服務，允許的值介於 1 到 3 之間。 | int 約束： 最小值 = 1 最大值 = 12 |
| publicNetworkAccess | 此值可以設定為 「已啟用」，以避免對現有的客戶資源和範本進行重大變更。 如果設定為 「已停用」，則不允許透過公用介面的流量，而且私人端點聯機會是獨佔存取方法。 | 'disabled' 'enabled' |
| replicaCount | 搜尋服務中的複本數目。 如果指定，它必須是標準 SKU 介於 1 到 12 之間的值，或基本 SKU 的 1 到 3 內含值。 | int 約束： 最小值 = 1 最大值 = 12 |
| semanticSearch | 設定控制語意搜尋可用性的選項。 此設定僅適用於特定位置中的特定搜尋 SKU。 | 'disabled' 'free' 'standard' |
DataPlaneAuthOptions
| 名稱 | 描述 | 值 |
|---|---|---|
| aadOrApiKey | 表示 API 金鑰或來自 Microsoft Entra ID 租使用者的存取令牌可用於驗證。 | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | 表示只能使用 API 金鑰進行驗證。 |
DataPlaneAadOrApiKeyAuthOption
| 名稱 | 描述 | 值 |
|---|---|---|
| aadAuthFailureMode | 描述搜尋服務的數據平面 API 會針對驗證失敗的要求傳送哪些回應。 | 'http401WithBearerChallenge' 'http403' |
EncryptionWithCmk
| 名稱 | 描述 | 值 |
|---|---|---|
| 執法 | 描述搜尋服務應如何強制執行一或多個非客戶加密的資源。 | 'Disabled' 'Enabled' 'Unspecified' |
NetworkRuleSet
| 名稱 | 描述 | 值 |
|---|---|---|
| ipRules | 用於IP防火牆的IP限制規則清單。 防火牆會封鎖不符合規則的任何IP。 只有在搜尋服務的 'publicNetworkAccess' 已啟用時，才會套用這些規則。 | IpRule[] |
IpRule
| 名稱 | 描述 | 值 |
|---|---|---|
| 值 | 對應至單一 IPv4 位址的值 (例如 123.1.2.3) 或 CIDR 格式的 IP 範圍 (，例如 123.1.2.3/24) 。 | 字串 |
SKU
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 搜尋服務的 SKU。 有效值包括：『free』：共用服務。 'basic'：最多 3 個複本的專用服務。 'standard'：最多 12 個分割區和 12 個復本的專用服務。 'standard2'：類似於標準，但每個搜尋單位具有更多容量。 'standard3'：如果您也將 hostingMode 屬性設定為 'highDensity') ，則最多 12 個分割區和 12 個復本 (或最多 3 個數據分割的標準供應專案。 'storage_optimized_l1'：支援每個分割區 1TB，最多 12 個分割區。 'storage_optimized_l2'：支援每個分割區 2TB，最多 12 個數據分割。」 | 'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2' |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
| 具有 SQL Database、Azure Cosmos DB、Azure 搜尋服務的 Web 應用程式 |
此範本會布建 Web 應用程式、SQL Database、Azure Cosmos DB、Azure 搜尋服務和 Application Insights。 |
| Azure 認知搜尋服務 |
此範本會建立 Azure 認知搜尋 服務 |
| 使用私人端點 Azure 認知搜尋 服務 |
此範本會使用私人端點建立 Azure 認知搜尋 服務。 |
Terraform (AzAPI 提供者) 資源定義
searchServices 資源類型可以使用目標作業進行部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.Search/searchServices 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices@2023-11-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
authOptions = {
aadOrApiKey = {
aadAuthFailureMode = "string"
}
}
disableLocalAuth = bool
encryptionWithCmk = {
enforcement = "string"
}
hostingMode = "string"
networkRuleSet = {
ipRules = [
{
value = "string"
}
]
}
partitionCount = int
publicNetworkAccess = "string"
replicaCount = int
semanticSearch = "string"
}
sku = {
name = "string"
}
})
}
屬性值
searchServices
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.Search/searchServices@2023-11-01” |
| NAME | 資源名稱 | 字串 (必要) |
| location | 資源所在的地理位置 | 字串 (必要) |
| parent_id | 若要部署至資源群組，請使用該資源群組的標識碼。 | 字串 (必要) |
| tags | 資源標籤。 | 標記名稱和值的字典。 |
| sku | 搜尋服務的 SKU，決定計費率和容量限制。 建立新的搜尋服務時，需要這個屬性。 | Sku |
| 身分識別 | 資源的身分識別。 | 身分識別 |
| properties | 搜尋服務的屬性。 | SearchServiceProperties |
Identity
| 名称 | 描述 | 值 |
|---|---|---|
| 類型 | 識別類型。 | “SystemAssigned” (必要) |
SearchServiceProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| authOptions | 定義搜尋服務數據平面 API 如何驗證要求的選項。 如果 'disableLocalAuth' 設定為 true，則無法設定此設定。 | DataPlaneAuthOptions |
| disableLocalAuth | 設定為 true 時，不允許對搜尋服務的呼叫利用 API 金鑰進行驗證。 如果定義 『dataPlaneAuthOptions』，則無法將此設定為 true。 | bool |
| encryptionWithCmk | 指定任何有關資源加密的原則 (，例如在搜尋服務中使用客戶管理員密鑰) 索引。 | EncryptionWithCmk |
| hostingMode | 僅適用於 standard3 SKU。 您可以設定此屬性來啟用最多 3 個高密度分割區，允許最多 1000 個索引，這比任何其他 SKU 允許的最大索引還要高。 針對 standard3 SKU，此值為 'default' 或 'highDensity'。 對於所有其他 SKU，此值必須是 'default'。 | "default" “highDensity” |
| networkRuleSet | 決定如何連線到搜尋服務的網路特定規則。 | NetworkRuleSet |
| partitionCount | 搜尋服務中的數據分割數目;如果指定，它可以是 1、2、3、4、6 或 12。 大於 1 的值僅適用於標準 SKU。 對於 hostingMode 設為 'highDensity' 的 'standard3' 服務，允許的值介於 1 到 3 之間。 | int 約束： 最小值 = 1 最大值 = 12 |
| publicNetworkAccess | 此值可以設定為 「已啟用」，以避免現有客戶資源和範本的重大變更。 如果設定為 『disabled』，則不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。 | 「已停用」 「已啟用」 |
| replicaCount | 搜尋服務中的複本數目。 如果指定，它必須是標準 SKU 介於 1 到 12 之間的值，或基本 SKU 包含 1 到 3 之間的值。 | int 約束： 最小值 = 1 最大值 = 12 |
| semanticSearch | 設定控制語意搜尋可用性的選項。 此設定僅適用於特定位置中的特定搜尋 SKU。 | 「已停用」 “free” “standard” |
DataPlaneAuthOptions
| 名稱 | 描述 | 值 |
|---|---|---|
| aadOrApiKey | 指出 API 金鑰或來自 Microsoft Entra ID 租使用者的存取令牌可用於驗證。 | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | 表示只能使用 API 金鑰進行驗證。 |
DataPlaneAadOrApiKeyAuthOption
| 名稱 | 描述 | 值 |
|---|---|---|
| aadAuthFailureMode | 描述搜尋服務的數據平面 API 針對驗證失敗的要求傳送哪些回應。 | “http401WithBearerChallenge” “http403” |
EncryptionWithCmk
| 名稱 | 描述 | 值 |
|---|---|---|
| 執法 | 描述搜尋服務應如何強制執行一或多個非客戶加密的資源。 | “Disabled” “Enabled” “Unspecified” |
NetworkRuleSet
| 名稱 | 描述 | 值 |
|---|---|---|
| ipRules | 用於IP防火牆的IP限制規則清單。 防火牆會封鎖不符合規則的任何IP。 只有在搜尋服務的 'publicNetworkAccess' 已啟用時，才會套用這些規則。 | IpRule[] |
IpRule
| 名稱 | 描述 | 值 |
|---|---|---|
| 值 | 對應至單一 IPv4 位址的值 (例如 123.1.2.3) 或 CIDR 格式的 IP 範圍 (，例如 123.1.2.3/24) 。 | 字串 |
SKU
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 搜尋服務的 SKU。 有效值包括：『free』：共用服務。 'basic'：最多 3 個複本的專用服務。 'standard'：最多 12 個分割區和 12 個復本的專用服務。 'standard2'：類似於標準，但每個搜尋單位具有更多容量。 'standard3'：如果您也將 hostingMode 屬性設定為 'highDensity') ，則最多 12 個分割區和 12 個復本 (或最多 3 個數據分割的標準供應專案。 'storage_optimized_l1'：支援每個分割區 1TB，最多 12 個分割區。 'storage_optimized_l2'：支援每個分割區 2TB，最多 12 個數據分割。」 | “basic” “free” “standard” “standard2” “standard3” “storage_optimized_l1” “storage_optimized_l2” |
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應