Microsoft. Búsqueda searchServices 2022-09-01

Artículo
05/07/2024

Definición de recursos de Bicep

El tipo de recurso searchServices se puede implementar con operaciones destinadas a:

Grupos de recursos: consulte los comandos de implementación del grupo de recursos.

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un microsoft. Búsqueda/searchServices, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.Search/searchServices@2022-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  identity: {
    type: '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
  }
}

Valores de propiedad

searchServices

Nombre	Descripción	Value
name	El nombre del recurso	string (obligatorio)
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
sku	SKU del servicio de Búsqueda, que determina los límites de nivel de tarifa y capacidad. Esta propiedad es necesaria al crear un nuevo servicio de Búsqueda.	Sku
identidad	Identidad del recurso.	Identidad
properties	Propiedades del servicio de búsqueda.	SearchServiceProperties

Identidad

Nombre	Descripción	Value
type	Tipo de identidad.	'Ninguno' 'SystemAssigned' (obligatorio)

SearchServiceProperties

Nombre	Descripción	Valor
authOptions	Define las opciones de cómo la API del plano de datos de un servicio de búsqueda autentica las solicitudes. No se puede establecer si "disableLocalAuth" está establecido en true.	DataPlaneAuthOptions
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 relativa al cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda.	EncryptionWithCmk
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 "default".	'default' 'highDensity'
networkRuleSet	Reglas específicas de red que determinan cómo se puede acceder al servicio Azure Cognitive Search.	NetworkRuleSet
partitionCount	Número de particiones en el servicio de búsqueda; 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 cliente 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.	'disabled' "habilitado"
replicaCount	Número de réplicas en el servicio de búsqueda. 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

DataPlaneAuthOptions

Nombre	Descripción	Valor
aadOrApiKey	Indica que se puede usar la clave de API o un token de acceso de Azure Active Directory para la autenticación.	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	Indica que solo se debe usar la clave de API para la autenticación.	Para Bicep, puede usar la función any().

DataPlaneAadOrApiKeyAuthOption

Nombre	Descripción	Valor
aadAuthFailureMode	Describe qué respuesta enviaría la API del plano de datos de un servicio Search para las solicitudes con errores de autenticación.	'http401WithBearerChallenge' 'http403'

EncryptionWithCmk

Nombre	Descripción	Valor
Aplicación	Describe cómo un servicio de búsqueda debe exigir que uno o varios recursos no cifrados por el cliente.	'Deshabilitado' 'Habilitado' 'Sin especificar'

NetworkRuleSet

Nombre	Descripción	Valor
ipRules	Lista de reglas de restricción de IP que definen las redes entrantes con permiso de acceso al punto de conexión del 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[]

IpRule

Nombre	Descripción	Valor
value	Valor correspondiente a una única dirección IPv4 (por ejemplo, 123.1.2.3) o a un intervalo IP en formato CIDR (p. ej., 123.1.2.3/24) que se va a permitir.	string

SKU

Nombre	Descripción	Value
name	SKU del servicio de búsqueda. Los valores válidos 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": admite 2 TB por partición, hasta 12 particiones".	'basic' 'gratis' 'estándar' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla	Descripción
Aplicación web con una SQL Database, Azure Cosmos DB, Azure Búsqueda	Esta plantilla aprovisiona una aplicación web, una SQL Database, Azure Cosmos DB, Azure Búsqueda y Application Insights.
Servicio Azure Cognitive Search	Esta plantilla crea un servicio Azure Cognitive Search
Azure Cognitive Search servicio con punto de conexión privado	Esta plantilla crea un servicio Azure Cognitive Search con un punto de conexión privado.

Definición de recursos de plantilla de ARM

El tipo de recurso searchServices se puede implementar con operaciones destinadas a:

Grupos de recursos: consulte los comandos de implementación del grupo de recursos.

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear una instancia de Microsoft. Búsqueda/searchServices, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2022-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "string"
      },
      "apiKeyOnly": {}
    },
    "disableLocalAuth": "bool",
    "encryptionWithCmk": {
      "enforcement": "string"
    },
    "hostingMode": "string",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int"
  }
}

