Microsoft.Search searchServices

發行項
12/19/2024

Bicep 資源定義

searchServices 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Search/searchServices 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Search/searchServices@2024-06-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    authOptions: {
      aadOrApiKey: {
        aadAuthFailureMode: 'string'
      }
      apiKeyOnly: any(Azure.Bicep.Types.Concrete.AnyType)
    }
    disabledDataExfiltrationOptions: [
      'string'
    ]
    disableLocalAuth: bool
    encryptionWithCmk: {
      enforcement: 'string'
    }
    hostingMode: 'string'
    networkRuleSet: {
      bypass: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
    semanticSearch: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

DataPlaneAadOrApiKeyAuthOption

名字	描述	價值
aadAuthFailureMode	描述搜尋服務的數據平面 API 會針對驗證失敗的要求傳送哪些回應。	'http401WithBearerChallenge' 'http403'

DataPlaneAuthOptions

名字	描述	價值
aadOrApiKey	表示 API 金鑰或來自 Microsoft Entra ID 租使用者的存取令牌都可用於驗證。	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	表示只能使用 API 金鑰進行驗證。	任何

EncryptionWithCmk

名字	描述	價值
執法	描述搜尋服務在找到未使用客戶管理密鑰加密的物件時，應如何強制執行合規性。	'Disabled' 'Enabled' 'Unspecified'

身份

名字	描述	價值
類型	用於資源的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含系統所建立的身分識別和一組使用者指派的身分識別。類型『None』會從服務中移除所有身分識別。	'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned' （必要）
userAssignedIdentities	與資源相關聯的使用者身分識別清單。用戶識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。	UserAssignedManagedIdentities

IpRule

名字	描述	價值
價值	對應至單一 IPv4 位址的值（例如 123.1.2.3）或 CIDR 格式的 IP 範圍（例如 123.1.2.3/24）。	字串

Microsoft.Search/searchServices

名字	描述	價值
身份	資源的身分識別。	身分識別
位置	資源所在的地理位置	字串（必要）
名字	資源名稱	字串（必要）
性能	搜尋服務的屬性。	SearchServiceProperties
sku	搜尋服務的 SKU，決定價格區間和容量限制。建立新的搜尋服務時，需要這個屬性。	Sku
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤

NetworkRuleSet

名字	描述	價值
旁路	可略過『ipRules』區段中所定義規則之輸入流量的可能來源。	'AzurePortal' 'AzureServices' 'None'
ipRules	IP 限制規則清單，定義允許存取搜尋服務端點的輸入網路。同時，所有其他公用IP網路都會遭到防火牆封鎖。只有在搜尋服務的 'publicNetworkAccess' 已啟用時，才會套用這些限制規則;否則，即使有任何公用IP規則，也不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。	IpRule[]

SearchServiceProperties

名字	描述	價值
authOptions	定義搜尋服務數據平面 API 如何驗證要求的選項。如果 'disableLocalAuth' 設定為 true，則無法設定此設定。	DataPlaneAuthOptions
disabledDataExfiltrationOptions	明確不允許搜尋服務的數據外流案例清單。目前，唯一支援的值是『All』，以停用所有可能的數據匯出案例，並針對未來規劃更精細的控制。	包含任何的字串數組： 'All'
disableLocalAuth	當設定為 true 時，不允許對搜尋服務的呼叫利用 API 金鑰進行驗證。如果已定義『dataPlaneAuthOptions』，則無法設定為 true。	bool
encryptionWithCmk	指定在搜尋服務中使用客戶經理密鑰加密資源（例如索引）的任何原則。	EncryptionWithCmk
hostingMode	僅適用於 standard3 SKU。您可以設定此屬性來啟用最多 3 個高密度分割區，允許最多 1000 個索引，這遠高於任何其他 SKU 允許的最大索引。針對 standard3 SKU，此值為 'default' 或 'highDensity'。對於所有其他 SKU，此值必須是 'default'。	'default' 'highDensity'
networkRuleSet	決定如何觸達 Azure AI 搜尋服務的網路特定規則。	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	設定控制語意搜尋可用性的選項。此設定僅適用於特定位置的特定 Azure AI 搜尋 SKU。	'disabled' 'free' 'standard'

Sku

名字	描述	價值
名字	搜尋服務的 SKU。有效值包括：「免費」：共享服務。 'basic'：最多 3 個複本的專用服務。 'standard'：專用服務，最多可有 12 個分割區和 12 個復本。 'standard2'：類似於標準，但每個搜尋單位的容量較多。 'standard3'：最大標準供應專案，最多可有 12 個分割區和 12 個復本（如果您也將 hostingMode 屬性設定為 'highDensity'，則最多 3 個具有更多索引的數據分割）。 'storage_optimized_l1'：支援每個分割區 1TB，最多 12 個分割區。 'storage_optimized_l2'：支援每個分割區 2TB，最多 12 個分割區。	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

TrackedResourceTags

名字	描述	價值

UserAssignedManagedIdentities

名字	描述	價值

UserAssignedManagedIdentity

名字	描述	價值

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
Azure AI Studio 網路限制	這組範本示範如何使用Microsoft受控密鑰來加密和 AI 資源的 Microsoft 受控識別組態，來設定已停用私人鏈接和輸出的 Azure AI Studio。
Azure 認知搜尋服務	此範本會建立 Azure 認知搜尋服務

ARM 樣本資源定義

searchServices 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Search/searchServices 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "string"
      },
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [ "string" ],
    "disableLocalAuth": "bool",
    "encryptionWithCmk": {
      "enforcement": "string"
    },
    "hostingMode": "string",
    "networkRuleSet": {
      "bypass": "string",
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int",
    "semanticSearch": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

DataPlaneAadOrApiKeyAuthOption

名字	描述	價值
aadAuthFailureMode	描述搜尋服務的數據平面 API 會針對驗證失敗的要求傳送哪些回應。	'http401WithBearerChallenge' 'http403'

DataPlaneAuthOptions

名字	描述	價值
aadOrApiKey	表示 API 金鑰或來自 Microsoft Entra ID 租使用者的存取令牌都可用於驗證。	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	表示只能使用 API 金鑰進行驗證。	任何

EncryptionWithCmk

名字	描述	價值
執法	描述搜尋服務在找到未使用客戶管理密鑰加密的物件時，應如何強制執行合規性。	'Disabled' 'Enabled' 'Unspecified'

身份

名字	描述	價值
類型	用於資源的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含系統所建立的身分識別和一組使用者指派的身分識別。類型『None』會從服務中移除所有身分識別。	'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned' （必要）
userAssignedIdentities	與資源相關聯的使用者身分識別清單。用戶識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。	UserAssignedManagedIdentities

IpRule

名字	描述	價值
價值	對應至單一 IPv4 位址的值（例如 123.1.2.3）或 CIDR 格式的 IP 範圍（例如 123.1.2.3/24）。	字串

Microsoft.Search/searchServices

名字	描述	價值
apiVersion	API 版本	'2024-06-01-preview'
身份	資源的身分識別。	身分識別
位置	資源所在的地理位置	字串（必要）
名字	資源名稱	字串（必要）
性能	搜尋服務的屬性。	SearchServiceProperties
sku	搜尋服務的 SKU，決定價格區間和容量限制。建立新的搜尋服務時，需要這個屬性。	Sku
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
類型	資源類型	'Microsoft.Search/searchServices'

NetworkRuleSet

名字	描述	價值
旁路	可略過『ipRules』區段中所定義規則之輸入流量的可能來源。	'AzurePortal' 'AzureServices' 'None'
ipRules	IP 限制規則清單，定義允許存取搜尋服務端點的輸入網路。同時，所有其他公用IP網路都會遭到防火牆封鎖。只有在搜尋服務的 'publicNetworkAccess' 已啟用時，才會套用這些限制規則;否則，即使有任何公用IP規則，也不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。	IpRule[]

SearchServiceProperties

名字	描述	價值
authOptions	定義搜尋服務數據平面 API 如何驗證要求的選項。如果 'disableLocalAuth' 設定為 true，則無法設定此設定。	DataPlaneAuthOptions
disabledDataExfiltrationOptions	明確不允許搜尋服務的數據外流案例清單。目前，唯一支援的值是『All』，以停用所有可能的數據匯出案例，並針對未來規劃更精細的控制。	包含任何的字串數組： 'All'
disableLocalAuth	當設定為 true 時，不允許對搜尋服務的呼叫利用 API 金鑰進行驗證。如果已定義『dataPlaneAuthOptions』，則無法設定為 true。	bool
encryptionWithCmk	指定在搜尋服務中使用客戶經理密鑰加密資源（例如索引）的任何原則。	EncryptionWithCmk
hostingMode	僅適用於 standard3 SKU。您可以設定此屬性來啟用最多 3 個高密度分割區，允許最多 1000 個索引，這遠高於任何其他 SKU 允許的最大索引。針對 standard3 SKU，此值為 'default' 或 'highDensity'。對於所有其他 SKU，此值必須是 'default'。	'default' 'highDensity'
networkRuleSet	決定如何觸達 Azure AI 搜尋服務的網路特定規則。	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	設定控制語意搜尋可用性的選項。此設定僅適用於特定位置的特定 Azure AI 搜尋 SKU。	'disabled' 'free' 'standard'

Sku

名字	描述	價值
名字	搜尋服務的 SKU。有效值包括：「免費」：共享服務。 'basic'：最多 3 個複本的專用服務。 'standard'：專用服務，最多可有 12 個分割區和 12 個復本。 'standard2'：類似於標準，但每個搜尋單位的容量較多。 'standard3'：最大標準供應專案，最多可有 12 個分割區和 12 個復本（如果您也將 hostingMode 屬性設定為 'highDensity'，則最多 3 個具有更多索引的數據分割）。 'storage_optimized_l1'：支援每個分割區 1TB，最多 12 個分割區。 'storage_optimized_l2'：支援每個分割區 2TB，最多 12 個分割區。	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

TrackedResourceTags

名字	描述	價值

UserAssignedManagedIdentities

名字	描述	價值

UserAssignedManagedIdentity

名字	描述	價值

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
Azure AI Studio 網路限制	這組範本示範如何使用Microsoft受控密鑰來加密和 AI 資源的 Microsoft 受控識別組態，來設定已停用私人鏈接和輸出的 Azure AI Studio。
Azure 認知搜尋服務	此範本會建立 Azure 認知搜尋服務
使用私人端點 Azure 認知搜尋服務	此範本會建立具有私人端點的 Azure 認知搜尋服務。
使用 SQL Database、Azure Cosmos DB、Azure 搜尋服務 Web 應用程式	此範本會布建 Web 應用程式、SQL Database、Azure Cosmos DB、Azure 搜尋服務和 Application Insights。

Terraform （AzAPI 提供者）資源定義

searchServices 資源類型可以使用目標作業來部署：

資源群組

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Search/searchServices 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2024-06-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authOptions = {
        aadOrApiKey = {
          aadAuthFailureMode = "string"
        }
        apiKeyOnly = ?
      }
      disabledDataExfiltrationOptions = [
        "string"
      ]
      disableLocalAuth = bool
      encryptionWithCmk = {
        enforcement = "string"
      }
      hostingMode = "string"
      networkRuleSet = {
        bypass = "string"
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
      semanticSearch = "string"
    }
  })
}

