Microsoft.Search searchServices 2023-11-01

Artículo
12/20/2024

Definición de recursos de Bicep

El tipo de recurso searchServices se puede implementar con operaciones que tienen como destino:

grupos de recursos: consulte comandos de implementación de grupos de recursos

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

Formato de recurso

Para crear un recurso Microsoft.Search/searchServices, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.Search/searchServices@2023-11-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    authOptions: {
      aadOrApiKey: {
        aadAuthFailureMode: 'string'
      }
      apiKeyOnly: any(Azure.Bicep.Types.Concrete.AnyType)
    }
    disableLocalAuth: bool
    encryptionWithCmk: {
      enforcement: 'string'
    }
    hostingMode: 'string'
    networkRuleSet: {
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
    semanticSearch: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

DataPlaneAadOrApiKeyAuthOption

Nombre	Descripción	Valor
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

Nombre	Descripción	Valor
aadOrApiKey	Indica que se puede usar la clave de API o un token de acceso de un inquilino de Id. de Microsoft Entra para la autenticación.	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	Indica que solo se puede usar la clave de API para la autenticación.	cualquier

EncryptionWithCmk

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

Identidad

Nombre	Descripción	Valor
tipo	Tipo de identidad.	'Ninguno' 'SystemAssigned' (obligatorio)

IpRule

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

Microsoft.Search/searchServices

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

NetworkRuleSet

Nombre	Descripción	Valor
ipRules	Lista de reglas de restricción de IP usadas para un firewall de IP. El firewall bloquea las direcciones IP que no coinciden con las reglas. Estas reglas solo se aplican cuando "publicNetworkAccess" del servicio de búsqueda está "habilitado".	ipRule[]

SearchServiceProperties

Nombre	Descripción	Valor
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
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
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 estándar3, el valor es "default" o "highDensity". Para todas las demás SKU, este valor debe ser "predeterminado".	'default' 'highDensity'
networkRuleSet	Reglas específicas de la red que determinan cómo se puede acceder al servicio de búsqueda.	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 las plantillas y los recursos del 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
semanticSearch	Establece opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de búsqueda en determinadas ubicaciones.	'disabled' 'gratis' 'estándar'

Sku

Nombre	Descripción	Valor
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": admite 2 TB por partición, hasta 12 particiones".	'basic' 'gratis' 'estándar' 'standard2' 'standard3' "storage_optimized_l1" "storage_optimized_l2"

TrackedResourceTags

Nombre	Descripción	Valor

Ejemplos de inicio rápido

En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.

Archivo de Bicep	Descripción
red restringida de Azure AI Studio Network	Este conjunto de plantillas muestra cómo configurar Azure AI Studio con vínculo privado y 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

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: consulte comandos de implementación de grupos de recursos

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

Formato de recurso

Para crear un recurso Microsoft.Search/searchServices, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2023-11-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "string"
      },
      "apiKeyOnly": {}
    },
    "disableLocalAuth": "bool",
    "encryptionWithCmk": {
      "enforcement": "string"
    },
    "hostingMode": "string",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int",
    "semanticSearch": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

DataPlaneAadOrApiKeyAuthOption

Nombre	Descripción	Valor
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

Nombre	Descripción	Valor
aadOrApiKey	Indica que se puede usar la clave de API o un token de acceso de un inquilino de Id. de Microsoft Entra para la autenticación.	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	Indica que solo se puede usar la clave de API para la autenticación.	cualquier

EncryptionWithCmk

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

Identidad

Nombre	Descripción	Valor
tipo	Tipo de identidad.	'Ninguno' 'SystemAssigned' (obligatorio)

IpRule

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

Microsoft.Search/searchServices

Nombre	Descripción	Valor
apiVersion	La versión de api	'2023-11-01'
identidad	Identidad del recurso.	Identity
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades del servicio de búsqueda.	SearchServiceProperties
Sku	SKU del servicio de búsqueda, que determina la tasa de facturación y los límites de capacidad. Esta propiedad es necesaria al crear un nuevo servicio de búsqueda.	Sku de
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo	El tipo de recurso	'Microsoft.Search/searchServices'

NetworkRuleSet

