QueryKeysOperations 類別

警告

請勿直接具現化此類別。

相反地，您應該透過 存取下列作業

SearchManagementClient's

<xref:query_keys> 屬性。

繼承

builtins.object

QueryKeysOperations

建構函式

QueryKeysOperations(*args, **kwargs)

方法

create	為指定的搜尋服務產生新的查詢索引鍵。 您最多可以對每個服務建立 50 個查詢金鑰。
delete	刪除指定的查詢索引鍵。 不同于系統管理金鑰，不會重新產生查詢金鑰。 重新產生查詢金鑰的程序為刪除再重新建立。
list_by_search_service	傳回指定之Azure 認知搜尋服務的查詢 API 金鑰清單。

create

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

create(resource_group_name: str, search_service_name: str, name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> QueryKey

參數

resource_group_name

str

必要

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

search_service_name

str

必要

與指定資源群組相關聯的Azure 認知搜尋服務名稱。 必要。

name

str

必要

新查詢 API 金鑰的名稱。 必要。

search_management_request_options

SearchManagementRequestOptions

必要

參數群組。 預設值為 [無]。

cls

callable

將傳遞直接回應的自訂類型或函式

傳回

QueryKey 或 cls (回應的結果)

傳回類型

QueryKey

例外狀況

HttpResponseError

另請參閱

• https://aka.ms/search-manage

delete

刪除指定的查詢索引鍵。 不同于系統管理金鑰，不會重新產生查詢金鑰。 重新產生查詢金鑰的程序為刪除再重新建立。

delete(resource_group_name: str, search_service_name: str, key: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> None

參數

resource_group_name

str

必要

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

search_service_name

str

必要

與指定資源群組相關聯的Azure 認知搜尋服務名稱。 必要。

key

str

必要

要刪除的查詢索引鍵。 查詢索引鍵是以值來識別，而不是依名稱來識別。 必要。

search_management_request_options

SearchManagementRequestOptions

必要

參數群組。 預設值為 [無]。

cls

callable

將傳遞直接回應的自訂類型或函式

傳回

無或 cls (回應的結果)

傳回類型

None

例外狀況

HttpResponseError

另請參閱

• https://aka.ms/search-manage

list_by_search_service

傳回指定之Azure 認知搜尋服務的查詢 API 金鑰清單。

list_by_search_service(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> Iterable[QueryKey]

參數

resource_group_name

str

必要

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

search_service_name

str

必要

與指定資源群組相關聯的Azure 認知搜尋服務名稱。 必要。

search_management_request_options

SearchManagementRequestOptions

必要

參數群組。 預設值為 [無]。

cls

callable

將傳遞直接回應的自訂類型或函式

傳回

反覆運算器，例如 QueryKey 的實例或 cls 的結果 (回應)

傳回類型

ItemPaged[QueryKey]

例外狀況

HttpResponseError

另請參閱

• https://aka.ms/search-manage

屬性

models

models = <module 'azure.mgmt.search.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\search\\models\\__init__.py'>