屬性值

DataPlaneAadOrApiKeyAuthOption

名字	描述	價值
aadAuthFailureMode	描述搜尋服務的數據平面 API 會針對驗證失敗的要求傳送哪些回應。	'http401WithBearerChallenge' 'http403'

DataPlaneAuthOptions

名字	描述	價值
aadOrApiKey	表示 API 金鑰或來自 Microsoft Entra ID 租使用者的存取令牌都可用於驗證。	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	表示只能使用 API 金鑰進行驗證。	任何

EncryptionWithCmk

名字	描述	價值
執法	描述搜尋服務在找到未使用客戶管理密鑰加密的物件時，應如何強制執行合規性。	'Disabled' 'Enabled' 'Unspecified'

身份

名字	描述	價值
類型	用於資源的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含系統所建立的身分識別和一組使用者指派的身分識別。類型『None』會從服務中移除所有身分識別。	'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned' （必要）
userAssignedIdentities	與資源相關聯的使用者身分識別清單。用戶識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。	UserAssignedManagedIdentities

IpRule

名字	描述	價值
價值	對應至單一 IPv4 位址的值（例如 123.1.2.3）或 CIDR 格式的 IP 範圍（例如 123.1.2.3/24）。	字串

Microsoft.Search/searchServices

名字	描述	價值
身份	資源的身分識別。	身分識別
位置	資源所在的地理位置	字串（必要）
名字	資源名稱	字串（必要）
性能	搜尋服務的屬性。	SearchServiceProperties
sku	搜尋服務的 SKU，決定價格區間和容量限制。建立新的搜尋服務時，需要這個屬性。	Sku
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.Search/searchServices@2024-06-01-preview”

