Admin Keys - Get

指定した検索サービスのプライマリとセカンダリの管理 API キーを取得します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2023-11-01

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

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

searchServiceName
path True

string

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

subscriptionId
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

AdminKeyResult

管理キーが正常に取得され、応答中です。 データ プレーン REST API の 'api-key' パラメーターの値としてプライマリ キーまたはセカンダリ キーを使用するか、Azure SDK を使用して、特権操作を含む検索サービスに対する操作を実行できます。 特権操作には、インデックスやデータ ソースなどのリソースの管理のほか、インデックス内のデータのアップロード、変更、削除が含まれます。

Other Status Codes

CloudError

HTTP 404 (見つかりません): サブスクリプション、リソース グループ、または検索サービスが見つかりませんでした。 HTTP 409 (競合): 指定されたサブスクリプションが無効になっています。

セキュリティ

azure_auth

OAuth2 承認フローをMicrosoft Entra IDします。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

SearchGetAdminKeys

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2023-11-01

Sample Response

{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

定義

名前 説明
AdminKeyResult

特定の検索サービスのプライマリとセカンダリの管理 API キーを含む応答。

CloudError

API エラーに関する情報が含まれています。

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

AdminKeyResult

特定の検索サービスのプライマリとセカンダリの管理 API キーを含む応答。

名前 説明
primaryKey

string

検索サービスのプライマリ管理者 API キー。

secondaryKey

string

検索サービスのセカンダリ管理者 API キー。

CloudError

API エラーに関する情報が含まれています。

名前 説明
error

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

名前 説明
code

string

エラー状態を HTTP 状態コードよりも正確に記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。

details

CloudErrorBody[]

このエラーに関連する入れ子になったエラーが含まれています。

message

string

エラーの詳細を説明し、デバッグ情報を提供するメッセージ。

target

string

特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。