Compartir a través de

SearchService interface

  • Referencia
Paquete:
@azure/arm-search

Describe un servicio Azure Cognitive Search y su estado actual.

Extends
TrackedResource

Propiedades

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.
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".
encryptionWithCmk

Especifica cualquier directiva relativa al cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda.
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".
identity

Identidad del recurso.
networkRuleSet

Reglas específicas de red que determinan cómo se puede acceder al servicio Azure Cognitive Search.
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.
privateEndpointConnections

Lista de conexiones de punto de conexión privado al servicio Azure Cognitive Search. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
provisioningState

Estado de la última operación de aprovisionamiento realizada en el servicio de búsqueda. El aprovisionamiento es un estado intermedio que se produce cuando se está estableciendo la capacidad de servicio. Una vez configurada la capacidad, provisioningState cambia a "succeeded" o "failed". Las aplicaciones cliente pueden sondear el estado de aprovisionamiento (el intervalo de sondeo recomendado es de 30 segundos a un minuto) mediante la operación Get Search Service para ver cuándo se completa una operación. Si usa el servicio gratuito, este valor tiende a volver como "correcto" directamente en la llamada a Crear servicio de búsqueda. Esto ocurre porque el servicio gratuito usa una capacidad que ya está configurada. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
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.
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.
semanticSearch

Establece las opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de Azure Cognitive Search en determinadas ubicaciones.
sharedPrivateLinkResources

La lista de recursos de vínculo privado compartido administrados por el servicio Azure Cognitive Search. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
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.
status

Estado del servicio de búsqueda. Entre los valores posibles se incluyen: "running": el servicio de búsqueda se está ejecutando y no hay ninguna operación de aprovisionamiento en curso. "aprovisionamiento": el servicio de búsqueda se está aprovisionando o escalando verticalmente o verticalmente. 'eliminar': se está eliminando el servicio de búsqueda. 'degradado': el servicio de búsqueda está degradado. Esto puede ocurrir cuando las unidades de búsqueda subyacentes no están en buen estado. El servicio de búsqueda es más probable que esté operativo, pero el rendimiento puede ser lento y es posible que se quiten algunas solicitudes. 'disabled': el servicio de búsqueda está deshabilitado. En este estado, el servicio rechazará todas las solicitudes de API. 'error': el servicio de búsqueda está en estado de error. Si el servicio está en los estados degradados, deshabilitados o de error, significa que el equipo de Azure Cognitive Search está investigando activamente el problema subyacente. En estos estados, los servicios dedicados son todavía facturables en función del número de unidades de búsqueda aprovisionado. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
statusDetails

Detalles del estado del servicio de búsqueda. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

Propiedades heredadas

id

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
location

Ubicación geográfica donde reside el recurso
name

El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
tags

Etiquetas del recurso.
type

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

Detalles de las propiedades

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.

authOptions?: DataPlaneAuthOptions

Valor de propiedad

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".

disableLocalAuth?: boolean

Valor de propiedad

boolean

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?: EncryptionWithCmk

Valor de propiedad

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".

hostingMode?: HostingMode

Valor de propiedad

HostingMode

identity

Identidad del recurso.

identity?: Identity

Valor de propiedad

Identity

networkRuleSet

Reglas específicas de red que determinan cómo se puede acceder al servicio Azure Cognitive Search.

networkRuleSet?: NetworkRuleSet

Valor de propiedad

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.

partitionCount?: number

Valor de propiedad

number

privateEndpointConnections

Lista de conexiones de punto de conexión privado al servicio Azure Cognitive Search. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

privateEndpointConnections?: PrivateEndpointConnection[]

Valor de propiedad

PrivateEndpointConnection[]

provisioningState

Estado de la última operación de aprovisionamiento realizada en el servicio de búsqueda. El aprovisionamiento es un estado intermedio que se produce cuando se está estableciendo la capacidad de servicio. Una vez configurada la capacidad, provisioningState cambia a "succeeded" o "failed". Las aplicaciones cliente pueden sondear el estado de aprovisionamiento (el intervalo de sondeo recomendado es de 30 segundos a un minuto) mediante la operación Get Search Service para ver cuándo se completa una operación. Si usa el servicio gratuito, este valor tiende a volver como "correcto" directamente en la llamada a Crear servicio de búsqueda. Esto ocurre porque el servicio gratuito usa una capacidad que ya está configurada. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

provisioningState?: ProvisioningState

Valor de propiedad

ProvisioningState

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.

publicNetworkAccess?: PublicNetworkAccess

Valor de propiedad

PublicNetworkAccess

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.

replicaCount?: number

Valor de propiedad

number

semanticSearch

Establece las opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de Azure Cognitive Search en determinadas ubicaciones.

semanticSearch?: string

Valor de propiedad

string

sharedPrivateLinkResources

La lista de recursos de vínculo privado compartido administrados por el servicio Azure Cognitive Search. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Valor de propiedad

SharedPrivateLinkResource[]

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?: Sku

Valor de propiedad

Sku

status

Estado del servicio de búsqueda. Entre los valores posibles se incluyen: "running": el servicio de búsqueda se está ejecutando y no hay ninguna operación de aprovisionamiento en curso. "aprovisionamiento": el servicio de búsqueda se está aprovisionando o escalando verticalmente o verticalmente. 'eliminar': se está eliminando el servicio de búsqueda. 'degradado': el servicio de búsqueda está degradado. Esto puede ocurrir cuando las unidades de búsqueda subyacentes no están en buen estado. El servicio de búsqueda es más probable que esté operativo, pero el rendimiento puede ser lento y es posible que se quiten algunas solicitudes. 'disabled': el servicio de búsqueda está deshabilitado. En este estado, el servicio rechazará todas las solicitudes de API. 'error': el servicio de búsqueda está en estado de error. Si el servicio está en los estados degradados, deshabilitados o de error, significa que el equipo de Azure Cognitive Search está investigando activamente el problema subyacente. En estos estados, los servicios dedicados son todavía facturables en función del número de unidades de búsqueda aprovisionado. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

status?: SearchServiceStatus

Valor de propiedad

SearchServiceStatus

statusDetails

Detalles del estado del servicio de búsqueda. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

statusDetails?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

id

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

id?: string

Valor de propiedad

string

Heredado deTrackedResource.id

location

Ubicación geográfica donde reside el recurso

location: string

Valor de propiedad

string

Heredado deTrackedResource.location

name

El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

name?: string

Valor de propiedad

string

Heredado deTrackedResource.name

tags

Etiquetas del recurso.

tags?: {[propertyName: string]: string}

Valor de propiedad

{[propertyName: string]: string}

Heredado deTrackedResource.tags

type

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

type?: string

Valor de propiedad

string

Heredado deTrackedResource.type