Valores de propiedad

searchServices

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft. Búsqueda/searchServices'
apiVersion	La versión de la API de recursos	'2022-09-01'
name	El nombre del recurso	string (obligatorio)
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
sku	SKU del servicio de Búsqueda, que determina los límites de nivel de tarifa y capacidad. Esta propiedad es necesaria al crear un nuevo servicio de Búsqueda.	Sku
identidad	Identidad del recurso.	Identidad
properties	Propiedades del servicio de búsqueda.	SearchServiceProperties

Identidad

Nombre	Descripción	Value
type	Tipo de identidad.	'Ninguno' 'SystemAssigned' (obligatorio)

SearchServiceProperties

Nombre	Descripción	Valor
authOptions	Define las opciones de cómo la API del plano de datos de un servicio de búsqueda autentica las solicitudes. No se puede establecer si "disableLocalAuth" está establecido en true.	DataPlaneAuthOptions
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 relativa al cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda.	EncryptionWithCmk
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 "default".	'default' 'highDensity'
networkRuleSet	Reglas específicas de red que determinan cómo se puede acceder al servicio Azure Cognitive Search.	NetworkRuleSet
partitionCount	Número de particiones en el servicio de búsqueda; 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 cliente 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.	'disabled' "habilitado"
replicaCount	Número de réplicas en el servicio de búsqueda. 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

DataPlaneAuthOptions

Nombre	Descripción	Valor
aadOrApiKey	Indica que la clave de API o un token de acceso de Azure Active Directory se pueden usar para la autenticación.	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	Indica que solo se debe usar la clave de API para la autenticación.

DataPlaneAadOrApiKeyAuthOption

Nombre	Descripción	Valor
aadAuthFailureMode	Describe qué respuesta enviaría la API del plano de datos de un servicio Search para las solicitudes con errores de autenticación.	'http401WithBearerChallenge' 'http403'

EncryptionWithCmk

Nombre	Descripción	Valor
Aplicación	Describe cómo un servicio de búsqueda debe exigir tener uno o varios recursos cifrados por el cliente.	'Deshabilitado' 'Habilitado' "Sin especificar"

NetworkRuleSet

Nombre	Descripción	Valor
ipRules	Lista de reglas de restricción de IP que definen las redes entrantes con el permiso de acceso al punto de conexión del 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, no se permite el tráfico a través de la interfaz pública, ni siquiera 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[]

IpRule

Nombre	Descripción	Valor
value	Valor correspondiente a una única dirección IPv4 (por ejemplo, 123.1.2.3) o a un intervalo IP en formato CIDR (p. ej., 123.1.2.3/24) que se va a permitir.	string

SKU

Nombre	Descripción	Value
name	SKU del servicio de búsqueda. Los valores válidos 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": admite 2 TB por partición, hasta 12 particiones".	'basic' 'gratis' 'estándar' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla	Descripción
Aplicación web con una SQL Database, Azure Cosmos DB, Azure Búsqueda	Esta plantilla aprovisiona una aplicación web, una SQL Database, Azure Cosmos DB, Azure Búsqueda y Application Insights.
Servicio Azure Cognitive Search	Esta plantilla crea un servicio Azure Cognitive Search
Azure Cognitive Search servicio con punto de conexión privado	Esta plantilla crea un servicio Azure Cognitive Search con un punto de conexión privado.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso searchServices se puede implementar con operaciones destinadas a:

Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear una instancia de Microsoft. Búsqueda/searchServices, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2022-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      authOptions = {
        aadOrApiKey = {
          aadAuthFailureMode = "string"
        }
      }
      disableLocalAuth = bool
      encryptionWithCmk = {
        enforcement = "string"
      }
      hostingMode = "string"
      networkRuleSet = {
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
    }
    sku = {
      name = "string"
    }
  })
}

Valores de propiedad