NetworkRuleSet

名字	描述	價值
旁路	可略過『ipRules』區段中所定義規則之輸入流量的可能來源。	'AzurePortal' 'AzureServices' 'None'
ipRules	IP 限制規則清單，定義允許存取搜尋服務端點的輸入網路。同時，所有其他公用IP網路都會遭到防火牆封鎖。只有在搜尋服務的 'publicNetworkAccess' 已啟用時，才會套用這些限制規則;否則，即使有任何公用IP規則，也不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。	IpRule[]

SearchServiceProperties

名字	描述	價值
authOptions	定義搜尋服務數據平面 API 如何驗證要求的選項。如果 'disableLocalAuth' 設定為 true，則無法設定此設定。	DataPlaneAuthOptions
disabledDataExfiltrationOptions	明確不允許搜尋服務的數據外流案例清單。目前，唯一支援的值是『All』，以停用所有可能的數據匯出案例，並針對未來規劃更精細的控制。	包含任何的字串數組： 'All'
disableLocalAuth	當設定為 true 時，不允許對搜尋服務的呼叫利用 API 金鑰進行驗證。如果已定義『dataPlaneAuthOptions』，則無法設定為 true。	bool
encryptionWithCmk	指定在搜尋服務中使用客戶經理密鑰加密資源（例如索引）的任何原則。	EncryptionWithCmk
hostingMode	僅適用於 standard3 SKU。您可以設定此屬性來啟用最多 3 個高密度分割區，允許最多 1000 個索引，這遠高於任何其他 SKU 允許的最大索引。針對 standard3 SKU，此值為 'default' 或 'highDensity'。對於所有其他 SKU，此值必須是 'default'。	'default' 'highDensity'
networkRuleSet	決定如何觸達 Azure AI 搜尋服務的網路特定規則。	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	設定控制語意搜尋可用性的選項。此設定僅適用於特定位置的特定 Azure AI 搜尋 SKU。	'disabled' 'free' 'standard'

