你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
微软。搜索 searchServices 2024-03-01-preview
Bicep 资源定义
searchServices 资源类型可以使用面向以下对象的操作进行部署:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
创建 Microsoft。搜索/searchServices 资源,将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Search/searchServices@2024-03-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
authOptions: {
aadOrApiKey: {
aadAuthFailureMode: 'string'
}
apiKeyOnly: any()
}
disabledDataExfiltrationOptions: 'All'
disableLocalAuth: bool
encryptionWithCmk: {
enforcement: 'string'
}
hostingMode: 'string'
networkRuleSet: {
bypass: 'string'
ipRules: [
{
value: 'string'
}
]
}
partitionCount: int
publicNetworkAccess: 'string'
replicaCount: int
semanticSearch: 'string'
}
}
属性值
searchServices
名称 | 说明 | 值 |
---|---|---|
name | 资源名称 | 字符串 (必需) |
location | 资源所在的地理位置 | 字符串 (必需) |
标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
sku | 搜索服务的 SKU,用于确定价格层和容量限制。 创建新的搜索服务时,此属性是必需的。 | Sku |
标识 | 资源的标识。 | 标识 |
properties | 搜索服务的属性。 | SearchServiceProperties |
标识
名称 | 说明 | Value |
---|---|---|
type | 用于资源的标识类型。 类型“SystemAssigned, UserAssigned”包含系统创建的一个标识,以及用户分配的一组标识。 类型“None”将删除服务中的所有标识。 | “None” “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned” (必需) |
userAssignedIdentities | 与资源关联的用户标识列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | UserAssignedManagedIdentities |
UserAssignedManagedIdentities
名称 | 说明 | 值 |
---|---|---|
{customized property} | UserAssignedManagedIdentity |
UserAssignedManagedIdentity
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
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 | 此值可以设置为“enabled”,以避免对现有客户资源和模板进行中断性变更。 如果设置为“disabled”,则不允许通过公共接口的流量,专用终结点连接将是独占访问方法。 | 'disabled' 'enabled' |
replicaCount | 搜索服务中的副本数。 如果指定,则对于标准 SKU,该值必须介于 1 到 12(含 1 和 12)之间,对于基本 SKU,该值必须是介于 1 到 3(含 1 到 3)之间的值。 | int 约束: 最小值 = 1 最大值 = 12 |
semanticSearch | 设置控制语义搜索可用性的选项。 此配置仅适用于某些位置中的某些 Azure AI 搜索 SKU。 | 'disabled' 'free' 'standard' |
DataPlaneAuthOptions
名称 | 说明 | 值 |
---|---|---|
aadOrApiKey | 指示 API 密钥或来自Microsoft Entra ID租户的访问令牌可用于身份验证。 | DataPlaneAadOrApiKeyAuthOption |
apiKeyOnly | 指示只有 API 密钥可用于身份验证。 | 对于 Bicep,可以使用 任何 () 函数。 |
DataPlaneAadOrApiKeyAuthOption
名称 | 说明 | 值 |
---|---|---|
aadAuthFailureMode | 描述搜索服务的数据平面 API 将为身份验证失败的请求发送的响应。 | 'http401WithBearerChallenge' “http403” |
EncryptionWithCmk
名称 | 说明 | 值 |
---|---|---|
执法 | 介绍搜索服务在找到未使用客户管理的密钥加密的对象时,应如何强制实施合规性。 | 'Disabled' 'Enabled' “未指定” |
NetworkRuleSet
名称 | 说明 | 值 |
---|---|---|
绕过 | 可以绕过“ipRules”部分中定义的规则的入站流量的可能来源。 | “AzurePortal” “None” |
ipRules | 定义允许访问搜索服务终结点的入站网络 () 的 IP 限制规则列表。 同时,防火墙会阻止所有其他公共 IP 网络。 仅当搜索服务的“publicNetworkAccess”处于“启用”状态时,才应用这些限制规则;否则,即使使用任何公共 IP 规则,也不允许通过公共接口的流量,专用终结点连接将是独占访问方法。 | IpRule[] |
IpRule
名称 | 说明 | 值 |
---|---|---|
value | 与单个 IPv4 地址对应的值 (例如 123.1.2.3) 或 CIDR 格式的 IP 范围 (例如 123.1.2.3/24) 。 | 字符串 |
SKU
名称 | 说明 | 值 |
---|---|---|
name | 搜索服务的 SKU。 有效值包括:“free”:共享服务。 “basic”:最多包含 3 个副本的专用服务。 “standard”:具有最多 12 个分区和 12 个副本的专用服务。 “standard2”:类似于标准,但每个搜索单元的容量更大。 “standard3”:最大标准产品/服务最多包含 12 个分区和 12 个副本, (最多 3 个分区,如果同时将 hostingMode 属性设置为“highDensity”) 。 “storage_optimized_l1”:支持每个分区 1TB,最多支持 12 个分区。 “storage_optimized_l2”:支持每个分区 2TB,最多支持 12 个分区。 | 'basic' 'free' 'standard' “standard2” “standard3” “storage_optimized_l1” “storage_optimized_l2” |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
具有 SQL 数据库、Azure Cosmos DB、Azure 搜索 的 Web 应用 |
此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。 |
Azure 认知搜索服务 |
此模板创建Azure 认知搜索服务 |
使用专用终结点Azure 认知搜索服务 |
此模板使用专用终结点创建Azure 认知搜索服务。 |
ARM 模板资源定义
searchServices 资源类型可以使用面向以下对象的操作进行部署:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
创建 Microsoft。搜索/searchServices 资源,将以下 JSON 添加到模板。
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2024-03-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"authOptions": {
"aadOrApiKey": {
"aadAuthFailureMode": "string"
},
"apiKeyOnly": {}
},
"disabledDataExfiltrationOptions": "All",
"disableLocalAuth": "bool",
"encryptionWithCmk": {
"enforcement": "string"
},
"hostingMode": "string",
"networkRuleSet": {
"bypass": "string",
"ipRules": [
{
"value": "string"
}
]
},
"partitionCount": "int",
"publicNetworkAccess": "string",
"replicaCount": "int",
"semanticSearch": "string"
}
}
属性值
searchServices
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft。搜索/searchServices' |
apiVersion | 资源 API 版本 | “2024-03-01-preview” |
name | 资源名称 | 字符串 (必需) |
location | 资源所在的地理位置 | 字符串 (必需) |
标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
sku | 搜索服务的 SKU,用于确定价格层和容量限制。 创建新的搜索服务时,此属性是必需的。 | Sku |
标识 | 资源的标识。 | 标识 |
properties | 搜索服务的属性。 | SearchServiceProperties |
标识
名称 | 说明 | Value |
---|---|---|
type | 用于资源的标识类型。 类型“SystemAssigned, UserAssigned”包含系统创建的一个标识,以及用户分配的一组标识。 类型“None”将删除服务中的所有标识。 | “None” “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned” (必需) |
userAssignedIdentities | 与资源关联的用户标识列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | UserAssignedManagedIdentities |
UserAssignedManagedIdentities
名称 | 说明 | 值 |
---|---|---|
{customized property} | UserAssignedManagedIdentity |
UserAssignedManagedIdentity
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
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” |
DataPlaneAuthOptions
名称 | 说明 | 值 |
---|---|---|
aadOrApiKey | 指示 API 密钥或来自Microsoft Entra ID租户的访问令牌可用于身份验证。 | DataPlaneAadOrApiKeyAuthOption |
apiKeyOnly | 指示只能使用 API 密钥进行身份验证。 |
DataPlaneAadOrApiKeyAuthOption
名称 | 说明 | 值 |
---|---|---|
aadAuthFailureMode | 描述搜索服务的数据平面 API 将为身份验证失败的请求发送的响应。 | “http401WithBearerChallenge” “http403” |
EncryptionWithCmk
名称 | 说明 | 值 |
---|---|---|
执法 | 描述搜索服务在查找未使用客户管理的密钥加密的对象时,应如何强制实施合规性。 | “Disabled” “已启用” “未指定” |
NetworkRuleSet
名称 | 说明 | 值 |
---|---|---|
绕过 | 可以绕过“ipRules”部分中定义的规则的入站流量的可能来源。 | “AzurePortal” “None” |
ipRules | 定义入站网络 (允许访问搜索服务终结点) 的 IP 限制规则列表。 同时,防火墙会阻止所有其他公共 IP 网络。 仅当搜索服务的“publicNetworkAccess”处于“启用”状态时,才应用这些限制规则:否则,即使使用任何公共 IP 规则,也不允许通过公共接口的流量,专用终结点连接将是独占访问方法。 | IpRule[] |
IpRule
名称 | 说明 | 值 |
---|---|---|
value | 与单个 IPv4 地址对应的值 (例如 123.1.2.3) 或 CIDR 格式的 IP 范围, () 123.1.2.3/24。 | 字符串 |
SKU
名称 | 说明 | 值 |
---|---|---|
name | 搜索服务的 SKU。 有效值包括:“free”:共享服务。 “basic”:最多包含 3 个副本的专用服务。 “standard”:包含最多 12 个分区和 12 个副本的专用服务。 “standard2”:类似于标准,但每个搜索单位的容量更多。 “standard3”:最大标准产品/服务最多包含 12 个分区和 12 个副本 (或最多 3 个具有更多索引的分区(如果还将 hostingMode 属性设置为“highDensity”) )。 “storage_optimized_l1”:支持每个分区 1TB,最多支持 12 个分区。 “storage_optimized_l2”:支持每个分区 2TB,最多 12 个分区。 | “basic” “free” “standard” “standard2” “standard3” “storage_optimized_l1” “storage_optimized_l2” |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
具有 SQL 数据库、Azure Cosmos DB、Azure 搜索 的 Web 应用 |
此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。 |
Azure 认知搜索服务 |
此模板创建Azure 认知搜索服务 |
使用专用终结点Azure 认知搜索服务 |
此模板使用专用终结点创建Azure 认知搜索服务。 |
Terraform (AzAPI 提供程序) 资源定义
searchServices 资源类型可以使用面向以下对象的操作进行部署:
- 资源组
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
创建 Microsoft。搜索/searchServices 资源,将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices@2024-03-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
authOptions = {
aadOrApiKey = {
aadAuthFailureMode = "string"
}
}
disabledDataExfiltrationOptions = "All"
disableLocalAuth = bool
encryptionWithCmk = {
enforcement = "string"
}
hostingMode = "string"
networkRuleSet = {
bypass = "string"
ipRules = [
{
value = "string"
}
]
}
partitionCount = int
publicNetworkAccess = "string"
replicaCount = int
semanticSearch = "string"
}
sku = {
name = "string"
}
})
}
属性值
searchServices
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft。搜索/searchServices@2024-03-01-preview” |
name | 资源名称 | 字符串 (必需) |
location | 资源所在的地理位置 | 字符串 (必需) |
parent_id | 若要部署到资源组,请使用该资源组的 ID。 | 字符串 (必需) |
标记 | 资源标记。 | 标记名称和值的字典。 |
sku | 搜索服务的 SKU,用于确定价格层和容量限制。 创建新的搜索服务时,此属性是必需的。 | Sku |
标识 | 资源的标识。 | 标识 |
properties | 搜索服务的属性。 | SearchServiceProperties |
标识
名称 | 说明 | Value |
---|---|---|
type | 用于资源的标识类型。 类型“SystemAssigned, UserAssigned”包含系统创建的一个标识,以及用户分配的一组标识。 类型“None”将删除服务中的所有标识。 | “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned” (必需) |
identity_ids | 与资源关联的用户标识列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | 用户标识 ID 数组。 |
UserAssignedManagedIdentities
名称 | 说明 | 值 |
---|---|---|
{customized property} | UserAssignedManagedIdentity |
UserAssignedManagedIdentity
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
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 | 此值可以设置为“enabled”,以避免对现有客户资源和模板进行中断性变更。 如果设置为“disabled”,则不允许通过公共接口的流量,专用终结点连接将是独占访问方法。 | "disabled" "enabled" |
replicaCount | 搜索服务中的副本数。 如果指定,则对于标准 SKU,该值必须介于 1 到 12(含 1 和 12)之间,对于基本 SKU,该值必须是介于 1 到 3(含 1 到 3)之间的值。 | int 约束: 最小值 = 1 最大值 = 12 |
semanticSearch | 设置控制语义搜索可用性的选项。 此配置仅适用于某些位置中的某些 Azure AI 搜索 SKU。 | "disabled" “free” “standard” |
DataPlaneAuthOptions
名称 | 说明 | 值 |
---|---|---|
aadOrApiKey | 指示 API 密钥或来自Microsoft Entra ID租户的访问令牌可用于身份验证。 | DataPlaneAadOrApiKeyAuthOption |
apiKeyOnly | 指示只有 API 密钥可用于身份验证。 |
DataPlaneAadOrApiKeyAuthOption
名称 | 说明 | 值 |
---|---|---|
aadAuthFailureMode | 描述搜索服务的数据平面 API 将为身份验证失败的请求发送的响应。 | “http401WithBearerChallenge” “http403” |
EncryptionWithCmk
名称 | 说明 | 值 |
---|---|---|
执法 | 介绍搜索服务在找到未使用客户管理的密钥加密的对象时,应如何强制实施合规性。 | “Disabled” “Enabled” “Unspecified” |
NetworkRuleSet
名称 | 说明 | 值 |
---|---|---|
绕过 | 可以绕过“ipRules”部分中定义的规则的入站流量的可能来源。 | “AzurePortal” "None" |
ipRules | 定义允许访问搜索服务终结点的入站网络 () 的 IP 限制规则列表。 同时,防火墙会阻止所有其他公共 IP 网络。 仅当搜索服务的“publicNetworkAccess”处于“启用”状态时,才应用这些限制规则;否则,即使使用任何公共 IP 规则,也不允许通过公共接口的流量,专用终结点连接将是独占访问方法。 | IpRule[] |
IpRule
名称 | 说明 | 值 |
---|---|---|
value | 与单个 IPv4 地址对应的值 (例如 123.1.2.3) 或 CIDR 格式的 IP 范围 (例如 123.1.2.3/24) 。 | 字符串 |
SKU
名称 | 说明 | 值 |
---|---|---|
name | 搜索服务的 SKU。 有效值包括:“free”:共享服务。 “basic”:最多包含 3 个副本的专用服务。 “standard”:具有最多 12 个分区和 12 个副本的专用服务。 “standard2”:类似于标准,但每个搜索单元的容量更大。 “standard3”:最大标准产品/服务最多包含 12 个分区和 12 个副本, (最多 3 个分区,如果同时将 hostingMode 属性设置为“highDensity”) 。 “storage_optimized_l1”:支持每个分区 1TB,最多支持 12 个分区。 “storage_optimized_l2”:支持每个分区 2TB,最多支持 12 个分区。 | “basic” “free” “standard” “standard2” “standard3” “storage_optimized_l1” “storage_optimized_l2” |
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