你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.Search searchServices 2020-08-01

Bicep 资源定义

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

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

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

resource symbolicname 'Microsoft.Search/searchServices@2020-08-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    hostingMode: 'string'
    networkRuleSet: {
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

身份

名字 描述 价值
类型 标识类型。 “None”
“SystemAssigned”(必需)

IpRule

名字 描述 价值
价值 与单个 IPv4 地址(例如,123.1.2.3)或 CIDR 格式(例如,允许 123.1.2.3/24)的 IP 范围对应的值。 字符串

Microsoft.Search/searchServices

名字 描述 价值
身份 资源的标识。 标识
位置 资源所在的地理位置 string (必需)
名字 资源名称 string (必需)
性能 搜索服务的属性。 SearchServiceProperties
sku 搜索服务的 SKU,用于确定价格层和容量限制。 创建新的搜索服务时,此属性是必需的。 Sku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

NetworkRuleSet

名字 描述 价值
ipRules 定义入站网络(s)的 IP 限制规则列表,允许访问搜索服务终结点。 同时,防火墙会阻止所有其他公共 IP 网络。 仅当搜索服务的“publicNetworkAccess”为“enabled”时,才应用这些限制规则;否则,即使使用任何公共 IP 规则,也不允许通过公共接口的流量,专用终结点连接将是独占访问方法。 IpRule[]

SearchServiceProperties

名字 描述 价值
hostingMode 仅适用于 standard3 SKU。 可以将此属性设置为最多允许 3 个高密度分区,允许最多 1000 个索引,这远远高于任何其他 SKU 允许的最大索引。 对于 standard3 SKU,该值为“default”或“highDensity”。 对于所有其他 SKU,此值必须为“default”。 “default”
“highDensity”
networkRuleSet 确定如何访问 Azure 认知搜索服务的网络特定规则。 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(含 1 到 3)之间的值,对于基本 SKU,该值必须介于 1 和 3 之间。 int

约束:
最小值 = 1
最大值 = 12

Sku

名字 描述 价值
名字 搜索服务的 SKU。 有效值包括:“free”:共享服务。 “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

名字 描述 价值

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
Azure AI Studio 网络受限 此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio,并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
Azure 认知搜索服务 此模板创建 Azure 认知搜索服务

ARM 模板资源定义

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

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

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

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2020-08-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "hostingMode": "string",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

身份

名字 描述 价值
类型 标识类型。 “None”
“SystemAssigned”(必需)

IpRule

名字 描述 价值
价值 与单个 IPv4 地址(例如,123.1.2.3)或 CIDR 格式(例如,允许 123.1.2.3/24)的 IP 范围对应的值。 字符串

Microsoft.Search/searchServices

名字 描述 价值
apiVersion API 版本 '2020-08-01'
身份 资源的标识。 标识
位置 资源所在的地理位置 string (必需)
名字 资源名称 string (必需)
性能 搜索服务的属性。 SearchServiceProperties
sku 搜索服务的 SKU,用于确定价格层和容量限制。 创建新的搜索服务时,此属性是必需的。 Sku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Search/searchServices”

NetworkRuleSet

名字 描述 价值
ipRules 定义入站网络(s)的 IP 限制规则列表,允许访问搜索服务终结点。 同时,防火墙会阻止所有其他公共 IP 网络。 仅当搜索服务的“publicNetworkAccess”为“enabled”时,才应用这些限制规则;否则,即使使用任何公共 IP 规则,也不允许通过公共接口的流量,专用终结点连接将是独占访问方法。 IpRule[]

SearchServiceProperties

名字 描述 价值
hostingMode 仅适用于 standard3 SKU。 可以将此属性设置为最多允许 3 个高密度分区,允许最多 1000 个索引,这远远高于任何其他 SKU 允许的最大索引。 对于 standard3 SKU,该值为“default”或“highDensity”。 对于所有其他 SKU,此值必须为“default”。 “default”
“highDensity”
networkRuleSet 确定如何访问 Azure 认知搜索服务的网络特定规则。 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(含 1 到 3)之间的值,对于基本 SKU,该值必须介于 1 和 3 之间。 int

约束:
最小值 = 1
最大值 = 12

Sku

名字 描述 价值
名字 搜索服务的 SKU。 有效值包括:“free”:共享服务。 “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

名字 描述 价值

快速入门模板

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

模板 描述
Azure AI Studio 网络受限

部署到 Azure
此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio,并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
Azure 认知搜索服务

部署到 Azure
此模板创建 Azure 认知搜索服务
使用专用终结点 Azure 认知搜索服务

部署到 Azure
此模板使用专用终结点创建 Azure 认知搜索服务。
使用 SQL 数据库、Azure Cosmos DB、Azure 搜索 Web 应用

部署到 Azure
此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。

Terraform (AzAPI 提供程序)资源定义

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

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2020-08-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      hostingMode = "string"
      networkRuleSet = {
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
    }
  })
}

属性值

身份

名字 描述 价值
类型 标识类型。 “None”
“SystemAssigned”(必需)

IpRule

名字 描述 价值
价值 与单个 IPv4 地址(例如,123.1.2.3)或 CIDR 格式(例如,允许 123.1.2.3/24)的 IP 范围对应的值。 字符串

Microsoft.Search/searchServices

名字 描述 价值
身份 资源的标识。 标识
位置 资源所在的地理位置 string (必需)
名字 资源名称 string (必需)
性能 搜索服务的属性。 SearchServiceProperties
sku 搜索服务的 SKU,用于确定价格层和容量限制。 创建新的搜索服务时,此属性是必需的。 Sku
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Search/searchServices@2020-08-01”

NetworkRuleSet

名字 描述 价值
ipRules 定义入站网络(s)的 IP 限制规则列表,允许访问搜索服务终结点。 同时,防火墙会阻止所有其他公共 IP 网络。 仅当搜索服务的“publicNetworkAccess”为“enabled”时,才应用这些限制规则;否则,即使使用任何公共 IP 规则,也不允许通过公共接口的流量,专用终结点连接将是独占访问方法。 IpRule[]

SearchServiceProperties

名字 描述 价值
hostingMode 仅适用于 standard3 SKU。 可以将此属性设置为最多允许 3 个高密度分区,允许最多 1000 个索引,这远远高于任何其他 SKU 允许的最大索引。 对于 standard3 SKU,该值为“default”或“highDensity”。 对于所有其他 SKU,此值必须为“default”。 “default”
“highDensity”
networkRuleSet 确定如何访问 Azure 认知搜索服务的网络特定规则。 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(含 1 到 3)之间的值,对于基本 SKU,该值必须介于 1 和 3 之间。 int

约束:
最小值 = 1
最大值 = 12

Sku

名字 描述 价值
名字 搜索服务的 SKU。 有效值包括:“free”:共享服务。 “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

名字 描述 价值