AdminKeys interface
AdminKeys を表すインターフェイス。
メソッド
| get(string, string, Admin |
指定したAzure Cognitive Search サービスのプライマリおよびセカンダリ管理者 API キーを取得します。 |
| regenerate(string, string, Admin |
プライマリまたはセカンダリの管理者 API キーを再生成します。 一度に再生成できるのは 1 つのキーのみです。 |
メソッドの詳細
get(string, string, AdminKeysGetOptionalParams)
指定したAzure Cognitive Search サービスのプライマリおよびセカンダリ管理者 API キーを取得します。
function get(resourceGroupName: string, searchServiceName: string, options?: AdminKeysGetOptionalParams): Promise<AdminKeyResult>パラメーター
- resourceGroupName
-
string
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
- searchServiceName
-
string
指定したリソース グループに関連付けられているAzure Cognitive Search サービスの名前。
- options
- AdminKeysGetOptionalParams
options パラメーター。
戻り値
Promise<AdminKeyResult>
regenerate(string, string, AdminKeyKind, AdminKeysRegenerateOptionalParams)
プライマリまたはセカンダリの管理者 API キーを再生成します。 一度に再生成できるのは 1 つのキーのみです。
function regenerate(resourceGroupName: string, searchServiceName: string, keyKind: AdminKeyKind, options?: AdminKeysRegenerateOptionalParams): Promise<AdminKeyResult>パラメーター
- resourceGroupName
-
string
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
- searchServiceName
-
string
指定したリソース グループに関連付けられているAzure Cognitive Search サービスの名前。
- keyKind
- AdminKeyKind
再生成するキーを指定します。 有効な値には、'primary' と 'secondary' が含まれます。
options パラメーター。
戻り値
Promise<AdminKeyResult>