Admin Keys - Get
指定した Azure AI Search サービスのプライマリおよびセカンダリ管理者 API キーを取得します。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2025-02-01-previewURI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
resource
|
path | True |
string |
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。 |
|
search
|
path | True |
string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ |
指定したリソース グループに関連付けられている Azure AI Search サービスの名前。 |
|
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure Resource Manager API またはポータルから取得できます。 |
|
api-version
|
query | True |
string |
各要求に使用する API バージョン。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
この要求を識別するクライアントによって生成される GUID 値。 指定した場合、これは要求を追跡する方法として応答情報に含まれます。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
管理者キーが正常に取得され、応答中です。 Azure AI Search サービス REST API または SDK の "api-key" パラメーターの値としてプライマリ キーまたはセカンダリ キーを使用して、特権操作を含む検索サービスに対する操作を実行できます。 特権操作には、インデックスやデータ ソースなどのリソースの管理や、インデックス内のデータのアップロード、変更、または削除が含まれます。 |
|
| Other Status Codes |
HTTP 404 (見つかりません): サブスクリプション、リソース グループ、または検索サービスが見つかりませんでした。 HTTP 409 (競合): 指定されたサブスクリプションが無効になっています。 |
セキュリティ
azure_auth
Microsoft ID プラットフォームでサポートされている暗黙的な許可フローを指定します。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
SearchGetAdminKeys
要求のサンプル
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2025-02-01-preview
応答のサンプル
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}定義
| 名前 | 説明 |
|---|---|
|
Admin |
特定の Azure AI Search サービスのプライマリおよびセカンダリ管理者 API キーを含む応答。 |
|
Cloud |
API エラーに関する情報が含まれています。 |
|
Cloud |
エラー コードとメッセージを含む特定の API エラーについて説明します。 |
AdminKeyResult
特定の Azure AI Search サービスのプライマリおよびセカンダリ管理者 API キーを含む応答。
| 名前 | 型 | 説明 |
|---|---|---|
| primaryKey |
string |
検索サービスのプライマリ管理者 API キー。 |
| secondaryKey |
string |
検索サービスのセカンダリ管理者 API キー。 |
CloudError
API エラーに関する情報が含まれています。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー コードとメッセージを含む特定の API エラーについて説明します。 |
|
| message |
string |
問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。 |
CloudErrorBody
エラー コードとメッセージを含む特定の API エラーについて説明します。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
HTTP 状態コードよりも正確にエラー状態を記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。 |
| details |
このエラーに関連する入れ子になったエラーが含まれています。 |
|
| message |
string |
エラーの詳細を説明し、デバッグ情報を提供するメッセージ。 |
| target |
string |
特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。 |