@azure/arm-search package

Clases

SearchManagementClient

Interfaces

AdminKeyResult	Respuesta que contiene las claves de API de administración principal y secundaria de un servicio Azure Cognitive Search determinado.
AdminKeys	Interfaz que representa un adminKeys.
AdminKeysGetOptionalParams	Parámetros opcionales.
AdminKeysRegenerateOptionalParams	Parámetros opcionales.
AsyncOperationResult	Detalles de una operación de recursos de vínculo privado compartido asincrónica de larga duración
CheckNameAvailabilityInput	Entrada de check name availability API.
CheckNameAvailabilityOutput	Salida de check name availability API.
CloudError	Contiene información sobre un error de API.
CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.
DataPlaneAadOrApiKeyAuthOption	Indica que se puede usar la clave de API o un token de acceso de Azure Active Directory para la autenticación.
DataPlaneAuthOptions	Define las opciones para cómo la API del plano de datos de un servicio Search autentica las solicitudes. No se puede establecer si "disableLocalAuth" está establecido en true.
EncryptionWithCmk	Describe una directiva que determina cómo se cifran los recursos del servicio de búsqueda con claves administradas por el cliente.
Identity	Identidad del recurso.
IpRule	Regla de restricción de IP del servicio Azure Cognitive Search.
ListQueryKeysResult	Respuesta que contiene las claves de API de consulta para un servicio de Azure Cognitive Search determinado.
NetworkRuleSet	Reglas específicas de red que determinan cómo se puede acceder al servicio Azure Cognitive Search.
Operation	Describe una operación de API rest.
OperationDisplay	Objeto que describe la operación.
OperationListResult	Resultado de la solicitud para enumerar las operaciones de la API REST. Contiene una lista de operaciones y una dirección URL para obtener el siguiente conjunto de resultados.
Operations	Interfaz que representa una operación.
OperationsListOptionalParams	Parámetros opcionales.
PrivateEndpointConnection	Describe una conexión de punto de conexión privado existente al servicio Azure Cognitive Search.
PrivateEndpointConnectionListResult	Respuesta que contiene una lista de conexiones de punto de conexión privado.
PrivateEndpointConnectionProperties	Describe las propiedades de una conexión de punto de conexión privado existente al servicio Azure Cognitive Search.
PrivateEndpointConnectionPropertiesPrivateEndpoint	Recurso de punto de conexión privado del proveedor Microsoft.Network.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Describe el estado actual de una conexión de servicio Private Link existente al punto de conexión privado de Azure.
PrivateEndpointConnections	Interfaz que representa a PrivateEndpointConnections.
PrivateEndpointConnectionsDeleteOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsGetOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsListByServiceNextOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsListByServiceOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsUpdateOptionalParams	Parámetros opcionales.
PrivateLinkResource	Describe un recurso de vínculo privado admitido para el servicio Azure Cognitive Search.
PrivateLinkResourceProperties	Describe las propiedades de un recurso de vínculo privado admitido para el servicio Azure Cognitive Search. Para una versión de API determinada, esto representa los identificadores de grupo "admitidos" al crear un recurso de vínculo privado compartido.
PrivateLinkResources	Interfaz que representa un privateLinkResources.
PrivateLinkResourcesListSupportedOptionalParams	Parámetros opcionales.
PrivateLinkResourcesResult	Respuesta que contiene una lista de recursos de Private Link admitidos.
QueryKey	Describe una clave de API para un servicio de Azure Cognitive Search determinado que solo tiene permisos para las operaciones de consulta.
QueryKeys	Interfaz que representa una queryKeys.
QueryKeysCreateOptionalParams	Parámetros opcionales.
QueryKeysDeleteOptionalParams	Parámetros opcionales.
QueryKeysListBySearchServiceNextOptionalParams	Parámetros opcionales.
QueryKeysListBySearchServiceOptionalParams	Parámetros opcionales.
QuotaUsageResult	Describe el uso de cuota para una SKU determinada admitida por Azure Cognitive Search.
QuotaUsageResultName	Nombre de la SKU admitida por Azure Cognitive Search.
QuotaUsagesListResult	Respuesta que contiene la información de uso de cuota para todas las sku admitidas de Azure Cognitive Search servicio.
Resource	Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager
SearchManagementClientOptionalParams	Parámetros opcionales.
SearchManagementRequestOptions	Grupo de parámetros
SearchService	Describe un servicio Azure Cognitive Search y su estado actual.
SearchServiceListResult	Respuesta que contiene una lista de servicios Azure Cognitive Search.
SearchServiceUpdate	Parámetros usados para actualizar un servicio de Azure Cognitive Search.
Services	Interfaz que representa un servicio.
ServicesCheckNameAvailabilityOptionalParams	Parámetros opcionales.
ServicesCreateOrUpdateOptionalParams	Parámetros opcionales.
ServicesDeleteOptionalParams	Parámetros opcionales.
ServicesGetOptionalParams	Parámetros opcionales.
ServicesListByResourceGroupNextOptionalParams	Parámetros opcionales.
ServicesListByResourceGroupOptionalParams	Parámetros opcionales.
ServicesListBySubscriptionNextOptionalParams	Parámetros opcionales.
ServicesListBySubscriptionOptionalParams	Parámetros opcionales.
ServicesUpdateOptionalParams	Parámetros opcionales.
ShareablePrivateLinkResourceProperties	Describe las propiedades de un tipo de recurso que se ha incorporado al servicio private link, compatible con Azure Cognitive Search.
ShareablePrivateLinkResourceType	Describe un tipo de recurso que se ha incorporado al servicio private link, compatible con Azure Cognitive Search.
SharedPrivateLinkResource	Describe un recurso de Private Link compartido administrado por el servicio Azure Cognitive Search.
SharedPrivateLinkResourceListResult	Respuesta que contiene una lista de recursos de Private Link compartidos.
SharedPrivateLinkResourceProperties	Describe las propiedades de un recurso compartido de Private Link existente administrado por el servicio Azure Cognitive Search.
SharedPrivateLinkResources	Interfaz que representa sharedPrivateLinkResources.
SharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Parámetros opcionales.
SharedPrivateLinkResourcesDeleteOptionalParams	Parámetros opcionales.
SharedPrivateLinkResourcesGetOptionalParams	Parámetros opcionales.
SharedPrivateLinkResourcesListByServiceNextOptionalParams	Parámetros opcionales.
SharedPrivateLinkResourcesListByServiceOptionalParams	Parámetros opcionales.
Sku	Define la SKU de un servicio de Azure Cognitive Search, que determina el plan de tarifa y los límites de capacidad.
TrackedResource	La definición del modelo de recursos de una instancia de Azure Resource Manager ha realizado un seguimiento del recurso de nivel superior que tiene "etiquetas" y una "ubicación".
UsageBySubscriptionSkuOptionalParams	Parámetros opcionales.
Usages	Interfaz que representa un objeto Usages.
UsagesListBySubscriptionNextOptionalParams	Parámetros opcionales.
UsagesListBySubscriptionOptionalParams	Parámetros opcionales.

