Query Keys - Create

服務:: Search Management

API 版本:: 2023-11-01

為指定的搜尋服務產生新的查詢索引鍵。每個服務最多可以建立50個查詢金鑰。

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

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	新查詢 API 金鑰的名稱。
resourceGroupName	path	True	string	目前訂用帳戶內的資源組名。您可以從 Azure Resource Manager API 或入口網站取得此值。
searchServiceName	path	True	string	與指定資源群組相關聯的搜尋服務名稱。
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	QueryKey	查詢金鑰已成功建立，且在回應中。您可以使用查詢金鑰作為數據平面 REST API 或 Azure SDK 中 'api-key' 參數的值，在搜尋索引上執行只讀作業，例如依標識符查詢和查閱檔。
Other Status Codes	CloudError	HTTP 404 （找不到）：找不到訂用帳戶、資源群組或搜尋服務。 HTTP 409 （衝突）：指定的訂用帳戶已停用。

安全性

azure_auth

Microsoft Entra ID OAuth2 授權流程。

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

範圍

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

範例

SearchCreateQueryKey

範例要求

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/Query key for browser-based clients?api-version=2023-11-01

範例回覆

狀態碼:: 200

{
  "name": "Query key for browser-based clients",
  "key": "<a query API key>"
}

定義

名稱	Description
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
QueryKey	描述只具有查詢作業許可權之指定搜尋服務的 API 金鑰。

CloudError

Object

包含 API 錯誤的相關信息。

名稱	類型	Description
error	CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。

CloudErrorBody

Object

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

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

QueryKey

Object

描述只具有查詢作業許可權之指定搜尋服務的 API 金鑰。

名稱	類型	Description
key	string	查詢 API 金鑰的值。
name	string	查詢 API 金鑰的名稱;可能是空的。