Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Definición de recursos de Bicep
El tipo de recurso searchServices se puede implementar con operaciones que tienen como destino:
Grupos de recursos - Véasegrupos de recursos c1
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Ejemplos de uso
Ejemplos de Bicep
Un ejemplo básico de implementación del servicio de búsqueda.
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'
}
}
Módulos comprobados de Azure
Los siguientes módulos comprobados de Azure se pueden usar para implementar este tipo de recurso.
| Módulo | Description |
|---|---|
| Servicio de búsqueda | Módulo de recursos de AVM para Search Service |
Ejemplos de inicio rápido de Azure
Los siguientes plantillas de inicio rápido de Azure contienen ejemplos de Bicep para implementar este tipo de recurso.
| Archivo de Bicep | Description |
|---|---|
| Red de Fundición de IA de Azure restringida | En este conjunto de plantillas se muestra cómo configurar Fundición de IA de Azure con el vínculo privado y la salida deshabilitados, mediante claves administradas por Microsoft para el cifrado y la configuración de identidad administrada por Microsoft para el recurso de IA. |
| del servicio Azure Cognitive Search | Esta plantilla crea un servicio Azure Cognitive Search |
| Agente protegido por red con identidad administrada de usuario | Este conjunto de plantillas muestra cómo configurar el servicio agente de Azure AI con aislamiento de red virtual mediante autenticación de identidad administrada de usuario para la conexión del servicio de IA/AOAI y vínculos de red privada para conectar el agente a los datos seguros. |
| de configuración del agente estándar | Este conjunto de plantillas muestra cómo configurar el servicio agente de Azure AI con la configuración estándar, lo que significa que con la autenticación de identidad administrada para conexiones de proyecto/centro y acceso a Internet público habilitado. Los agentes usan recursos de almacenamiento y búsqueda de un solo inquilino propiedad del cliente. Con esta configuración, tiene control total y visibilidad sobre estos recursos, pero incurrirá en costos en función del uso. |
Formato de recurso
Para crear un recurso Microsoft.Search/searchServices, agregue el siguiente bicep a la plantilla.
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'
}
}
Objetos DataIdentity
Establezca la propiedad @odata.type para especificar el tipo de objeto.
Para #Microsoft.Azure.Search.DataNoneIdentity, use:
{
@odata.type: '#Microsoft.Azure.Search.DataNoneIdentity'
}
Para #Microsoft.Azure.Search.DataUserAssignedIdentity, use:
{
@odata.type: '#Microsoft.Azure.Search.DataUserAssignedIdentity'
federatedIdentityClientId: 'string'
userAssignedIdentity: 'string'
}
Valores de propiedad
Microsoft.Search/searchServices
| Nombre | Description | Importancia |
|---|---|---|
| identity | Identidad del recurso. | Identity |
| location | Ubicación geográfica donde reside el recurso | string (obligatorio) |
| nombre | El nombre del recurso | cuerda Restricciones: Patrón = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (obligatorio) |
| properties | Propiedades del servicio de búsqueda. | SearchServiceProperties |
| sku | SKU del servicio de búsqueda, que determina el nivel de precio y los límites de capacidad. Esta propiedad es necesaria al crear un nuevo servicio de búsqueda. | Sku |
| etiquetas | Etiquetas de recursos | Diccionario de nombres y valores de etiqueta. Consulta |
AzureActiveDirectoryApplicationCredentials
| Nombre | Description | Importancia |
|---|---|---|
| applicationId | El ID de la aplicación (cliente) de un registro de aplicación en el inquilino. | string |
| applicationSecret | Un secreto de cliente AAD que se generó para el Registro de la App se utilizó para autenticarse con Azure Key Vault. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
Identidad de datos
| Nombre | Description | Importancia |
|---|---|---|
| @odata.type | Establézcalo en '#Microsoft.Azure.Search.DataNoneIdentity' para el tipo DataNoneIdentity. Establézcalo en '#Microsoft.Azure.Search.DataUserAssignedIdentity' para el tipo DataUserAssignedIdentity. | '#Microsoft.Azure.Search.DataNoneIdentity' '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obligatorio) |
DataNoneIdentity
| Nombre | Description | Importancia |
|---|---|---|
| @odata.type | Fragmento de URI que especifica el tipo de identidad. | '#Microsoft.Azure.Search.DataNoneIdentity' (obligatorio) |
DataPlaneAadOrApiKeyAuthOption
| Nombre | Description | Importancia |
|---|---|---|
| aadAuthFailureMode | Describe qué respuesta enviaría la API del plano de datos de un servicio de búsqueda para solicitudes con error de autenticación. | 'http401WithBearerChallenge' 'http403' |
DataPlaneAuthOptions
DataUserAssignedIdentity
| Nombre | Description | Importancia |
|---|---|---|
| @odata.type | Fragmento de URI que especifica el tipo de identidad. | '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obligatorio) |
| federatedIdentityClientId | Opcional para soporte de CMK de identidad gestionada User-Assigned multi-inquilino: El id del cliente (como UUID) del registro de aplicaciones multi-inquilino que se ha configurado para federarse con el usuarioAsignedIdentity. | string |
| userAssignedIdentity | El identificador de recurso de Azure completo de una identidad administrada asignada por el usuario normalmente con el formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que se debe haber asignado al servicio de búsqueda. | string (obligatorio) |
EncryptionWithCmk
| Nombre | Description | Importancia |
|---|---|---|
| cumplimiento | Describe cómo un servicio de búsqueda debe aplicar el cumplimiento si encuentra objetos que no están cifrados con la clave administrada por el cliente. | 'Deshabilitado' 'Habilitado' "Sin especificar" |
| serviceLevelEncryptionKey | Describe la configuración de clave gestionada por el cliente para cifrar el servicio de búsqueda. | SearchResourceEncryptionKey |
Identity
| Nombre | Description | Importancia |
|---|---|---|
| type | Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada por el sistema y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará todas las identidades del servicio. | 'Ninguno' 'SystemAssigned' 'Asignado al sistema, asignado al usuario' 'UserAssigned' (obligatorio) |
| userAssignedIdentities | Lista de identidades de usuario asociadas al recurso. Las referencias clave del diccionario de identidad de usuario serán identificadores de recursos ARM en la forma: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. ManagedIdentity/userAssignedIdentities/{identityName}'. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Nombre | Description | Importancia |
|---|
IpRule
| Nombre | Description | Importancia |
|---|---|---|
| valor | Valor correspondiente a una sola dirección IPv4 (por ejemplo, 123.1.2.3) o a un intervalo IP en formato CIDR (por ejemplo, 123.1.2.3/24) que se permitirá. | string |
NetworkRuleSet
| Nombre | Description | Importancia |
|---|---|---|
| omisión | Posibles orígenes del tráfico entrante que pueden omitir las reglas definidas en la sección "ipRules". | "AzurePortal" "AzureServices" 'Ninguno' |
| ipRules | Lista de reglas de restricción de IP que definen las redes entrantes con la posibilidad de acceder al punto de conexión de servicio de búsqueda. Mientras tanto, el firewall bloquea todas las demás redes IP públicas. Estas reglas de restricción solo se aplican cuando "publicNetworkAccess" del servicio de búsqueda está "habilitado"; De lo contrario, el tráfico a través de la interfaz pública no se permite incluso con ninguna regla de IP pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo. | ipRule[] |
SearchResourceEncryptionKey
| Nombre | Description | Importancia |
|---|---|---|
| Credenciales de acceso | Credenciales opcionales de Azure Active Directory utilizadas para acceder a tu Azure Key Vault. No es necesario si se usa la identidad administrada en su lugar. | AzureActiveDirectoryApplicationCredentials |
| identity | Una identidad administrada explícita que se va a usar para esta clave de cifrado. Si no se especifica y la propiedad de credenciales de acceso es null, se usa la identidad administrada asignada por el sistema. Al actualizar al recurso, si la identidad explícita no está especificada, permanece sin cambios. Si se especifica "none", se borra el valor de esta propiedad. | Identidad de datos |
| keyVaultKeyName | Nombre de la clave de Azure Key Vault que se usará para cifrar los datos en reposo. | string |
| keyVaultKeyVersion | Versión de la clave de Azure Key Vault que se usará para cifrar los datos en reposo. | string |
| keyVaultUri | El URI de Azure Key Vault, también denominado nombre DNS, que contiene la clave que se va a usar para cifrar los datos en reposo. Un URI de ejemplo podría ser https://my-keyvault-name.vault.azure.net. |
string |
SearchServiceProperties
| Nombre | Description | Importancia |
|---|---|---|
| authOptions | Define las opciones de cómo autentica las solicitudes la API del plano de datos de un servicio de búsqueda. No se puede establecer si 'disableLocalAuth' está establecido en true. | dataPlaneAuthOptions |
| autoGeneratedDomainNameLabelScope | Define el nivel de reutilización de la etiqueta de dominio generada automáticamente para el servicio de búsqueda (por ejemplo, myservice-uniqueId.search.windows.net<>). Si no se especifica, no se crea ninguna etiqueta de dominio generada automáticamente para el servicio de búsqueda. | 'NoReutilización' 'Reutilización de suscripciones' 'Reutilización de inquilinos' |
| computeType | Configura esta propiedad para soportar el servicio de búsqueda usando el Default Compute o Azure Confidential Compute. | "Confidencial" 'Valor predeterminado' |
| dataExfiltrationProtections | Lista de escenarios de filtración de datos que no se permiten explícitamente para el servicio de búsqueda. Actualmente, el único valor admitido es "All" para deshabilitar todos los posibles escenarios de exportación de datos con controles más específicos planeados para el futuro. | Matriz de cadenas que contiene cualquiera de: 'Bloqueartodo' |
| disableLocalAuth | Cuando se establece en true, no se permitirá que las llamadas al servicio de búsqueda usen claves de API para la autenticación. No se puede establecer en true si se definen "dataPlaneAuthOptions". | bool |
| encryptionWithCmk | Especifica cualquier directiva relacionada con el cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda. | EncryptionWithCmk |
| endpoint | El punto final del servicio Búsqueda de Azure AI. | string |
| hostingMode | Solo se aplica a la SKU estándar3. Puede establecer esta propiedad para habilitar hasta 3 particiones de alta densidad que permitan hasta 1000 índices, que es mucho mayor que los índices máximos permitidos para cualquier otra SKU. Para la SKU standard3, el valor es "Default" o "HighDensity". Para todas las demás SKU, este valor debe ser "Predeterminado". | 'Valor predeterminado' 'Alta densidad' |
| conocimientoRecuperación | Especifica el plan de facturación para la recuperación de agentes en el servicio Búsqueda de Azure AI. Esta configuración solo está disponible para ciertos niveles de precios en determinadas regiones. | 'gratis' 'standard' |
| networkRuleSet | Reglas específicas de la red que determinan cómo se puede contactar con el servicio Búsqueda de Azure AI. | NetworkRuleSet |
| partitionCount | El número de particiones en el servicio de búsqueda dedicado; Si se especifica, puede ser 1, 2, 3, 4, 6 o 12. Los valores mayores que 1 solo son válidos para las SKU estándar. Para los servicios "standard3" con hostingMode establecido en "highDensity", los valores permitidos están comprendidos entre 1 y 3. | Int Restricciones: Valor mínimo = 1 Valor máximo = 12 |
| publicNetworkAccess | Este valor se puede establecer en "Habilitado" para evitar cambios importantes en los recursos y plantillas de clientes existentes. Si se establece en "Deshabilitado", no se permite el tráfico a través de la interfaz pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo. | 'Deshabilitado' 'Habilitado' "SecuredByPerimeter" |
| replicaCount | El número de réplicas en el servicio de búsqueda dedicado. Si se especifica, debe ser un valor entre 1 y 12 inclusive para las SKU estándar o entre 1 y 3 inclusive para la SKU básica. | Int Restricciones: Valor mínimo = 1 Valor máximo = 12 |
| semánticSearch | Especifica la disponibilidad y el plan de facturación para la búsqueda semántica en el servicio Búsqueda de Azure AI. Esta configuración solo está disponible para ciertos niveles de precios en determinadas regiones. | 'Desactivado' 'gratis' 'standard' |
| upgradeAvailable | Indica si el servicio de búsqueda tiene disponible una actualización. | 'Disponible' 'no disponible' |
Sku
| Nombre | Description | Importancia |
|---|---|---|
| nombre | SKU del servicio de búsqueda. Entre los valores válidos se incluyen: "gratis": servicio compartido. 'basic': servicio dedicado con hasta 3 réplicas. 'estándar': servicio dedicado con hasta 12 particiones y 12 réplicas. 'standard2': similar al estándar, pero con más capacidad por unidad de búsqueda. 'standard3': la oferta estándar más grande con hasta 12 particiones y 12 réplicas (o hasta 3 particiones con más índices si también establece la propiedad hostingMode en 'highDensity'). 'storage_optimized_l1': admite 1 TB por partición, hasta 12 particiones. 'storage_optimized_l2': Soporta 2TB por partición, hasta 12 particiones. 'sin servidor': Nivel sin servidor con capacidades de escalado automático. | 'basic' 'gratis' 'sin servidor' 'standard' 'Estándar2' 'Estándar3' "storage_optimized_l1" "storage_optimized_l2" |
TrackedResourceTags
| Nombre | Description | Importancia |
|---|
UserAssignedIdentity
| Nombre | Description | Importancia |
|---|
Definición de recursos de plantilla de ARM
El tipo de recurso searchServices se puede implementar con operaciones que tienen como destino:
- Grupos de recursos - Véase comandos de despliegue de grupos de recursos Para una lista de propiedades modificadas en cada versión de la API, consulte registro de cambios.
Ejemplos de uso
Plantillas de inicio rápido de Azure
Los siguientes plantillas de inicio rápido de Azure implementar este tipo de recurso.
| Template | Description |
|---|---|
|
Red de Fundición de IA de Azure restringida |
En este conjunto de plantillas se muestra cómo configurar Fundición de IA de Azure con el vínculo privado y la salida deshabilitados, mediante claves administradas por Microsoft para el cifrado y la configuración de identidad administrada por Microsoft para el recurso de IA. |
|
del servicio Azure Cognitive Search |
Esta plantilla crea un servicio Azure Cognitive Search |
|
servicio Azure Cognitive Search con de punto de conexión privado |
Esta plantilla crea un servicio azure Cognitive Search con un punto de conexión privado. |
|
Agente protegido por red con identidad administrada de usuario |
Este conjunto de plantillas muestra cómo configurar el servicio agente de Azure AI con aislamiento de red virtual mediante autenticación de identidad administrada de usuario para la conexión del servicio de IA/AOAI y vínculos de red privada para conectar el agente a los datos seguros. |
|
de configuración del agente estándar |
Este conjunto de plantillas muestra cómo configurar el servicio agente de Azure AI con la configuración estándar, lo que significa que con la autenticación de identidad administrada para conexiones de proyecto/centro y acceso a Internet público habilitado. Los agentes usan recursos de almacenamiento y búsqueda de un solo inquilino propiedad del cliente. Con esta configuración, tiene control total y visibilidad sobre estos recursos, pero incurrirá en costos en función del uso. |
|
Aplicación web con una instancia de SQL Database, Azure Cosmos DB, Azure Search |
Esta plantilla aprovisiona una aplicación web, una instancia de SQL Database, Azure Cosmos DB, Azure Search y Application Insights. |
Formato de recurso
Para crear un recurso Microsoft.Search/searchServices, agregue el siguiente JSON a la plantilla.
{
"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"
}
}
Objetos DataIdentity
Establezca la propiedad @odata.type para especificar el tipo de objeto.
Para #Microsoft.Azure.Search.DataNoneIdentity, use:
{
"@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
}
Para #Microsoft.Azure.Search.DataUserAssignedIdentity, use:
{
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"federatedIdentityClientId": "string",
"userAssignedIdentity": "string"
}
Valores de propiedad
Microsoft.Search/searchServices
| Nombre | Description | Importancia |
|---|---|---|
| apiVersion | La versión de api | '2026-09-01-preview' |
| identity | Identidad del recurso. | Identity |
| location | Ubicación geográfica donde reside el recurso | string (obligatorio) |
| nombre | El nombre del recurso | cuerda Restricciones: Patrón = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (obligatorio) |
| properties | Propiedades del servicio de búsqueda. | SearchServiceProperties |
| sku | SKU del servicio de búsqueda, que determina el nivel de precio y los límites de capacidad. Esta propiedad es necesaria al crear un nuevo servicio de búsqueda. | Sku |
| etiquetas | Etiquetas de recursos | Diccionario de nombres y valores de etiqueta. Consulta |
| type | El tipo de recurso | 'Microsoft.Search/searchServices' |
AzureActiveDirectoryApplicationCredentials
| Nombre | Description | Importancia |
|---|---|---|
| applicationId | El ID de la aplicación (cliente) de un registro de aplicación en el inquilino. | string |
| applicationSecret | Un secreto de cliente AAD que se generó para el Registro de la App se utilizó para autenticarse con Azure Key Vault. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
Identidad de datos
| Nombre | Description | Importancia |
|---|---|---|
| @odata.type | Establézcalo en '#Microsoft.Azure.Search.DataNoneIdentity' para el tipo DataNoneIdentity. Establézcalo en '#Microsoft.Azure.Search.DataUserAssignedIdentity' para el tipo DataUserAssignedIdentity. | '#Microsoft.Azure.Search.DataNoneIdentity' '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obligatorio) |
DataNoneIdentity
| Nombre | Description | Importancia |
|---|---|---|
| @odata.type | Fragmento de URI que especifica el tipo de identidad. | '#Microsoft.Azure.Search.DataNoneIdentity' (obligatorio) |
DataPlaneAadOrApiKeyAuthOption
| Nombre | Description | Importancia |
|---|---|---|
| aadAuthFailureMode | Describe qué respuesta enviaría la API del plano de datos de un servicio de búsqueda para solicitudes con error de autenticación. | 'http401WithBearerChallenge' 'http403' |
DataPlaneAuthOptions
DataUserAssignedIdentity
| Nombre | Description | Importancia |
|---|---|---|
| @odata.type | Fragmento de URI que especifica el tipo de identidad. | '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obligatorio) |
| federatedIdentityClientId | Opcional para soporte de CMK de identidad gestionada User-Assigned multi-inquilino: El id del cliente (como UUID) del registro de aplicaciones multi-inquilino que se ha configurado para federarse con el usuarioAsignedIdentity. | string |
| userAssignedIdentity | El identificador de recurso de Azure completo de una identidad administrada asignada por el usuario normalmente con el formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que se debe haber asignado al servicio de búsqueda. | string (obligatorio) |
EncryptionWithCmk
| Nombre | Description | Importancia |
|---|---|---|
| cumplimiento | Describe cómo un servicio de búsqueda debe aplicar el cumplimiento si encuentra objetos que no están cifrados con la clave administrada por el cliente. | 'Deshabilitado' 'Habilitado' "Sin especificar" |
| serviceLevelEncryptionKey | Describe la configuración de clave gestionada por el cliente para cifrar el servicio de búsqueda. | SearchResourceEncryptionKey |
Identity
| Nombre | Description | Importancia |
|---|---|---|
| type | Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada por el sistema y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará todas las identidades del servicio. | 'Ninguno' 'SystemAssigned' 'Asignado al sistema, asignado al usuario' 'UserAssigned' (obligatorio) |
| userAssignedIdentities | Lista de identidades de usuario asociadas al recurso. Las referencias clave del diccionario de identidad de usuario serán identificadores de recursos ARM en la forma: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. ManagedIdentity/userAssignedIdentities/{identityName}'. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Nombre | Description | Importancia |
|---|
IpRule
| Nombre | Description | Importancia |
|---|---|---|
| valor | Valor correspondiente a una sola dirección IPv4 (por ejemplo, 123.1.2.3) o a un intervalo IP en formato CIDR (por ejemplo, 123.1.2.3/24) que se permitirá. | string |
NetworkRuleSet
| Nombre | Description | Importancia |
|---|---|---|
| omisión | Posibles orígenes del tráfico entrante que pueden omitir las reglas definidas en la sección "ipRules". | "AzurePortal" "AzureServices" 'Ninguno' |
| ipRules | Lista de reglas de restricción de IP que definen las redes entrantes con la posibilidad de acceder al punto de conexión de servicio de búsqueda. Mientras tanto, el firewall bloquea todas las demás redes IP públicas. Estas reglas de restricción solo se aplican cuando "publicNetworkAccess" del servicio de búsqueda está "habilitado"; De lo contrario, el tráfico a través de la interfaz pública no se permite incluso con ninguna regla de IP pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo. | ipRule[] |
SearchResourceEncryptionKey
| Nombre | Description | Importancia |
|---|---|---|
| Credenciales de acceso | Credenciales opcionales de Azure Active Directory utilizadas para acceder a tu Azure Key Vault. No es necesario si se usa la identidad administrada en su lugar. | AzureActiveDirectoryApplicationCredentials |
| identity | Una identidad administrada explícita que se va a usar para esta clave de cifrado. Si no se especifica y la propiedad de credenciales de acceso es null, se usa la identidad administrada asignada por el sistema. Al actualizar al recurso, si la identidad explícita no está especificada, permanece sin cambios. Si se especifica "none", se borra el valor de esta propiedad. | Identidad de datos |
| keyVaultKeyName | Nombre de la clave de Azure Key Vault que se usará para cifrar los datos en reposo. | string |
| keyVaultKeyVersion | Versión de la clave de Azure Key Vault que se usará para cifrar los datos en reposo. | string |
| keyVaultUri | El URI de Azure Key Vault, también denominado nombre DNS, que contiene la clave que se va a usar para cifrar los datos en reposo. Un URI de ejemplo podría ser https://my-keyvault-name.vault.azure.net. |
string |
SearchServiceProperties
| Nombre | Description | Importancia |
|---|---|---|
| authOptions | Define las opciones de cómo autentica las solicitudes la API del plano de datos de un servicio de búsqueda. No se puede establecer si 'disableLocalAuth' está establecido en true. | dataPlaneAuthOptions |
| autoGeneratedDomainNameLabelScope | Define el nivel de reutilización de la etiqueta de dominio generada automáticamente para el servicio de búsqueda (por ejemplo, myservice-uniqueId.search.windows.net<>). Si no se especifica, no se crea ninguna etiqueta de dominio generada automáticamente para el servicio de búsqueda. | 'NoReutilización' 'Reutilización de suscripciones' 'Reutilización de inquilinos' |
| computeType | Configura esta propiedad para soportar el servicio de búsqueda usando el Default Compute o Azure Confidential Compute. | "Confidencial" 'Valor predeterminado' |
| dataExfiltrationProtections | Lista de escenarios de filtración de datos que no se permiten explícitamente para el servicio de búsqueda. Actualmente, el único valor admitido es "All" para deshabilitar todos los posibles escenarios de exportación de datos con controles más específicos planeados para el futuro. | Matriz de cadenas que contiene cualquiera de: 'Bloqueartodo' |
| disableLocalAuth | Cuando se establece en true, no se permitirá que las llamadas al servicio de búsqueda usen claves de API para la autenticación. No se puede establecer en true si se definen "dataPlaneAuthOptions". | bool |
| encryptionWithCmk | Especifica cualquier directiva relacionada con el cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda. | EncryptionWithCmk |
| endpoint | El punto final del servicio Búsqueda de Azure AI. | string |
| hostingMode | Solo se aplica a la SKU estándar3. Puede establecer esta propiedad para habilitar hasta 3 particiones de alta densidad que permitan hasta 1000 índices, que es mucho mayor que los índices máximos permitidos para cualquier otra SKU. Para la SKU standard3, el valor es "Default" o "HighDensity". Para todas las demás SKU, este valor debe ser "Predeterminado". | 'Valor predeterminado' 'Alta densidad' |
| conocimientoRecuperación | Especifica el plan de facturación para la recuperación de agentes en el servicio Búsqueda de Azure AI. Esta configuración solo está disponible para ciertos niveles de precios en determinadas regiones. | 'gratis' 'standard' |
| networkRuleSet | Reglas específicas de la red que determinan cómo se puede contactar con el servicio Búsqueda de Azure AI. | NetworkRuleSet |
| partitionCount | El número de particiones en el servicio de búsqueda dedicado; Si se especifica, puede ser 1, 2, 3, 4, 6 o 12. Los valores mayores que 1 solo son válidos para las SKU estándar. Para los servicios "standard3" con hostingMode establecido en "highDensity", los valores permitidos están comprendidos entre 1 y 3. | Int Restricciones: Valor mínimo = 1 Valor máximo = 12 |
| publicNetworkAccess | Este valor se puede establecer en "Habilitado" para evitar cambios importantes en los recursos y plantillas de clientes existentes. Si se establece en "Deshabilitado", no se permite el tráfico a través de la interfaz pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo. | 'Deshabilitado' 'Habilitado' "SecuredByPerimeter" |
| replicaCount | El número de réplicas en el servicio de búsqueda dedicado. Si se especifica, debe ser un valor entre 1 y 12 inclusive para las SKU estándar o entre 1 y 3 inclusive para la SKU básica. | Int Restricciones: Valor mínimo = 1 Valor máximo = 12 |
| semánticSearch | Especifica la disponibilidad y el plan de facturación para la búsqueda semántica en el servicio Búsqueda de Azure AI. Esta configuración solo está disponible para ciertos niveles de precios en determinadas regiones. | 'Desactivado' 'gratis' 'standard' |
| upgradeAvailable | Indica si el servicio de búsqueda tiene disponible una actualización. | 'Disponible' 'no disponible' |
Sku
| Nombre | Description | Importancia |
|---|---|---|
| nombre | SKU del servicio de búsqueda. Entre los valores válidos se incluyen: "gratis": servicio compartido. 'basic': servicio dedicado con hasta 3 réplicas. 'estándar': servicio dedicado con hasta 12 particiones y 12 réplicas. 'standard2': similar al estándar, pero con más capacidad por unidad de búsqueda. 'standard3': la oferta estándar más grande con hasta 12 particiones y 12 réplicas (o hasta 3 particiones con más índices si también establece la propiedad hostingMode en 'highDensity'). 'storage_optimized_l1': admite 1 TB por partición, hasta 12 particiones. 'storage_optimized_l2': Soporta 2TB por partición, hasta 12 particiones. 'sin servidor': Nivel sin servidor con capacidades de escalado automático. | 'basic' 'gratis' 'sin servidor' 'standard' 'Estándar2' 'Estándar3' "storage_optimized_l1" "storage_optimized_l2" |
TrackedResourceTags
| Nombre | Description | Importancia |
|---|
UserAssignedIdentity
| Nombre | Description | Importancia |
|---|
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso searchServices se puede implementar con operaciones que tienen como destino:
- Grupos de recursos Para una lista de propiedades modificadas en cada versión de la API, consulte registro de cambios.
Ejemplos de uso
Ejemplos de Terraform
Un ejemplo básico de implementación del servicio de búsqueda.
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 = ["*"]
}
Módulos comprobados de Azure
Los siguientes módulos comprobados de Azure se pueden usar para implementar este tipo de recurso.
| Módulo | Description |
|---|---|
| Servicio de búsqueda | Módulo de recursos de AVM para Search Service |
Formato de recurso
Para crear un recurso Microsoft.Search/searchServices, agregue el siguiente Terraform a la plantilla.
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"
}
}
}
Objetos DataIdentity
Establezca la propiedad @odata.type para especificar el tipo de objeto.
Para #Microsoft.Azure.Search.DataNoneIdentity, use:
{
@odata.type = "#Microsoft.Azure.Search.DataNoneIdentity"
}
Para #Microsoft.Azure.Search.DataUserAssignedIdentity, use:
{
@odata.type = "#Microsoft.Azure.Search.DataUserAssignedIdentity"
federatedIdentityClientId = "string"
userAssignedIdentity = "string"
}
Valores de propiedad
Microsoft.Search/searchServices
| Nombre | Description | Importancia |
|---|---|---|
| identity | Identidad del recurso. | Identity |
| location | Ubicación geográfica donde reside el recurso | string (obligatorio) |
| nombre | El nombre del recurso | cuerda Restricciones: Patrón = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (obligatorio) |
| properties | Propiedades del servicio de búsqueda. | SearchServiceProperties |
| sku | SKU del servicio de búsqueda, que determina el nivel de precio y los límites de capacidad. Esta propiedad es necesaria al crear un nuevo servicio de búsqueda. | Sku |
| etiquetas | Etiquetas de recursos | Diccionario de nombres y valores de etiqueta. |
| type | El tipo de recurso | "Microsoft. Buscar/searchServices@2026-09-01-previa" |
AzureActiveDirectoryApplicationCredentials
| Nombre | Description | Importancia |
|---|---|---|
| applicationId | El ID de la aplicación (cliente) de un registro de aplicación en el inquilino. | string |
| applicationSecret | Un secreto de cliente AAD que se generó para el Registro de la App se utilizó para autenticarse con Azure Key Vault. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
Identidad de datos
| Nombre | Description | Importancia |
|---|---|---|
| @odata.type | Establézcalo en '#Microsoft.Azure.Search.DataNoneIdentity' para el tipo DataNoneIdentity. Establézcalo en '#Microsoft.Azure.Search.DataUserAssignedIdentity' para el tipo DataUserAssignedIdentity. | '#Microsoft.Azure.Search.DataNoneIdentity' '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obligatorio) |
DataNoneIdentity
| Nombre | Description | Importancia |
|---|---|---|
| @odata.type | Fragmento de URI que especifica el tipo de identidad. | '#Microsoft.Azure.Search.DataNoneIdentity' (obligatorio) |
DataPlaneAadOrApiKeyAuthOption
| Nombre | Description | Importancia |
|---|---|---|
| aadAuthFailureMode | Describe qué respuesta enviaría la API del plano de datos de un servicio de búsqueda para solicitudes con error de autenticación. | 'http401WithBearerChallenge' 'http403' |
DataPlaneAuthOptions
DataUserAssignedIdentity
| Nombre | Description | Importancia |
|---|---|---|
| @odata.type | Fragmento de URI que especifica el tipo de identidad. | '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obligatorio) |
| federatedIdentityClientId | Opcional para soporte de CMK de identidad gestionada User-Assigned multi-inquilino: El id del cliente (como UUID) del registro de aplicaciones multi-inquilino que se ha configurado para federarse con el usuarioAsignedIdentity. | string |
| userAssignedIdentity | El identificador de recurso de Azure completo de una identidad administrada asignada por el usuario normalmente con el formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que se debe haber asignado al servicio de búsqueda. | string (obligatorio) |
EncryptionWithCmk
| Nombre | Description | Importancia |
|---|---|---|
| cumplimiento | Describe cómo un servicio de búsqueda debe aplicar el cumplimiento si encuentra objetos que no están cifrados con la clave administrada por el cliente. | 'Deshabilitado' 'Habilitado' "Sin especificar" |
| serviceLevelEncryptionKey | Describe la configuración de clave gestionada por el cliente para cifrar el servicio de búsqueda. | SearchResourceEncryptionKey |
Identity
| Nombre | Description | Importancia |
|---|---|---|
| type | Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada por el sistema y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará todas las identidades del servicio. | 'Ninguno' 'SystemAssigned' 'Asignado al sistema, asignado al usuario' 'UserAssigned' (obligatorio) |
| userAssignedIdentities | Lista de identidades de usuario asociadas al recurso. Las referencias clave del diccionario de identidad de usuario serán identificadores de recursos ARM en la forma: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. ManagedIdentity/userAssignedIdentities/{identityName}'. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Nombre | Description | Importancia |
|---|
IpRule
| Nombre | Description | Importancia |
|---|---|---|
| valor | Valor correspondiente a una sola dirección IPv4 (por ejemplo, 123.1.2.3) o a un intervalo IP en formato CIDR (por ejemplo, 123.1.2.3/24) que se permitirá. | string |
NetworkRuleSet
| Nombre | Description | Importancia |
|---|---|---|
| omisión | Posibles orígenes del tráfico entrante que pueden omitir las reglas definidas en la sección "ipRules". | "AzurePortal" "AzureServices" 'Ninguno' |
| ipRules | Lista de reglas de restricción de IP que definen las redes entrantes con la posibilidad de acceder al punto de conexión de servicio de búsqueda. Mientras tanto, el firewall bloquea todas las demás redes IP públicas. Estas reglas de restricción solo se aplican cuando "publicNetworkAccess" del servicio de búsqueda está "habilitado"; De lo contrario, el tráfico a través de la interfaz pública no se permite incluso con ninguna regla de IP pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo. | ipRule[] |
SearchResourceEncryptionKey
| Nombre | Description | Importancia |
|---|---|---|
| Credenciales de acceso | Credenciales opcionales de Azure Active Directory utilizadas para acceder a tu Azure Key Vault. No es necesario si se usa la identidad administrada en su lugar. | AzureActiveDirectoryApplicationCredentials |
| identity | Una identidad administrada explícita que se va a usar para esta clave de cifrado. Si no se especifica y la propiedad de credenciales de acceso es null, se usa la identidad administrada asignada por el sistema. Al actualizar al recurso, si la identidad explícita no está especificada, permanece sin cambios. Si se especifica "none", se borra el valor de esta propiedad. | Identidad de datos |
| keyVaultKeyName | Nombre de la clave de Azure Key Vault que se usará para cifrar los datos en reposo. | string |
| keyVaultKeyVersion | Versión de la clave de Azure Key Vault que se usará para cifrar los datos en reposo. | string |
| keyVaultUri | El URI de Azure Key Vault, también denominado nombre DNS, que contiene la clave que se va a usar para cifrar los datos en reposo. Un URI de ejemplo podría ser https://my-keyvault-name.vault.azure.net. |
string |
SearchServiceProperties
| Nombre | Description | Importancia |
|---|---|---|
| authOptions | Define las opciones de cómo autentica las solicitudes la API del plano de datos de un servicio de búsqueda. No se puede establecer si 'disableLocalAuth' está establecido en true. | dataPlaneAuthOptions |
| autoGeneratedDomainNameLabelScope | Define el nivel de reutilización de la etiqueta de dominio generada automáticamente para el servicio de búsqueda (por ejemplo, myservice-uniqueId.search.windows.net<>). Si no se especifica, no se crea ninguna etiqueta de dominio generada automáticamente para el servicio de búsqueda. | 'NoReutilización' 'Reutilización de suscripciones' 'Reutilización de inquilinos' |
| computeType | Configura esta propiedad para soportar el servicio de búsqueda usando el Default Compute o Azure Confidential Compute. | "Confidencial" 'Valor predeterminado' |
| dataExfiltrationProtections | Lista de escenarios de filtración de datos que no se permiten explícitamente para el servicio de búsqueda. Actualmente, el único valor admitido es "All" para deshabilitar todos los posibles escenarios de exportación de datos con controles más específicos planeados para el futuro. | Matriz de cadenas que contiene cualquiera de: 'Bloqueartodo' |
| disableLocalAuth | Cuando se establece en true, no se permitirá que las llamadas al servicio de búsqueda usen claves de API para la autenticación. No se puede establecer en true si se definen "dataPlaneAuthOptions". | bool |
| encryptionWithCmk | Especifica cualquier directiva relacionada con el cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda. | EncryptionWithCmk |
| endpoint | El punto final del servicio Búsqueda de Azure AI. | string |
| hostingMode | Solo se aplica a la SKU estándar3. Puede establecer esta propiedad para habilitar hasta 3 particiones de alta densidad que permitan hasta 1000 índices, que es mucho mayor que los índices máximos permitidos para cualquier otra SKU. Para la SKU standard3, el valor es "Default" o "HighDensity". Para todas las demás SKU, este valor debe ser "Predeterminado". | 'Valor predeterminado' 'Alta densidad' |
| conocimientoRecuperación | Especifica el plan de facturación para la recuperación de agentes en el servicio Búsqueda de Azure AI. Esta configuración solo está disponible para ciertos niveles de precios en determinadas regiones. | 'gratis' 'standard' |
| networkRuleSet | Reglas específicas de la red que determinan cómo se puede contactar con el servicio Búsqueda de Azure AI. | NetworkRuleSet |
| partitionCount | El número de particiones en el servicio de búsqueda dedicado; Si se especifica, puede ser 1, 2, 3, 4, 6 o 12. Los valores mayores que 1 solo son válidos para las SKU estándar. Para los servicios "standard3" con hostingMode establecido en "highDensity", los valores permitidos están comprendidos entre 1 y 3. | Int Restricciones: Valor mínimo = 1 Valor máximo = 12 |
| publicNetworkAccess | Este valor se puede establecer en "Habilitado" para evitar cambios importantes en los recursos y plantillas de clientes existentes. Si se establece en "Deshabilitado", no se permite el tráfico a través de la interfaz pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo. | 'Deshabilitado' 'Habilitado' "SecuredByPerimeter" |
| replicaCount | El número de réplicas en el servicio de búsqueda dedicado. Si se especifica, debe ser un valor entre 1 y 12 inclusive para las SKU estándar o entre 1 y 3 inclusive para la SKU básica. | Int Restricciones: Valor mínimo = 1 Valor máximo = 12 |
| semánticSearch | Especifica la disponibilidad y el plan de facturación para la búsqueda semántica en el servicio Búsqueda de Azure AI. Esta configuración solo está disponible para ciertos niveles de precios en determinadas regiones. | 'Desactivado' 'gratis' 'standard' |
| upgradeAvailable | Indica si el servicio de búsqueda tiene disponible una actualización. | 'Disponible' 'no disponible' |
Sku
| Nombre | Description | Importancia |
|---|---|---|
| nombre | SKU del servicio de búsqueda. Entre los valores válidos se incluyen: "gratis": servicio compartido. 'basic': servicio dedicado con hasta 3 réplicas. 'estándar': servicio dedicado con hasta 12 particiones y 12 réplicas. 'standard2': similar al estándar, pero con más capacidad por unidad de búsqueda. 'standard3': la oferta estándar más grande con hasta 12 particiones y 12 réplicas (o hasta 3 particiones con más índices si también establece la propiedad hostingMode en 'highDensity'). 'storage_optimized_l1': admite 1 TB por partición, hasta 12 particiones. 'storage_optimized_l2': Soporta 2TB por partición, hasta 12 particiones. 'sin servidor': Nivel sin servidor con capacidades de escalado automático. | 'basic' 'gratis' 'sin servidor' 'standard' 'Estándar2' 'Estándar3' "storage_optimized_l1" "storage_optimized_l2" |
TrackedResourceTags
| Nombre | Description | Importancia |
|---|
UserAssignedIdentity
| Nombre | Description | Importancia |
|---|