Microsoft.Search 搜索服务 2023-11-01

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@2023-11-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: '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'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.Search/searchServices

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk 的

身份

IpRule （英语）

NetworkRuleSet 网络规则集

SearchServiceProperties

SKU

TrackedResourceTags

ARM 模板资源定义

可以使用目标操作部署 searchServices 资源类型：

• 资源组 - 参见 资源组部署命令 关于每个API版本中变更属性的列表，请参见 更改日志。

用法示例

Azure 快速入门模板

以下 Azure 快速入门模板 部署此资源类型。

模板	描述
Azure AI Foundry 网络受限	这组模板演示了如何在禁用专用链接和出口的情况下设置 Azure AI Foundry，使用 Microsoft 管理的密钥进行加密，并使用 Microsoft 管理的标识配置为 AI 资源。
Azure 认知搜索服务	此模板创建 Azure 认知搜索服务
使用专用终结点 Azure 认知搜索服务	此模板使用专用终结点创建 Azure 认知搜索服务。
使用用户托管标识 网络安全代理	此模板集演示如何使用用户托管标识身份验证为 AI 服务/AOAI 连接设置虚拟网络隔离的 Azure AI 代理服务，以及专用网络链接，以将代理连接到安全数据。
标准代理设置	此模板集演示如何使用标准设置设置设置 Azure AI 代理服务，这意味着已启用项目/中心连接的托管标识身份验证和公共 Internet 访问。 代理使用客户拥有的单租户搜索和存储资源。 通过此设置，可以完全控制这些资源并查看这些资源，但会根据使用情况产生成本。
使用 SQL 数据库、Azure Cosmos DB、Azure 搜索 Web 应用	此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。

资源格式

若要创建 Microsoft.Search/searchServices 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2023-11-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "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"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.Search/searchServices

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk 的

身份

IpRule （英语）

NetworkRuleSet 网络规则集

SearchServiceProperties

SKU

TrackedResourceTags

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@2023-11-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
    }
    sku = {
      name = "string"
    }
  }
}

属性值

Microsoft.Search/searchServices

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk 的

身份

IpRule （英语）

NetworkRuleSet 网络规则集

SearchServiceProperties

SKU

TrackedResourceTags