QueryKeys interface

Paquete:

@azure/arm-search

Interfaz que representa una queryKeys.

Métodos

create(string, string, string, QueryKeysCreateOptionalParams)	Genera una nueva clave de consulta para el servicio de búsqueda especificado. Puede crear hasta 50 claves de consulta por servicio.
delete(string, string, string, QueryKeysDeleteOptionalParams)	Elimina la clave de consulta especificada. A diferencia de las claves de administración, las claves de consulta no se vuelven a generar. El proceso para volver a generar una clave de consulta es eliminarla y volver a crearla.
listBySearchService(string, string, QueryKeysListBySearchServiceOptionalParams)	Devuelve la lista de claves de API de consulta para el servicio Azure AI Search especificado.

Detalles del método

create(string, string, string, QueryKeysCreateOptionalParams)

Genera una nueva clave de consulta para el servicio de búsqueda especificado. Puede crear hasta 50 claves de consulta por servicio.

function create(resourceGroupName: string, searchServiceName: string, name: string, options?: QueryKeysCreateOptionalParams): Promise<QueryKey>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos dentro de la suscripción actual. Puede obtener este valor desde la API de Azure Resource Manager o el portal.

searchServiceName

string

Nombre del servicio Azure AI Search asociado al grupo de recursos especificado.

name

string

Nombre de la nueva clave de API de consulta.

options

QueryKeysCreateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<QueryKey>

delete(string, string, string, QueryKeysDeleteOptionalParams)

Elimina la clave de consulta especificada. A diferencia de las claves de administración, las claves de consulta no se vuelven a generar. El proceso para volver a generar una clave de consulta es eliminarla y volver a crearla.

function delete(resourceGroupName: string, searchServiceName: string, key: string, options?: QueryKeysDeleteOptionalParams): Promise<void>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos dentro de la suscripción actual. Puede obtener este valor desde la API de Azure Resource Manager o el portal.

searchServiceName

string

Nombre del servicio Azure AI Search asociado al grupo de recursos especificado.

key

string

Clave de consulta que se va a eliminar. Las claves de consulta se identifican por valor, no por nombre.

options

QueryKeysDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

listBySearchService(string, string, QueryKeysListBySearchServiceOptionalParams)

Devuelve la lista de claves de API de consulta para el servicio Azure AI Search especificado.

function listBySearchService(resourceGroupName: string, searchServiceName: string, options?: QueryKeysListBySearchServiceOptionalParams): PagedAsyncIterableIterator<QueryKey, QueryKey[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos dentro de la suscripción actual. Puede obtener este valor desde la API de Azure Resource Manager o el portal.

searchServiceName

string

Nombre del servicio Azure AI Search asociado al grupo de recursos especificado.

options

QueryKeysListBySearchServiceOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<QueryKey, QueryKey[], PageSettings>