Partager via

QueryKeysOperations Classe

  • Référence

Avertissement

NE PAS instancier cette classe directement.

Au lieu de cela, vous devez accéder aux opérations suivantes via

SearchManagementClientEst

attribut<xref:query_keys> ;

Héritage
builtins.object
QueryKeysOperations

Constructeur

QueryKeysOperations(*args, **kwargs)

Méthodes

create

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

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

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

create

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.

async create(resource_group_name: str, search_service_name: str, name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> QueryKey

Paramètres

resource_group_name
str
Obligatoire

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

search_service_name
str
Obligatoire

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

name
str
Obligatoire

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

search_management_request_options
SearchManagementRequestOptions
Obligatoire

Groupe de paramètres. La valeur par défaut est Aucun.

cls
callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

QueryKey ou le résultat de cls(response)

Type de retour

QueryKey

Exceptions

HttpResponseError
Voir aussi

delete

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.

async delete(resource_group_name: str, search_service_name: str, key: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> None

Paramètres

resource_group_name
str
Obligatoire

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

search_service_name
str
Obligatoire

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

key
str
Obligatoire

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

search_management_request_options
SearchManagementRequestOptions
Obligatoire

Groupe de paramètres. La valeur par défaut est Aucun.

cls
callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Aucun ou le résultat de cls(response)

Type de retour

None

Exceptions

HttpResponseError
Voir aussi

list_by_search_service

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

list_by_search_service(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> AsyncIterable[QueryKey]

Paramètres

resource_group_name
str
Obligatoire

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

search_service_name
str
Obligatoire

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

search_management_request_options
SearchManagementRequestOptions
Obligatoire

Groupe de paramètres. La valeur par défaut est Aucun.

cls
callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Itérateur comme l’instance de QueryKey ou le résultat de cls(response)

Type de retour

AsyncItemPaged[QueryKey]

Exceptions

HttpResponseError
Voir aussi

Attributs

models 

models = <module 'azure.mgmt.search.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\search\\models\\__init__.py'>