Compartir a través de

SearchService interface

Paquete:
@azure/arm-search

Describe un servicio azure AI Search y su estado actual.

Extends
TrackedResource

Propiedades

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

Configure esta propiedad para admitir el servicio de búsqueda mediante el proceso predeterminado o Azure Confidential Compute.
disabledDataExfiltrationOptions

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.
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 relacionada con el cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda.
endpoint

Punto de conexión del servicio Azure AI Search.
eTag

Propiedad generada por el sistema que representa la etiqueta electrónica del servicio que puede ser para el control de simultaneidad optimista durante las actualizaciones. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
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".
identity

Identidad del recurso.
networkRuleSet

Reglas específicas de red que determinan cómo se puede acceder al servicio Azure AI 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 AI 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 mientras se establece la capacidad del 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 Obtener servicio de búsqueda 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 se debe a que el servicio gratuito usa 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 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.
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 opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de Azure AI Search en determinadas ubicaciones.
serviceUpgradeDate

Fecha y hora en que se actualizó por última vez el servicio de búsqueda. Este campo será NULL hasta que el servicio se actualice por primera vez. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
sharedPrivateLinkResources

La lista de recursos de vínculo privado compartido administrados por el servicio Azure AI 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: "en ejecución": 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': el servicio de búsqueda se está eliminando. 'degradado': el servicio de búsqueda está degradado. Esto puede ocurrir cuando las unidades de búsqueda subyacentes no están en buen estado. Es más probable que el servicio de búsqueda esté operativo, pero el rendimiento podría ser lento y algunas solicitudes se podrían quitar. '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 un estado de error. 'detenido': el servicio de búsqueda está en una suscripción que está deshabilitada. Si el servicio está en los estados degradados, deshabilitados o de error, significa que el equipo de Azure AI Search está investigando activamente el problema subyacente. Los servicios dedicados de estos estados siguen siendo cobrables en función del número de unidades de búsqueda aprovisionadas. 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.
systemData

Metadatos de Azure Resource Manager del servicio de búsqueda que contiene información createdBy y modifiedBy. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
upgradeAvailable

Indica si el servicio de búsqueda tiene o no una actualización disponible. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

Propiedades heredadas

id

Identificador de recurso completo para el 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 de recursos.
type

Tipo del 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 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.

authOptions?: DataPlaneAuthOptions

Valor de propiedad

DataPlaneAuthOptions

computeType

Configure esta propiedad para admitir el servicio de búsqueda mediante el proceso predeterminado o Azure Confidential Compute.

computeType?: string

Valor de propiedad

string

disabledDataExfiltrationOptions

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.

disabledDataExfiltrationOptions?: string[]

Valor de propiedad

string[]

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 relacionada con el cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda.

encryptionWithCmk?: EncryptionWithCmk

Valor de propiedad

EncryptionWithCmk

endpoint

Punto de conexión del servicio Azure AI Search.

endpoint?: string

Valor de propiedad

string

eTag

Propiedad generada por el sistema que representa la etiqueta electrónica del servicio que puede ser para el control de simultaneidad optimista durante las actualizaciones. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

eTag?: string

Valor de propiedad

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 estándar3, el valor es "default" o "highDensity". Para todas las demás SKU, este valor debe ser "predeterminado".

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 AI 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 AI 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 mientras se establece la capacidad del 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 Obtener servicio de búsqueda 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 se debe a que el servicio gratuito usa 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 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.

publicNetworkAccess?: string

Valor de propiedad

string

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 opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de Azure AI Search en determinadas ubicaciones.

semanticSearch?: string

Valor de propiedad

string

serviceUpgradeDate

Fecha y hora en que se actualizó por última vez el servicio de búsqueda. Este campo será NULL hasta que el servicio se actualice por primera vez. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

serviceUpgradeDate?: Date

Valor de propiedad

Date

sharedPrivateLinkResources

La lista de recursos de vínculo privado compartido administrados por el servicio Azure AI 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: "en ejecución": 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': el servicio de búsqueda se está eliminando. 'degradado': el servicio de búsqueda está degradado. Esto puede ocurrir cuando las unidades de búsqueda subyacentes no están en buen estado. Es más probable que el servicio de búsqueda esté operativo, pero el rendimiento podría ser lento y algunas solicitudes se podrían quitar. '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 un estado de error. 'detenido': el servicio de búsqueda está en una suscripción que está deshabilitada. Si el servicio está en los estados degradados, deshabilitados o de error, significa que el equipo de Azure AI Search está investigando activamente el problema subyacente. Los servicios dedicados de estos estados siguen siendo cobrables en función del número de unidades de búsqueda aprovisionadas. 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

systemData

Metadatos de Azure Resource Manager del servicio de búsqueda que contiene información createdBy y modifiedBy. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

systemData?: SystemData

Valor de propiedad

SystemData

upgradeAvailable

Indica si el servicio de búsqueda tiene o no una actualización disponible. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

upgradeAvailable?: boolean

Valor de propiedad

boolean

Detalles de las propiedades heredadas

id

Identificador de recurso completo para el 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 de recursos.

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

Valor de propiedad

{[propertyName: string]: string}

Heredado deTrackedResource.tags

type

Tipo del 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

Heredar detrackedResource.type