Alias de tipos

AadAuthFailureMode	Define los valores de AadAuthFailureMode.
AdminKeyKind	Define valores para AdminKeyKind.
AdminKeysGetResponse	Contiene datos de respuesta para la operación get.
AdminKeysRegenerateResponse	Contiene datos de respuesta para la operación de regeneración.
HostingMode	Define los valores de HostingMode.
IdentityType	Define los valores de IdentityType.
OperationsListResponse	Contiene datos de respuesta para la operación de lista.
PrivateEndpointConnectionsDeleteResponse	Contiene datos de respuesta para la operación de eliminación.
PrivateEndpointConnectionsGetResponse	Contiene datos de respuesta para la operación get.
PrivateEndpointConnectionsListByServiceNextResponse	Contiene datos de respuesta para la operación listByServiceNext.
PrivateEndpointConnectionsListByServiceResponse	Contiene datos de respuesta para la operación listByService.
PrivateEndpointConnectionsUpdateResponse	Contiene datos de respuesta para la operación de actualización.
PrivateLinkResourcesListSupportedResponse	Contiene datos de respuesta para la operación listSupported.
PrivateLinkServiceConnectionProvisioningState	Define los valores de PrivateLinkServiceConnectionProvisioningState. KnownPrivateLinkServiceConnectionProvisioningState se puede usar indistintamente con PrivateLinkServiceConnectionProvisioningState, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Actualización: la conexión del servicio Private Link está en proceso de creación junto con otros recursos para que sea totalmente funcional. Eliminación: la conexión del servicio Private Link está en proceso de eliminación. Error: no se pudo aprovisionar o eliminar la conexión del servicio Private Link. Correcto: la conexión del servicio Private Link ha terminado de aprovisionar y está lista para su aprobación. Incompleto: se ha aceptado la solicitud de aprovisionamiento para el recurso de conexión del servicio Private Link, pero aún no se ha iniciado el proceso de creación. Cancelado: se ha cancelado la solicitud de aprovisionamiento para el recurso de conexión del servicio Private Link.
PrivateLinkServiceConnectionStatus	Define los valores de PrivateLinkServiceConnectionStatus.
ProvisioningState	Define los valores de ProvisioningState.
PublicNetworkAccess	Define los valores de PublicNetworkAccess.
QueryKeysCreateResponse	Contiene datos de respuesta para la operación de creación.
QueryKeysListBySearchServiceNextResponse	Contiene datos de respuesta para la operación listBySearchServiceNext.
QueryKeysListBySearchServiceResponse	Contiene datos de respuesta para la operación listBySearchService.
SearchEncryptionComplianceStatus	Define los valores de SearchEncryptionComplianceStatus.
SearchEncryptionWithCmk	Define los valores de SearchEncryptionWithCmk.
SearchSemanticSearch	Define los valores de SearchSemanticSearch. KnownSearchSemanticSearch se puede usar indistintamente con SearchSemanticSearch, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio disabled: indica que la búsqueda semántica está deshabilitada para el servicio de búsqueda. free: habilita la búsqueda semántica en un servicio de búsqueda e indica que se va a usar dentro de los límites del nivel gratis. Esto limitaría el volumen de solicitudes de búsqueda semántica y se ofrece sin cargo adicional. Este es el valor predeterminado para los servicios de búsqueda recién aprovisionados. estándar: habilita la búsqueda semántica en un servicio de búsqueda como una característica facturable, con un mayor rendimiento y volumen de consultas de búsqueda semántica.
SearchServiceStatus	Define los valores de SearchServiceStatus.
ServicesCheckNameAvailabilityResponse	Contiene datos de respuesta para la operación checkNameAvailability.
ServicesCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
ServicesGetResponse	Contiene datos de respuesta para la operación get.
ServicesListByResourceGroupNextResponse	Contiene datos de respuesta para la operación listByResourceGroupNext.
ServicesListByResourceGroupResponse	Contiene datos de respuesta para la operación listByResourceGroup.
ServicesListBySubscriptionNextResponse	Contiene datos de respuesta para la operación listBySubscriptionNext.
ServicesListBySubscriptionResponse	Contiene datos de respuesta para la operación listBySubscription.
ServicesUpdateResponse	Contiene datos de respuesta para la operación de actualización.
SharedPrivateLinkResourceAsyncOperationResult	Define valores para SharedPrivateLinkResourceAsyncOperationResult. KnownSharedPrivateLinkResourceAsyncOperationResult se puede usar indistintamente con SharedPrivateLinkResourceAsyncOperationResult; esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Ejecución Correcto Erróneo
SharedPrivateLinkResourceProvisioningState	Define valores para SharedPrivateLinkResourceProvisioningState.
SharedPrivateLinkResourceStatus	Define valores para SharedPrivateLinkResourceStatus.
SharedPrivateLinkResourcesCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
SharedPrivateLinkResourcesGetResponse	Contiene datos de respuesta para la operación get.
SharedPrivateLinkResourcesListByServiceNextResponse	Contiene datos de respuesta para la operación listByServiceNext.
SharedPrivateLinkResourcesListByServiceResponse	Contiene datos de respuesta para la operación listByService.
SkuName	Define valores para SkuName.
UnavailableNameReason	Define valores para UnavailableNameReason. KnownUnavailableNameReason se puede usar indistintamente con UnavailableNameReason, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio No válido: el nombre del servicio de búsqueda no coincide con los requisitos de nomenclatura. AlreadyExists: el nombre del servicio de búsqueda ya está asignado a otro servicio de búsqueda.
UsageBySubscriptionSkuResponse	Contiene datos de respuesta para la operación usageBySubscriptionSku.
UsagesListBySubscriptionNextResponse	Contiene datos de respuesta para la operación listBySubscriptionNext.
UsagesListBySubscriptionResponse	Contiene datos de respuesta para la operación listBySubscription.

Enumeraciones

KnownPrivateLinkServiceConnectionProvisioningState	Valores conocidos de PrivateLinkServiceConnectionProvisioningState que acepta el servicio.
KnownSearchSemanticSearch	Valores conocidos de SearchSemanticSearch que acepta el servicio.
KnownSharedPrivateLinkResourceAsyncOperationResult	Valores conocidos de SharedPrivateLinkResourceAsyncOperationResult que acepta el servicio.
KnownUnavailableNameReason	Valores conocidos de UnavailableNameReason que acepta el servicio.

Funciones

getContinuationToken(unknown)

Dado el último .value generado por el byPage iterador, devuelve un token de continuación que se puede usar para comenzar la paginación desde ese punto más adelante.

Detalles de la función

getContinuationToken(unknown)

Dado el último .value generado por el byPage iterador, devuelve un token de continuación que se puede usar para comenzar la paginación desde ese punto más adelante.

function getContinuationToken(page: unknown): string | undefined

Parámetros

page

unknown

Objeto desde el que se accede value a IteratorResult desde un byPage iterador.

Devoluciones

string | undefined

Token de continuación que se puede pasar a byPage() durante futuras llamadas.