Services interface
Interface representing a Services.
Methods
| begin |
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. |
| begin |
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. |
| check |
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://.search.windows.net). |
| delete(string, string, Services |
Deletes a search service in the given resource group, along with its associated resources. |
| get(string, string, Services |
Gets the search service with the given name in the given resource group. |
| list |
Gets a list of all Search services in the given resource group. |
| list |
Gets a list of all Search services in the given subscription. |
| update(string, string, Search |
Updates an existing search service in the given resource group. |
Method Details
beginCreateOrUpdate(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)
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.
function beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created.
- service
- SearchService
The definition of the search service to create or update.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<SearchService>, SearchService>>
beginCreateOrUpdateAndWait(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)
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.
function beginCreateOrUpdateAndWait(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<SearchService>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created.
- service
- SearchService
The definition of the search service to create or update.
The options parameters.
Returns
Promise<SearchService>
checkNameAvailability(string, ServicesCheckNameAvailabilityOptionalParams)
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://.search.windows.net).
function checkNameAvailability(name: string, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityOutput>Parameters
- name
-
string
The search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length.
The options parameters.
Returns
Promise<CheckNameAvailabilityOutput>
delete(string, string, ServicesDeleteOptionalParams)
Deletes a search service in the given resource group, along with its associated resources.
function delete(resourceGroupName: string, searchServiceName: string, options?: ServicesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- options
- ServicesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, ServicesGetOptionalParams)
Gets the search service with the given name in the given resource group.
function get(resourceGroupName: string, searchServiceName: string, options?: ServicesGetOptionalParams): Promise<SearchService>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- options
- ServicesGetOptionalParams
The options parameters.
Returns
Promise<SearchService>
listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)
Gets a list of all Search services in the given resource group.
function listByResourceGroup(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
The options parameters.
Returns
listBySubscription(ServicesListBySubscriptionOptionalParams)
Gets a list of all Search services in the given subscription.
function listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>Parameters
The options parameters.
Returns
update(string, string, SearchServiceUpdate, ServicesUpdateOptionalParams)
Updates an existing search service in the given resource group.
function update(resourceGroupName: string, searchServiceName: string, service: SearchServiceUpdate, options?: ServicesUpdateOptionalParams): Promise<SearchService>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service to update.
- service
- SearchServiceUpdate
The definition of the search service to update.
- options
- ServicesUpdateOptionalParams
The options parameters.
Returns
Promise<SearchService>