Partager via


QueryKeys interface

Interface représentant un QueryKeys.

Méthodes

create(string, string, string, QueryKeysCreateOptionalParams)

Génère une nouvelle clé de requête pour le service de recherche spécifié. Vous pouvez créer jusqu’à 50 clés de requête par service.

delete(string, string, string, QueryKeysDeleteOptionalParams)

Supprime la clé de requête spécifiée. Contrairement aux clés d’administration, les clés de requête ne sont pas régénérées. Le processus de régénération d’une clé de requête consiste à supprimer la clé, puis à la recréer.

listBySearchService(string, string, QueryKeysListBySearchServiceOptionalParams)

Retourne la liste des clés d’API de requête pour le service Recherche cognitive Azure donné.

Détails de la méthode

create(string, string, string, QueryKeysCreateOptionalParams)

Génère une nouvelle clé de requête pour le service de recherche spécifié. Vous pouvez créer jusqu’à 50 clés de requête par service.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources au sein de l’abonnement actuel. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.

searchServiceName

string

Nom du service Recherche cognitive Azure associé au groupe de ressources spécifié.

name

string

Nom de la nouvelle clé API de requête.

options
QueryKeysCreateOptionalParams

Paramètres d’options.

Retours

Promise<QueryKey>

delete(string, string, string, QueryKeysDeleteOptionalParams)

Supprime la clé de requête spécifiée. Contrairement aux clés d’administration, les clés de requête ne sont pas régénérées. Le processus de régénération d’une clé de requête consiste à supprimer la clé, puis à la recréer.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources au sein de l’abonnement actuel. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.

searchServiceName

string

Nom du service Recherche cognitive Azure associé au groupe de ressources spécifié.

key

string

Clé de requête à supprimer. Les clés de requête sont identifiées par valeur, et non par nom.

options
QueryKeysDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

listBySearchService(string, string, QueryKeysListBySearchServiceOptionalParams)

Retourne la liste des clés d’API de requête pour le service Recherche cognitive Azure donné.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources au sein de l’abonnement actuel. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.

searchServiceName

string

Nom du service Recherche cognitive Azure associé au groupe de ressources spécifié.

options
QueryKeysListBySearchServiceOptionalParams

Paramètres d’options.

Retours