Nombre	Descripción	Valor
ipRules	Lista de reglas de restricción de IP usadas para un firewall de IP. El firewall bloquea las direcciones IP que no coinciden con las reglas. Estas reglas solo se aplican cuando "publicNetworkAccess" del servicio de búsqueda está "habilitado".	ipRule[]

SearchServiceProperties

Nombre	Descripción	Valor
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
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
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 estándar3, el valor es "default" o "highDensity". Para todas las demás SKU, este valor debe ser "predeterminado".	'default' 'highDensity'
networkRuleSet	Reglas específicas de la red que determinan cómo se puede acceder al servicio de búsqueda.	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 las plantillas y los recursos del 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
semanticSearch	Establece opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de búsqueda en determinadas ubicaciones.	'disabled' 'gratis' 'estándar'

Sku

Nombre	Descripción	Valor
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": admite 2 TB por partición, hasta 12 particiones".	'basic' 'gratis' 'estándar' 'standard2' 'standard3' "storage_optimized_l1" "storage_optimized_l2"

TrackedResourceTags

Nombre	Descripción	Valor

Plantillas de inicio rápido

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

Plantilla	Descripción
red restringida de Azure AI Studio Network	Este conjunto de plantillas muestra cómo configurar Azure AI Studio con vínculo privado y 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.
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.

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 de

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

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@2023-11-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authOptions = {
        aadOrApiKey = {
          aadAuthFailureMode = "string"
        }
        apiKeyOnly = ?
      }
      disableLocalAuth = bool
      encryptionWithCmk = {
        enforcement = "string"
      }
      hostingMode = "string"
      networkRuleSet = {
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
      semanticSearch = "string"
    }
  })
}

Valores de propiedad

DataPlaneAadOrApiKeyAuthOption

Nombre	Descripción	Valor
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

Nombre	Descripción	Valor
aadOrApiKey	Indica que se puede usar la clave de API o un token de acceso de un inquilino de Id. de Microsoft Entra para la autenticación.	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	Indica que solo se puede usar la clave de API para la autenticación.	cualquier

EncryptionWithCmk

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

Identidad

Nombre	Descripción	Valor
tipo	Tipo de identidad.	'Ninguno' 'SystemAssigned' (obligatorio)

IpRule

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

Microsoft.Search/searchServices

Nombre	Descripción	Valor
identidad	Identidad del recurso.	Identity
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades del servicio de búsqueda.	SearchServiceProperties
Sku	SKU del servicio de búsqueda, que determina la tasa de facturación y los límites de capacidad. Esta propiedad es necesaria al crear un nuevo servicio de búsqueda.	Sku de
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta.
tipo	El tipo de recurso	"Microsoft.Search/searchServices@2023-11-01"

NetworkRuleSet

Nombre	Descripción	Valor
ipRules	Lista de reglas de restricción de IP usadas para un firewall de IP. El firewall bloquea las direcciones IP que no coinciden con las reglas. Estas reglas solo se aplican cuando "publicNetworkAccess" del servicio de búsqueda está "habilitado".	ipRule[]

SearchServiceProperties

Nombre	Descripción	Valor
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
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
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 estándar3, el valor es "default" o "highDensity". Para todas las demás SKU, este valor debe ser "predeterminado".	'default' 'highDensity'
networkRuleSet	Reglas específicas de la red que determinan cómo se puede acceder al servicio de búsqueda.	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 las plantillas y los recursos del 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
semanticSearch	Establece opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de búsqueda en determinadas ubicaciones.	'disabled' 'gratis' 'estándar'

Sku

Nombre	Descripción	Valor
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": admite 2 TB por partición, hasta 12 particiones".	'basic' 'gratis' 'estándar' 'standard2' 'standard3' "storage_optimized_l1" "storage_optimized_l2"

TrackedResourceTags

Nombre	Descripción	Valor

Compartir a través de

Microsoft.Search searchServices 2023-11-01

Definición de recursos de Bicep

Formato de recurso

Valores de propiedad

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Identidad

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

Ejemplos de inicio rápido

Definición de recursos de plantilla de ARM

Formato de recurso

Valores de propiedad

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Identidad

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

Plantillas de inicio rápido

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Valores de propiedad

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Identidad

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

Comentarios

Recursos adicionales