你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

QueryKeysOperations 类

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

SearchManagementClient的

<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

必需

参数组。 默认值为 None。

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

必需

参数组。 默认值为 None。

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

必需

参数组。 默认值为 None。

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'>