Admin Keys - Regenerate

プライマリまたはセカンダリの管理者 API キーを再生成します。 一度に再生成できるのは 1 つのキーのみです。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}?api-version=2024-03-01-preview

URI パラメーター

名前 / 必須 説明
keyKind
path True

AdminKeyKind

再生成するキーを指定します。 有効な値には、'primary' と 'secondary' が含まれます。

resourceGroupName
path True

string

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

searchServiceName
path True

string

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

正規表現パターン: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

subscriptionId
path True

string

Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

api-version
query True

string

要求ごとに使用する API バージョン。

要求ヘッダー

名前 必須 説明
x-ms-client-request-id

string

uuid

クライアントが生成した、この要求を識別する GUID 値。 指定した場合、これは要求を追跡する方法として応答情報に含まれます。

応答

名前 説明
200 OK

AdminKeyResult

指定した管理キーが正常に再生成されました。 新しく再生成されたキーを含め、両方の管理キーが応答に含まれます。

Other Status Codes

CloudError

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

セキュリティ

azure_auth

Microsoft ID プラットフォームでサポートされている暗黙的な許可フローを指定します。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

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

SearchRegenerateAdminKey

要求のサンプル

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/regenerateAdminKey/primary?api-version=2024-03-01-preview

応答のサンプル

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

定義

名前 説明
AdminKeyKind

再生成するキーを指定します。 有効な値には、'primary' と 'secondary' が含まれます。

AdminKeyResult

特定の Azure AI Search Serviceのプライマリとセカンダリの管理者 API キーを含む応答。

CloudError

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

CloudErrorBody

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

AdminKeyKind

再生成するキーを指定します。 有効な値には、'primary' と 'secondary' が含まれます。

名前 説明
primary

string

検索サービスの主 API キー。

secondary

string

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

AdminKeyResult

特定の Azure AI Search Serviceのプライマリとセカンダリの管理者 API キーを含む応答。

名前 説明
primaryKey

string

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

secondaryKey

string

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

CloudError

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

名前 説明
error

CloudErrorBody

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

message

string

問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。

CloudErrorBody

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

名前 説明
code

string

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

details

CloudErrorBody[]

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

message

string

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

target

string

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