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

Microsoft.Search searchServices

项目
12/20/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 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	UserAssignedManagedIdentities

IpRule

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

Microsoft.Search/searchServices

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

NetworkRuleSet

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

SearchServiceProperties

名字	描述	价值
authOptions	定义搜索服务的数据平面 API 如何对请求进行身份验证的选项。如果“disableLocalAuth”设置为 true，则无法设置此项。	DataPlaneAuthOptions
disabledDataExfiltrationOptions	显式禁止搜索服务的数据外泄方案列表。目前，唯一支持的值是“全部”，用于禁用所有可能的数据导出方案，并计划将来进行更精细的控制。	包含任一项的字符串数组： “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（含 1 到 3）之间的值，对于基本 SKU，该值必须介于 1 和 3 之间。	int 约束：最小值 = 1 最大值 = 12
semanticSearch	设置控制语义搜索可用性的选项。此配置仅适用于特定位置的某些 Azure AI 搜索 SKU。	“disabled” “free” “standard”

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

名字	描述	价值

UserAssignedManagedIdentities

名字	描述	价值

UserAssignedManagedIdentity

名字	描述	价值

快速入门示例

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

Bicep 文件	描述
Azure AI Studio 网络受限	此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio，并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
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 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	UserAssignedManagedIdentities

IpRule

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

Microsoft.Search/searchServices

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

NetworkRuleSet

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

SearchServiceProperties

名字	描述	价值
authOptions	定义搜索服务的数据平面 API 如何对请求进行身份验证的选项。如果“disableLocalAuth”设置为 true，则无法设置此项。	DataPlaneAuthOptions
disabledDataExfiltrationOptions	显式禁止搜索服务的数据外泄方案列表。目前，唯一支持的值是“全部”，用于禁用所有可能的数据导出方案，并计划将来进行更精细的控制。	包含任一项的字符串数组： “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（含 1 到 3）之间的值，对于基本 SKU，该值必须介于 1 和 3 之间。	int 约束：最小值 = 1 最大值 = 12
semanticSearch	设置控制语义搜索可用性的选项。此配置仅适用于特定位置的某些 Azure AI 搜索 SKU。	“disabled” “free” “standard”

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

名字	描述	价值

UserAssignedManagedIdentities

名字	描述	价值

UserAssignedManagedIdentity

名字	描述	价值

快速入门模板

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

模板	描述
Azure AI Studio 网络受限	此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio，并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
Azure 认知搜索服务	此模板创建 Azure 认知搜索服务
使用专用终结点 Azure 认知搜索服务	此模板使用专用终结点创建 Azure 认知搜索服务。
使用 SQL 数据库、Azure Cosmos DB、Azure 搜索 Web 应用	此模板预配 Web 应用、SQL 数据库、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 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	UserAssignedManagedIdentities

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@2024-06-01-preview”

NetworkRuleSet

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

SearchServiceProperties

名字	描述	价值
authOptions	定义搜索服务的数据平面 API 如何对请求进行身份验证的选项。如果“disableLocalAuth”设置为 true，则无法设置此项。	DataPlaneAuthOptions
disabledDataExfiltrationOptions	显式禁止搜索服务的数据外泄方案列表。目前，唯一支持的值是“全部”，用于禁用所有可能的数据导出方案，并计划将来进行更精细的控制。	包含任一项的字符串数组： “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（含 1 到 3）之间的值，对于基本 SKU，该值必须介于 1 和 3 之间。	int 约束：最小值 = 1 最大值 = 12
semanticSearch	设置控制语义搜索可用性的选项。此配置仅适用于特定位置的某些 Azure AI 搜索 SKU。	“disabled” “free” “standard”

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

名字	描述	价值

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

反馈

其他资源