@azure/arm-search package
Clases
| SearchManagementClient |
Interfaces
| AccessRule |
Regla de acceso en un perfil de configuración perimetral de seguridad de red |
| AccessRuleProperties |
Propiedades de la regla de acceso |
| AccessRulePropertiesSubscriptionsItem |
Identificadores de suscripción |
| AdminKeyResult |
Respuesta que contiene las claves de API de administración principal y secundaria para un servicio de Azure AI Search determinado. |
| AdminKeys |
Interfaz que representa una adminKeys. |
| AdminKeysGetOptionalParams |
Parámetros opcionales. |
| AdminKeysRegenerateOptionalParams |
Parámetros opcionales. |
| AsyncOperationResult |
Los detalles de una operación de recurso de vínculo privado compartido asincrónico 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 un inquilino de Id. de Microsoft Entra para la autenticación. |
| DataPlaneAuthOptions |
Define las opciones de cómo el servicio de búsqueda autentica una solicitud de plano de datos. 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 |
Detalles sobre la identidad del servicio de búsqueda. Un valor NULL indica que el servicio de búsqueda no tiene asignada ninguna identidad. |
| IpRule |
Regla de restricción de IP del servicio Azure AI Search. |
| ListQueryKeysResult |
Respuesta que contiene las claves de API de consulta para un servicio de Azure AI Search determinado. |
| NetworkRuleSet |
Reglas específicas de red que determinan cómo se puede acceder al servicio Azure AI Search. |
| NetworkSecurityPerimeter |
Información sobre un perímetro de seguridad de red (NSP) |
| NetworkSecurityPerimeterConfiguration |
Recurso de configuración del perímetro de seguridad de red (NSP) |
| NetworkSecurityPerimeterConfigurationListResult |
Resultado de una solicitud de configuración de NSP (perímetro de seguridad de red) de lista. |
| NetworkSecurityPerimeterConfigurationProperties |
Propiedades de configuración de seguridad de red. |
| NetworkSecurityPerimeterConfigurations |
Interfaz que representa una NetworkSecurityPerimeterConfigurations. |
| NetworkSecurityPerimeterConfigurationsGetOptionalParams |
Parámetros opcionales. |
| NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams |
Parámetros opcionales. |
| NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams |
Parámetros opcionales. |
| NetworkSecurityPerimeterConfigurationsReconcileHeaders |
Define encabezados para NetworkSecurityPerimeterConfigurations_reconcile operación. |
| NetworkSecurityPerimeterConfigurationsReconcileOptionalParams |
Parámetros opcionales. |
| NetworkSecurityProfile |
Perfil de configuración perimetral de seguridad de red |
| Operation |
Detalles de una operación de API REST, devuelta desde la API de operaciones del proveedor de recursos |
| OperationDisplay |
Información de visualización localizada para esta operación determinada. |
| 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 AI 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 de búsqueda. |
| PrivateEndpointConnectionPropertiesPrivateEndpoint |
Recurso de punto de conexión privado del proveedor Microsoft.Network. |
| PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState |
Describe el estado actual de una conexión de servicio de Azure Private Link existente al punto de conexión privado. |
| PrivateEndpointConnections |
Interfaz que representa un 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 compatible para el servicio Azure AI Search. |
| PrivateLinkResourceProperties |
Describe las propiedades de un recurso de vínculo privado compatible para el servicio Azure AI 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. |
| ProvisioningIssue |
Describe un problema de aprovisionamiento para una configuración perimetral de seguridad de red. |
| ProvisioningIssueProperties |
Detalles de un problema de aprovisionamiento para una configuración del perímetro de seguridad de red (NSP). Los proveedores de recursos deben generar elementos de problema de aprovisionamiento independientes para cada problema independiente detectado e incluir una descripción significativa y distintiva, así como cualquier elemento sugerido y sugeridoResourceIds y suggestedAccessRules. |
| ProxyResource |
Definición del modelo de recursos para un recurso proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación |
| QueryKey |
Describe una clave de API para un servicio de Azure AI Search determinado que transmite permisos de solo lectura en la colección de documentos de un índice. |
| 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. |
| QuotaUsageResultName |
Nombre de la SKU compatible con Azure AI Search. |
| QuotaUsagesListResult |
Respuesta que contiene la información de uso de cuota para todas las SKU admitidas de Azure AI Search. |
| Resource |
Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager |
| ResourceAssociation |
Información sobre la asociación de recursos |
| SearchManagementClientOptionalParams |
Parámetros opcionales. |
| SearchManagementRequestOptions |
Grupo de parámetros |
| SearchService |
Describe un servicio azure AI Search y su estado actual. |
| SearchServiceListResult |
Respuesta que contiene una lista de servicios de Azure AI Search. |
| SearchServiceUpdate |
Parámetros que se usan para actualizar un servicio azure AI 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. |
| ServicesUpgradeHeaders |
Define encabezados para Services_upgrade operación. |
| ServicesUpgradeOptionalParams |
Parámetros opcionales. |
| ShareablePrivateLinkResourceProperties |
Describe las propiedades de un tipo de recurso que se ha incorporado al servicio private link, compatible con Azure AI Search. |
| ShareablePrivateLinkResourceType |
Describe un tipo de recurso que se ha incorporado al servicio private link, compatible con Azure AI Search. |
| SharedPrivateLinkResource |
Describe un recurso de vínculo privado compartido administrado por el servicio Azure AI Search. |
| SharedPrivateLinkResourceListResult |
Respuesta que contiene una lista de recursos de vínculo privado compartidos. |
| SharedPrivateLinkResourceProperties |
Describe las propiedades de un recurso de vínculo privado compartido existente administrado por el servicio Azure AI Search. |
| SharedPrivateLinkResources |
Interfaz que representa un 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 búsqueda, que determina la tasa de facturación y los límites de capacidad. |
| SystemData |
Metadatos relativos a la creación y última modificación del recurso. |
| TrackedResource |
La definición del modelo de recursos para un recurso de nivel superior con seguimiento de Azure Resource Manager que tiene "etiquetas" y una "ubicación". |
| UsageBySubscriptionSkuOptionalParams |
Parámetros opcionales. |
| Usages |
Interfaz que representa un uso. |
| UsagesListBySubscriptionNextOptionalParams |
Parámetros opcionales. |
| UsagesListBySubscriptionOptionalParams |
Parámetros opcionales. |
| UserAssignedIdentity |
Propiedades de identidad asignadas por el usuario |
Alias de tipos
| AadAuthFailureMode |
Define valores para AadAuthFailureMode. |
| AccessRuleDirection |
Define los valores de AccessRuleDirection. Valores conocidos admitidos por el servicio
entrada: se aplica al tráfico de red entrante a los recursos protegidos. |
| ActionType |
Define valores para ActionType. Valores conocidos admitidos por el servicioInternal |
| 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. |
| ComputeType |
Define valores para ComputeType. Valores conocidos admitidos por el servicio
default: cree el servicio con el proceso predeterminado. |
| CreatedByType |
Define valores para CreatedByType. Valores conocidos admitidos por el servicio
User |
| HostingMode |
Define valores para HostingMode. |
| IdentityType |
Define valores para IdentityType. Valores conocidos admitidos por el servicio
Ninguno: indica que se debe quitar cualquier identidad asociada al servicio de búsqueda. |
| IssueType |
Define valores para IssueType. Valores conocidos admitidos por el servicio
desconocido: tipo de problema desconocido |
| NetworkSecurityPerimeterConfigurationProvisioningState |
Define valores para NetworkSecurityPerimeterConfigurationProvisioningState. Valores conocidos admitidos por el servicio
Succeeded |
| NetworkSecurityPerimeterConfigurationsGetResponse |
Contiene datos de respuesta para la operación get. |
| NetworkSecurityPerimeterConfigurationsListByServiceNextResponse |
Contiene datos de respuesta para la operación listByServiceNext. |
| NetworkSecurityPerimeterConfigurationsListByServiceResponse |
Contiene datos de respuesta para la operación listByService. |
| NetworkSecurityPerimeterConfigurationsReconcileResponse |
Contiene datos de respuesta para la operación de conciliación. |
| OperationsListResponse |
Contiene datos de respuesta para la operación de lista. |
| Origin |
Define valores para Origin. Valores conocidos admitidos por el servicio
user |
| 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 valores para PrivateLinkServiceConnectionProvisioningState. Valores conocidos admitidos por el servicio
Actualizar: la conexión del servicio private link está en proceso de creación junto con otros recursos para que sea totalmente funcional. |
| PrivateLinkServiceConnectionStatus |
Define valores para PrivateLinkServiceConnectionStatus. |
| ProvisioningState |
Define valores para ProvisioningState. |
| PublicNetworkAccess |
Define valores para PublicNetworkAccess. Valores conocidos admitidos por el servicio
enabled: se puede acceder al servicio de búsqueda desde el tráfico que se origina en la red pública de Internet. |
| 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. |
| ResourceAssociationAccessMode |
Define valores para ResourceAssociationAccessMode. Valores conocidos admitidos por el servicio
Se aplica: modo de acceso aplicado: el tráfico al recurso que ha producido un error en las comprobaciones de acceso está bloqueado. |
| SearchBypass |
Define los valores de SearchBypass. Valores conocidos admitidos por el servicio
Ninguno: Indica que ningún origen puede omitir las reglas definidas en la sección 'ipRules'. Este es el valor predeterminado. |
| SearchDataExfiltrationProtection |
Define valores para SearchDataExfiltrationProtection. Valores conocidos admitidos por el servicioBlockAll: indica que todos los escenarios de filtración de datos están deshabilitados. |
| SearchEncryptionComplianceStatus |
Define valores para SearchEncryptionComplianceStatus. |
| SearchEncryptionWithCmk |
Define valores para SearchEncryptionWithCmk. |
| SearchSemanticSearch |
Define los valores de SearchSemanticSearch. Valores conocidos admitidos por el servicio
disabled: indica que el reranker semántico está deshabilitado para el servicio de búsqueda. Este es el valor predeterminado. |
| SearchServiceStatus |
Define valores para 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. |
| ServicesUpgradeResponse |
Contiene datos de respuesta para la operación de actualización. |
| Severity |
Define los valores de Gravedad. Valores conocidos admitidos por el servicio
Warning |
| SharedPrivateLinkResourceAsyncOperationResult |
Define valores para SharedPrivateLinkResourceAsyncOperationResult. Valores conocidos admitidos por el servicio
Running |
| SharedPrivateLinkResourceProvisioningState |
Define valores para SharedPrivateLinkResourceProvisioningState. Valores conocidos admitidos por el servicio
Actualización: El recurso de enlace privado compartido está en proceso de creación junto con otros recursos para que sea completamente funcional. |
| SharedPrivateLinkResourceStatus |
Define valores para SharedPrivateLinkResourceStatus. Valores conocidos admitidos por el servicio
Pendiente: se ha creado el recurso de vínculo privado compartido y está pendiente de aprobación. |
| 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. Valores conocidos admitidos por el servicio
free: nivel gratuito, sin garantías de SLA y un subconjunto de las características que se ofrecen en los niveles facturables. |
| UnavailableNameReason |
Define los valores de UnavailableNameReason. Valores conocidos admitidos por el servicio
No válido: el nombre del servicio de búsqueda no coincide con los requisitos de nomenclatura. |
| UpgradeAvailable |
Define los valores de UpgradeAvailable. Valores conocidos admitidos por el servicio
notAvailable: actualmente no hay una actualización disponible para el servicio. |
| 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
Funciones
| get |
Dada la última |
Detalles de la función
getContinuationToken(unknown)
Dada la última .value generada por el iterador de byPage, 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 a value en IteratorResult desde un iterador de byPage.
Devoluciones
string | undefined
Token de continuación que se puede pasar a byPage() durante futuras llamadas.