QueryKeys interface
表示 QueryKeys 的接口。
方法
| create(string, string, string, Query |
为指定的搜索服务生成新的查询密钥。 每个服务最多可以创建 50 个查询密钥。 |
| delete(string, string, string, Query |
删除指定的查询键。 与管理密钥不同，不会重新生成查询密钥。 重新生成查询密钥的过程是删除并重新创建它。 |
| list |
返回给定 Azure AI 搜索服务的查询 API 密钥列表。 |
方法详细信息
create(string, string, string, QueryKeysCreateOptionalParams)
为指定的搜索服务生成新的查询密钥。 每个服务最多可以创建 50 个查询密钥。
function create(resourceGroupName: string, searchServiceName: string, name: string, options?: QueryKeysCreateOptionalParams): Promise<QueryKey>参数
- resourceGroupName
-
string
当前订阅中的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- searchServiceName
-
string
与指定资源组关联的 Azure AI 搜索服务的名称。
- name
-
string
新查询 API 密钥的名称。
- options
- QueryKeysCreateOptionalParams
选项参数。
返回
Promise<QueryKey>
delete(string, string, string, QueryKeysDeleteOptionalParams)
删除指定的查询键。 与管理密钥不同，不会重新生成查询密钥。 重新生成查询密钥的过程是删除并重新创建它。
function delete(resourceGroupName: string, searchServiceName: string, key: string, options?: QueryKeysDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
当前订阅中的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- searchServiceName
-
string
与指定资源组关联的 Azure AI 搜索服务的名称。
- key
-
string
要删除的查询密钥。 查询键按值而不是名称标识。
- options
- QueryKeysDeleteOptionalParams
选项参数。
返回
Promise<void>
listBySearchService(string, string, QueryKeysListBySearchServiceOptionalParams)
返回给定 Azure AI 搜索服务的查询 API 密钥列表。
function listBySearchService(resourceGroupName: string, searchServiceName: string, options?: QueryKeysListBySearchServiceOptionalParams): PagedAsyncIterableIterator<QueryKey, QueryKey[], PageSettings>参数
- resourceGroupName
-
string
当前订阅中的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- searchServiceName
-
string
与指定资源组关联的 Azure AI 搜索服务的名称。
选项参数。