QueryKeysOperations クラス

警告

このクラスを直接インスタンス化しないでください。

代わりに、次の操作にアクセスする必要があります。

SearchManagementClient's

<xref:query_keys> 属性を使用する。

継承
builtins.object
QueryKeysOperations

コンストラクター

QueryKeysOperations(*args, **kwargs)

メソッド

create

指定した検索サービスの新しいクエリ キーを生成します。 サービスごとに最大で 50 個のクエリ キーを作成できます。

delete

指定したクエリ キーを削除します。 管理者キーとは異なり、クエリ キーは再生成されません。 クエリ キーを再生成するには、キーを削除して再作成します。

list_by_search_service

指定された Azure Cognitive Search サービスのクエリ API キーの一覧を返します。

create

指定した検索サービスの新しいクエリ キーを生成します。 サービスごとに最大で 50 個のクエリ キーを作成できます。

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

パラメーター

resource_group_name
str
必須

現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。 必須です。

search_service_name
str
必須

指定したリソース グループに関連付けられているAzure Cognitive Search サービスの名前。 必須です。

name
str
必須

新しいクエリ API キーの名前。 必須です。

search_management_request_options
SearchManagementRequestOptions
必須

パラメーター グループ。 既定値は [なし] です。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

QueryKey または cls(response) の結果

の戻り値の型 :

例外

こちらもご覧ください

delete

指定したクエリ キーを削除します。 管理者キーとは異なり、クエリ キーは再生成されません。 クエリ キーを再生成するには、キーを削除して再作成します。

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

パラメーター

resource_group_name
str
必須

現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。 必須です。

search_service_name
str
必須

指定したリソース グループに関連付けられているAzure Cognitive Search サービスの名前。 必須です。

key
str
必須

削除するクエリ キー。 クエリ キーは、名前ではなく値によって識別されます。 必須です。

search_management_request_options
SearchManagementRequestOptions
必須

パラメーター グループ。 既定値は [なし] です。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

なし、または cls(response) の結果

の戻り値の型 :

例外

こちらもご覧ください

list_by_search_service

指定された Azure Cognitive Search サービスのクエリ API キーの一覧を返します。

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

パラメーター

resource_group_name
str
必須

現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。 必須です。

search_service_name
str
必須

指定したリソース グループに関連付けられているAzure Cognitive Search サービスの名前。 必須です。

search_management_request_options
SearchManagementRequestOptions
必須

パラメーター グループ。 既定値は [なし] です。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

QueryKey または cls(response) の結果のインスタンスのような反復子

の戻り値の型 :

例外

こちらもご覧ください

属性

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'>