Microsoft。搜尋搜尋服務 2026-09-01-preview

Bicep 資源定義

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

• 資源群組 - 請參見 資源群組部署指令

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

使用範例

Bicep 範例

部署 Search Service 的基本範例。

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource searchService 'Microsoft.Search/searchServices@2022-09-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'standard'
  }
  properties: {
    authOptions: {
      apiKeyOnly: {}
    }
    disableLocalAuth: false
    encryptionWithCmk: {
      enforcement: 'Disabled'
    }
    hostingMode: 'default'
    networkRuleSet: {
      ipRules: []
    }
    partitionCount: 1
    publicNetworkAccess: 'Enabled'
    replicaCount: 1
  }
  tags: {
    environment: 'staging'
  }
}

Azure 已驗證的模組

下列 Azure 驗證模組 可用來部署此資源類型。

Azure 快速入門範例

下列 Azure 快速入門範本 包含用於部署此資源類型的 Bicep 範例。

資源格式

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

resource symbolicname 'Microsoft.Search/searchServices@2026-09-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    authOptions: {
      aadOrApiKey: {
        aadAuthFailureMode: 'string'
      }
      apiKeyOnly: any(...)
    }
    autoGeneratedDomainNameLabelScope: 'string'
    computeType: 'string'
    dataExfiltrationProtections: [
      'string'
    ]
    disableLocalAuth: bool
    encryptionWithCmk: {
      enforcement: 'string'
      serviceLevelEncryptionKey: {
        accessCredentials: {
          applicationId: 'string'
          applicationSecret: 'string'
        }
        identity: {
          @odata.type: 'string'
          // For remaining properties, see DataIdentity objects
        }
        keyVaultKeyName: 'string'
        keyVaultKeyVersion: 'string'
        keyVaultUri: 'string'
      }
    }
    endpoint: 'string'
    hostingMode: 'string'
    knowledgeRetrieval: 'string'
    networkRuleSet: {
      bypass: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
    semanticSearch: 'string'
    upgradeAvailable: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

DataIdentity 物件

設定 @odata.type 屬性以指定物件的類型。

針對 #Microsoft.Azure.Search.DataNoneIdentity，請使用：

{
  @odata.type: '#Microsoft.Azure.Search.DataNoneIdentity'
}

針對 #Microsoft.Azure.Search.DataUserAssignedIdentity，請使用：

{
  @odata.type: '#Microsoft.Azure.Search.DataUserAssignedIdentity'
  federatedIdentityClientId: 'string'
  userAssignedIdentity: 'string'
}

屬性值

Microsoft。搜尋/搜尋服務

AzureActiveDirectoryApplicationCredentials

資料身分識別

DataNone身分識別

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

DataUserAssigned身分識別

EncryptionWithCmk 的

身份

IdentityUserAssignedIdentities

IpRule （英语）

NetworkRuleSet 網路規則集

SearchResourceEncryptionKey

SearchServiceProperties

Sku

TrackedResourceTags

UserAssignedIdentity

ARM 樣本資源定義

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

• 資源群組 - 請參閱 資源群組部署指令 關於每個 API 版本變更屬性的清單，請參見 變更日誌。

使用範例

Azure 快速入門範本

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

Template	Description
Azure AI Foundry 網路受限	這組範本演示了如何在禁用專用連結和出口的情況下設置 Azure AI Foundry，使用 Microsoft 管理的密鑰進行加密，並使用 Microsoft 管理的標識配置為 AI 資源。
Azure 認知搜尋服務	此範本會建立 Azure 認知搜尋服務
使用私人端點 Azure 認知搜尋服務	此範本會建立具有私人端點的 Azure 認知搜尋服務。
具有使用者受控識別的網路保護代理程式	這組範本示範如何使用 AI 服務 / AOAI 連線的使用者受控識別驗證和專用網連結，設定具有虛擬網路隔離的 Azure AI 代理程式服務，以將代理程式連線到您的安全數據。
標準代理程式設定	這組範本示範如何使用標準設定來設定 Azure AI 代理程式服務，這表示已啟用專案/中樞連線和公用因特網存取的受控識別驗證。 代理程式會使用客戶擁有的單一租用戶搜尋和記憶體資源。 透過此設定，您可以完全控制這些資源並查看這些資源，但會根據您的使用量產生成本。
使用 SQL Database、Azure Cosmos DB、Azure 搜尋服務 Web 應用程式	此範本會布建 Web 應用程式、SQL Database、Azure Cosmos DB、Azure 搜尋服務和 Application Insights。

資源格式

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

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2026-09-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "string"
      },
      "apiKeyOnly": {}
    },
    "autoGeneratedDomainNameLabelScope": "string",
    "computeType": "string",
    "dataExfiltrationProtections": [ "string" ],
    "disableLocalAuth": "bool",
    "encryptionWithCmk": {
      "enforcement": "string",
      "serviceLevelEncryptionKey": {
        "accessCredentials": {
          "applicationId": "string",
          "applicationSecret": "string"
        },
        "identity": {
          "@odata.type": "string"
          // For remaining properties, see DataIdentity objects
        },
        "keyVaultKeyName": "string",
        "keyVaultKeyVersion": "string",
        "keyVaultUri": "string"
      }
    },
    "endpoint": "string",
    "hostingMode": "string",
    "knowledgeRetrieval": "string",
    "networkRuleSet": {
      "bypass": "string",
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int",
    "semanticSearch": "string",
    "upgradeAvailable": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

DataIdentity 物件

設定 @odata.type 屬性以指定物件的類型。

針對 #Microsoft.Azure.Search.DataNoneIdentity，請使用：

{
  "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
}

針對 #Microsoft.Azure.Search.DataUserAssignedIdentity，請使用：

{
  "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
  "federatedIdentityClientId": "string",
  "userAssignedIdentity": "string"
}

屬性值

Microsoft。搜尋/搜尋服務

AzureActiveDirectoryApplicationCredentials

資料身分識別

DataNone身分識別

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

DataUserAssigned身分識別

EncryptionWithCmk 的

身份

IdentityUserAssignedIdentities

IpRule （英语）

NetworkRuleSet 網路規則集

SearchResourceEncryptionKey

SearchServiceProperties

Sku

TrackedResourceTags

UserAssignedIdentity

Terraform （AzAPI 提供者） 資源定義

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

• 資源團體 關於每個 API 版本變更屬性的清單，請參見 變更日誌。

使用範例

Terraform 範例

部署 Search Service 的基本範例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "searchService" {
  type      = "Microsoft.Search/searchServices@2022-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      authOptions = {
        apiKeyOnly = {
        }
      }
      disableLocalAuth = false
      encryptionWithCmk = {
        enforcement = "Disabled"
      }
      hostingMode = "default"
      networkRuleSet = {
        ipRules = [
        ]
      }
      partitionCount      = 1
      publicNetworkAccess = "Enabled"
      replicaCount        = 1
    }
    sku = {
      name = "standard"
    }
    tags = {
      environment = "staging"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Azure 已驗證的模組

下列 Azure 驗證模組 可用來部署此資源類型。

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2026-09-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      authOptions = {
        aadOrApiKey = {
          aadAuthFailureMode = "string"
        }
        apiKeyOnly = ?
      }
      autoGeneratedDomainNameLabelScope = "string"
      computeType = "string"
      dataExfiltrationProtections = [
        "string"
      ]
      disableLocalAuth = bool
      encryptionWithCmk = {
        enforcement = "string"
        serviceLevelEncryptionKey = {
          accessCredentials = {
            applicationId = "string"
            applicationSecret = "string"
          }
          identity = {
            @odata.type = "string"
            // For remaining properties, see DataIdentity objects
          }
          keyVaultKeyName = "string"
          keyVaultKeyVersion = "string"
          keyVaultUri = "string"
        }
      }
      endpoint = "string"
      hostingMode = "string"
      knowledgeRetrieval = "string"
      networkRuleSet = {
        bypass = "string"
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
      semanticSearch = "string"
      upgradeAvailable = "string"
    }
    sku = {
      name = "string"
    }
  }
}

DataIdentity 物件

設定 @odata.type 屬性以指定物件的類型。

針對 #Microsoft.Azure.Search.DataNoneIdentity，請使用：

{
  @odata.type = "#Microsoft.Azure.Search.DataNoneIdentity"
}

針對 #Microsoft.Azure.Search.DataUserAssignedIdentity，請使用：

{
  @odata.type = "#Microsoft.Azure.Search.DataUserAssignedIdentity"
  federatedIdentityClientId = "string"
  userAssignedIdentity = "string"
}

屬性值

Microsoft。搜尋/搜尋服務

AzureActiveDirectoryApplicationCredentials

資料身分識別

DataNone身分識別

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

DataUserAssigned身分識別

EncryptionWithCmk 的

身份

IdentityUserAssignedIdentities

IpRule （英语）

NetworkRuleSet 網路規則集

SearchResourceEncryptionKey

SearchServiceProperties

Sku

TrackedResourceTags

UserAssignedIdentity