Sku

名字	描述	價值
名字	搜尋服務的 SKU。有效值包括：「免費」：共享服務。 'basic'：最多 3 個複本的專用服務。 'standard'：專用服務，最多可有 12 個分割區和 12 個復本。 'standard2'：類似於標準，但每個搜尋單位的容量較多。 'standard3'：最大標準供應專案，最多可有 12 個分割區和 12 個復本（如果您也將 hostingMode 屬性設定為 'highDensity'，則最多 3 個具有更多索引的數據分割）。 'storage_optimized_l1'：支援每個分割區 1TB，最多 12 個分割區。 'storage_optimized_l2'：支援每個分割區 2TB，最多 12 個分割區。	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

TrackedResourceTags

名字	描述	價值

UserAssignedManagedIdentities

名字	描述	價值

UserAssignedManagedIdentity

名字	描述	價值

共用方式為

Microsoft.Search searchServices

Bicep 資源定義

資源格式

屬性值

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

身份

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

UserAssignedManagedIdentities

UserAssignedManagedIdentity

快速入門範例

ARM 樣本資源定義

資源格式

屬性值

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

身份

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

UserAssignedManagedIdentities

UserAssignedManagedIdentity

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

身份

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

UserAssignedManagedIdentities

UserAssignedManagedIdentity

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義