次の方法で共有


QueryKeys interface

QueryKeys を表すインターフェイス。

メソッド

create(string, string, string, QueryKeysCreateOptionalParams)

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

delete(string, string, string, QueryKeysDeleteOptionalParams)

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

listBySearchService(string, string, QueryKeysListBySearchServiceOptionalParams)

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

メソッドの詳細

create(string, string, string, QueryKeysCreateOptionalParams)

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

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

パラメーター

resourceGroupName

string

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

searchServiceName

string

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

name

string

新しいクエリ API キーの名前。

options
QueryKeysCreateOptionalParams

options パラメーター。

戻り値

Promise<QueryKey>

delete(string, string, string, QueryKeysDeleteOptionalParams)

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

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

パラメーター

resourceGroupName

string

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

searchServiceName

string

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

key

string

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

options
QueryKeysDeleteOptionalParams

options パラメーター。

戻り値

Promise<void>

listBySearchService(string, string, QueryKeysListBySearchServiceOptionalParams)

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

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

パラメーター

resourceGroupName

string

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

searchServiceName

string

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

options
QueryKeysListBySearchServiceOptionalParams

options パラメーター。

戻り値