你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Services interface
表示服务的接口。
方法
| begin |
在给定资源组中创建或更新搜索服务。 如果搜索服务已存在，则将使用给定值更新所有属性。 |
| begin |
在给定资源组中创建或更新搜索服务。 如果搜索服务已存在，则将使用给定值更新所有属性。 |
| check |
检查给定的搜索服务名称是否可供使用。 搜索服务名称必须全局唯一，因为它们是服务 URI (https://.search.windows.net). |
| delete(string, string, Services |
删除给定资源组中的搜索服务及其关联的资源。 |
| get(string, string, Services |
获取具有给定资源组中给定名称的搜索服务。 |
| list |
获取给定资源组中所有搜索服务的列表。 |
| list |
获取给定订阅中所有搜索服务的列表。 |
| update(string, string, Search |
汇报给定资源组中的现有搜索服务。 |
方法详细信息
beginCreateOrUpdate(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)
在给定资源组中创建或更新搜索服务。 如果搜索服务已存在，则将使用给定值更新所有属性。
function beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>参数
- resourceGroupName
-
string
当前订阅中资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- searchServiceName
-
string
要创建或更新Azure 认知搜索服务的名称。 搜索服务名称只能包含小写字母、数字或短划线，不能使用短划线作为前两个字符或最后一个字符，不能包含连续短划线，并且长度必须介于 2 到 60 个字符之间。 搜索服务名称必须全局唯一，因为它们是服务 URI (https://.search.windows.net). 创建服务后，无法更改服务名称。
- service
- SearchService
要创建或更新的搜索服务的定义。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<SearchService>, SearchService>>
beginCreateOrUpdateAndWait(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)
在给定资源组中创建或更新搜索服务。 如果搜索服务已存在，则将使用给定值更新所有属性。
function beginCreateOrUpdateAndWait(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<SearchService>参数
- resourceGroupName
-
string
当前订阅中资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- searchServiceName
-
string
要创建或更新Azure 认知搜索服务的名称。 搜索服务名称只能包含小写字母、数字或短划线，不能使用短划线作为前两个字符或最后一个字符，不能包含连续短划线，并且长度必须介于 2 到 60 个字符之间。 搜索服务名称必须全局唯一，因为它们是服务 URI (https://.search.windows.net). 创建服务后，无法更改服务名称。
- service
- SearchService
要创建或更新的搜索服务的定义。
选项参数。
返回
Promise<SearchService>
checkNameAvailability(string, ServicesCheckNameAvailabilityOptionalParams)
检查给定的搜索服务名称是否可供使用。 搜索服务名称必须全局唯一，因为它们是服务 URI (https://.search.windows.net).
function checkNameAvailability(name: string, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityOutput>参数
- name
-
string
要验证的搜索服务名称。 搜索服务名称只能包含小写字母、数字或短划线，不能使用短划线作为前两个字符或最后一个字符，不能包含连续短划线，并且长度必须介于 2 到 60 个字符之间。
选项参数。
返回
Promise<CheckNameAvailabilityOutput>
delete(string, string, ServicesDeleteOptionalParams)
删除给定资源组中的搜索服务及其关联的资源。
function delete(resourceGroupName: string, searchServiceName: string, options?: ServicesDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
当前订阅中资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- searchServiceName
-
string
与指定资源组关联的Azure 认知搜索服务的名称。
- options
- ServicesDeleteOptionalParams
选项参数。
返回
Promise<void>
get(string, string, ServicesGetOptionalParams)
获取具有给定资源组中给定名称的搜索服务。
function get(resourceGroupName: string, searchServiceName: string, options?: ServicesGetOptionalParams): Promise<SearchService>参数
- resourceGroupName
-
string
当前订阅中资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- searchServiceName
-
string
与指定资源组关联的Azure 认知搜索服务的名称。
- options
- ServicesGetOptionalParams
选项参数。
返回
Promise<SearchService>
listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)
获取给定资源组中所有搜索服务的列表。
function listByResourceGroup(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>参数
- resourceGroupName
-
string
当前订阅中资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
选项参数。
返回
listBySubscription(ServicesListBySubscriptionOptionalParams)
获取给定订阅中所有搜索服务的列表。
function listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>参数
选项参数。
返回
update(string, string, SearchServiceUpdate, ServicesUpdateOptionalParams)
汇报给定资源组中的现有搜索服务。
function update(resourceGroupName: string, searchServiceName: string, service: SearchServiceUpdate, options?: ServicesUpdateOptionalParams): Promise<SearchService>参数
- resourceGroupName
-
string
当前订阅中资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- searchServiceName
-
string
要更新的Azure 认知搜索服务的名称。
- service
- SearchServiceUpdate
要更新的搜索服务的定义。
- options
- ServicesUpdateOptionalParams
选项参数。
返回
Promise<SearchService>