Admin Keys - Regenerate

服務:: Search Management

API 版本:: 2025-02-01-preview

重新產生主要或次要系統管理員 API 金鑰。您一次只能重新產生一個金鑰。

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

URI 參數

名稱	位於	必要	類型	Description
keyKind	path	True	AdminKeyKind	指定要重新產生哪一個金鑰。有效值包括『primary』和『secondary』。
resourceGroupName	path	True	string	目前訂用帳戶內的資源組名。您可以從 Azure Resource Manager API 或入口網站取得此值。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	與指定資源群組相關聯的 Azure AI 搜尋服務名稱。
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶的唯一標識符。您可以從 Azure Resource Manager API 或入口網站取得此值。
api-version	query	True	string	每個要求所使用的 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string (uuid)	用戶端產生的 GUID 值，可識別此要求。如果指定，則會以追蹤要求的方式包含在響應資訊中。

回應

名稱	類型	Description
200 OK	AdminKeyResult	已成功重新產生指定的系統管理金鑰。這兩個系統管理金鑰都包含在回應中，包括新重新產生的密鑰。
Other Status Codes	CloudError	HTTP 404 （找不到）：找不到訂用帳戶、資源群組或搜尋服務。 HTTP 409 （衝突）：指定的訂用帳戶已停用。

安全性

azure_auth

指定Microsoft身分識別平台上支援的隱含授與流程。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

SearchRegenerateAdminKey

範例要求

HTTP

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

範例回覆

狀態碼:: 200

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

定義

名稱	Description
AdminKeyKind	指定要重新產生哪一個金鑰。有效值包括『primary』和『secondary』。
AdminKeyResult	包含指定 Azure AI 搜尋服務之主要和次要系統管理員 API 金鑰的回應。
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。

AdminKeyKind

列舉型別

指定要重新產生哪一個金鑰。有效值包括『primary』和『secondary』。

值	Description
primary	搜尋服務的主要 API 金鑰。
secondary	搜尋服務的次要 API 金鑰。

AdminKeyResult

Object

包含指定 Azure AI 搜尋服務之主要和次要系統管理員 API 金鑰的回應。

名稱	類型	Description
primaryKey	string	搜尋服務的主要管理員 API 金鑰。
secondaryKey	string	搜尋服務的次要系統管理 API 金鑰。

CloudError

Object

包含 API 錯誤的相關信息。

名稱	類型	Description
error	CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
message	string	錯誤簡短描述，其中提示發生錯誤的原因（如需詳細數據/偵錯資訊，請參閱 'error.message' 屬性。

CloudErrorBody

Object

描述具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	比 HTTP 狀態代碼更精確地描述錯誤條件的錯誤碼。可用來以程式設計方式處理特定錯誤案例。
details	CloudErrorBody[]	包含與此錯誤相關的巢狀錯誤。
message	string	描述錯誤的詳細訊息，並提供偵錯資訊。
target	string	特定錯誤的目標（例如，錯誤中的屬性名稱）。