Share via

ServicesOperations interface

Package:
@azure/arm-search

Interface representing a Services operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginUpgrade
beginUpgradeAndWait
checkNameAvailability

Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net).
createOrUpdate

Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
delete
get

Gets the search service with the given name in the given resource group.
listByResourceGroup

Gets a list of all search services in the given resource group.
listBySubscription

Gets a list of all search services in the given subscription.
update

Updates an existing search service in the given resource group.
upgrade

Upgrades the Azure AI Search service to the latest version available.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>

Property Value

(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams) => Promise<SearchService>

Property Value

(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams) => Promise<SearchService>

beginUpgrade

Warning

This API is now deprecated.

use upgrade instead

beginUpgrade: (resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams) => Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>

Property Value

(resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams) => Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>

beginUpgradeAndWait

Warning

This API is now deprecated.

use upgrade instead

beginUpgradeAndWait: (resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams) => Promise<SearchService>

Property Value

(resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams) => Promise<SearchService>

checkNameAvailability

Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net).

checkNameAvailability: (name: string, options?: ServicesCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityOutput>

Property Value

(name: string, options?: ServicesCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityOutput>

createOrUpdate

Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.

createOrUpdate: (resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams) => PollerLike<OperationState<SearchService>, SearchService>

Property Value

(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams) => PollerLike<OperationState<SearchService>, SearchService>

delete 

delete: (resourceGroupName: string, searchServiceName: string, options?: ServicesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, searchServiceName: string, options?: ServicesDeleteOptionalParams) => Promise<void>

get

Gets the search service with the given name in the given resource group.

get: (resourceGroupName: string, searchServiceName: string, options?: ServicesGetOptionalParams) => Promise<SearchService>

Property Value

(resourceGroupName: string, searchServiceName: string, options?: ServicesGetOptionalParams) => Promise<SearchService>

listByResourceGroup

Gets a list of all search services in the given resource group.

listByResourceGroup: (resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>

Property Value

(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>

listBySubscription

Gets a list of all search services in the given subscription.

listBySubscription: (options?: ServicesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>

Property Value

(options?: ServicesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>

update

Updates an existing search service in the given resource group.

update: (resourceGroupName: string, searchServiceName: string, service: SearchServiceUpdate, options?: ServicesUpdateOptionalParams) => Promise<SearchService>

Property Value

(resourceGroupName: string, searchServiceName: string, service: SearchServiceUpdate, options?: ServicesUpdateOptionalParams) => Promise<SearchService>

upgrade

Upgrades the Azure AI Search service to the latest version available.

upgrade: (resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams) => PollerLike<OperationState<SearchService>, SearchService>

Property Value

(resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams) => PollerLike<OperationState<SearchService>, SearchService>