searchServices

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft. Búsqueda/searchServices@2022-09-01"
name	El nombre del recurso	string (obligatorio)
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
parent_id	Para realizar la implementación en un grupo de recursos, use el identificador de ese grupo de recursos.	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta.
sku	La SKU del servicio de Búsqueda, que determina los límites de nivel de precio y capacidad. Esta propiedad es necesaria al crear un nuevo servicio de Búsqueda.	Sku
identidad	Identidad del recurso.	Identidad
properties	Propiedades del servicio de búsqueda.	SearchServiceProperties

Identidad

Nombre	Descripción	Value
type	Tipo de identidad.	"SystemAssigned" (obligatorio)

SearchServiceProperties

Nombre	Descripción	Valor
authOptions	Define las opciones de cómo la API del plano de datos de un servicio de búsqueda autentica las solicitudes. No se puede establecer si "disableLocalAuth" está establecido en true.	DataPlaneAuthOptions
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 relativa al cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda.	EncryptionWithCmk
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 "default".	"predeterminado" "highDensity"
networkRuleSet	Reglas específicas de red que determinan cómo se puede acceder al servicio Azure Cognitive Search.	NetworkRuleSet
partitionCount	Número de particiones en el servicio de búsqueda; 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 cliente 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.	"disabled" "enabled"
replicaCount	Número de réplicas en el servicio de búsqueda. 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

DataPlaneAuthOptions

Nombre	Descripción	Valor
aadOrApiKey	Indica que la clave de API o un token de acceso de Azure Active Directory se pueden usar para la autenticación.	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	Indica que solo se debe usar la clave de API para la autenticación.

DataPlaneAadOrApiKeyAuthOption

Nombre	Descripción	Valor
aadAuthFailureMode	Describe qué respuesta enviaría la API del plano de datos de un servicio Search para las solicitudes con errores de autenticación.	"http401WithBearerChallenge" "http403"

EncryptionWithCmk

Nombre	Descripción	Valor
Aplicación	Describe cómo un servicio de búsqueda debe exigir tener uno o varios recursos cifrados por el cliente.	"Deshabilitado" "Habilitado" "Sin especificar"

NetworkRuleSet

Nombre	Descripción	Valor
ipRules	Lista de reglas de restricción de IP que definen las redes entrantes con el permiso de acceso al punto de conexión del 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, no se permite el tráfico a través de la interfaz pública, ni siquiera 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[]

IpRule

Nombre	Descripción	Valor
value	Valor correspondiente a una sola dirección IPv4 (por ejemplo, 123.1.2.3) o a un intervalo IP en formato CIDR (p. ej., 123.1.2.3/24) que se permitirá.	string

SKU

Nombre	Descripción	Value
name	SKU del servicio de búsqueda. Entre los valores válidos se incluyen: "gratis": servicio compartido. "básico": 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": admite 2 TB por partición, hasta 12 particiones".	"basic" "gratis" "estándar" "standard2" "standard3" "storage_optimized_l1" "storage_optimized_l2"

Compartir a través de

Microsoft. Búsqueda searchServices 2022-09-01

Definición de recursos de Bicep

Formato de los recursos

Valores de propiedad

searchServices

Identidad

SearchServiceProperties

DataPlaneAuthOptions

DataPlaneAadOrApiKeyAuthOption

EncryptionWithCmk

NetworkRuleSet

IpRule

SKU

Plantillas de inicio rápido

Definición de recursos de plantilla de ARM

Formato de los recursos

Valores de propiedad

searchServices

Identidad

SearchServiceProperties

DataPlaneAuthOptions

DataPlaneAadOrApiKeyAuthOption

EncryptionWithCmk

NetworkRuleSet

IpRule

SKU

Plantillas de inicio rápido

Definición de recursos de Terraform (proveedor AzAPI)

Formato de los recursos

Valores de propiedad

searchServices

Identidad

SearchServiceProperties

DataPlaneAuthOptions

DataPlaneAadOrApiKeyAuthOption

EncryptionWithCmk

NetworkRuleSet

IpRule

SKU

Comentarios

Comentarios

Recursos adicionales