共用方式為


Admin Keys - Regenerate

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

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

URI 參數

名稱 位於 必要 類型 Description
keyKind
path True

AdminKeyKind

指定要產生哪種金鑰。 有效值包括 『primary』 和 『secondary』。

resourceGroupName
path True

string

目前訂用帳戶內的資源組名。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。

searchServiceName
path True

string

與指定資源群組相關聯的 Azure AI 搜尋服務 名稱。

Regex 模式: ^(?=.{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 版本。

要求標頭

名稱 必要 類型 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

範例要求

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>"
}

定義

名稱 Description
AdminKeyKind

指定要產生哪種金鑰。 有效值包括 『primary』 和 『secondary』。

AdminKeyResult

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

CloudError

包含 API 錯誤的相關信息。

CloudErrorBody

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

AdminKeyKind

指定要產生哪種金鑰。 有效值包括 『primary』 和 『secondary』。

名稱 類型 Description
primary

string

搜尋服務的主要 API 金鑰。

secondary

string

搜尋服務的次要 API 金鑰。

AdminKeyResult

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

名稱 類型 Description
primaryKey

string

搜尋服務的主要系統管理員 API 金鑰。

secondaryKey

string

搜尋服務的次要系統管理員 API 金鑰。

CloudError

包含 API 錯誤的相關信息。

名稱 類型 Description
error

CloudErrorBody

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

message

string

關於錯誤 (的簡短說明,以取得詳細數據/偵錯資訊,請參閱 'error.message' 屬性) 。

CloudErrorBody

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

名稱 類型 Description
code

string

描述錯誤狀況的錯誤碼,比 HTTP 狀態代碼更精確。 可用來以程式設計方式處理特定錯誤案例。

details

CloudErrorBody[]

包含與此錯誤相關的巢狀錯誤。

message

string

描述錯誤的詳細訊息,並提供偵錯資訊。

target

string

例如,特定錯誤的目標 (,錯誤) 中的屬性名稱。