Package com.azure.resourcemanager.search.fluent

Interface ServicesClient

All Superinterfaces:

InnerSupportsDelete<Void>, InnerSupportsGet<SearchServiceInner>, InnerSupportsListing<SearchServiceInner>

public interface ServicesClient
extends InnerSupportsGet<SearchServiceInner>, InnerSupportsListing<SearchServiceInner>, InnerSupportsDelete<Void>

An instance of this class provides access to all the operations defined in ServicesClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SearchServiceInner>,SearchServiceInner>	beginCreateOrUpdate(String resourceGroupName, String searchServiceName, SearchServiceInner serviceParam, UUID clientRequestId)	Creates or updates a search service in the given resource group.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SearchServiceInner>,SearchServiceInner>	beginCreateOrUpdate(String resourceGroupName, String searchServiceName, SearchServiceInner serviceParam, UUID clientRequestId, com.azure.core.util.Context context)	Creates or updates a search service in the given resource group.
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<SearchServiceInner>,SearchServiceInner>	beginCreateOrUpdateAsync(String resourceGroupName, String searchServiceName, SearchServiceInner serviceParam, UUID clientRequestId)	Creates or updates a search service in the given resource group.
CheckNameAvailabilityOutput	checkNameAvailability(String name)	Checks whether or not the given search service name is available for use.
Mono<CheckNameAvailabilityOutput>	checkNameAvailabilityAsync(String name)	Checks whether or not the given search service name is available for use.
Mono<CheckNameAvailabilityOutput>	checkNameAvailabilityAsync(String name, UUID clientRequestId)	Checks whether or not the given search service name is available for use.
com.azure.core.http.rest.Response<CheckNameAvailabilityOutput>	checkNameAvailabilityWithResponse(String name, UUID clientRequestId, com.azure.core.util.Context context)	Checks whether or not the given search service name is available for use.
Mono<com.azure.core.http.rest.Response<CheckNameAvailabilityOutput>>	checkNameAvailabilityWithResponseAsync(String name, UUID clientRequestId)	Checks whether or not the given search service name is available for use.
SearchServiceInner	createOrUpdate(String resourceGroupName, String searchServiceName, SearchServiceInner serviceParam)	Creates or updates a search service in the given resource group.
SearchServiceInner	createOrUpdate(String resourceGroupName, String searchServiceName, SearchServiceInner serviceParam, UUID clientRequestId)	Creates or updates a search service in the given resource group.
SearchServiceInner	createOrUpdate(String resourceGroupName, String searchServiceName, SearchServiceInner serviceParam, UUID clientRequestId, com.azure.core.util.Context context)	Creates or updates a search service in the given resource group.
Mono<SearchServiceInner>	createOrUpdateAsync(String resourceGroupName, String searchServiceName, SearchServiceInner serviceParam)	Creates or updates a search service in the given resource group.
Mono<SearchServiceInner>	createOrUpdateAsync(String resourceGroupName, String searchServiceName, SearchServiceInner serviceParam, UUID clientRequestId)	Creates or updates a search service in the given resource group.
Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>	createOrUpdateWithResponseAsync(String resourceGroupName, String searchServiceName, SearchServiceInner serviceParam, UUID clientRequestId)	Creates or updates a search service in the given resource group.
void	delete(String resourceGroupName, String searchServiceName)	Deletes a search service in the given resource group, along with its associated resources.
Mono<Void>	deleteAsync(String resourceGroupName, String searchServiceName)	Deletes a search service in the given resource group, along with its associated resources.
Mono<Void>	deleteAsync(String resourceGroupName, String searchServiceName, UUID clientRequestId)	Deletes a search service in the given resource group, along with its associated resources.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String searchServiceName, UUID clientRequestId, com.azure.core.util.Context context)	Deletes a search service in the given resource group, along with its associated resources.
Mono<com.azure.core.http.rest.Response<Void>>	deleteWithResponseAsync(String resourceGroupName, String searchServiceName, UUID clientRequestId)	Deletes a search service in the given resource group, along with its associated resources.
SearchServiceInner	getByResourceGroup(String resourceGroupName, String searchServiceName)	Gets the search service with the given name in the given resource group.
Mono<SearchServiceInner>	getByResourceGroupAsync(String resourceGroupName, String searchServiceName)	Gets the search service with the given name in the given resource group.
Mono<SearchServiceInner>	getByResourceGroupAsync(String resourceGroupName, String searchServiceName, UUID clientRequestId)	Gets the search service with the given name in the given resource group.
com.azure.core.http.rest.Response<SearchServiceInner>	getByResourceGroupWithResponse(String resourceGroupName, String searchServiceName, UUID clientRequestId, com.azure.core.util.Context context)	Gets the search service with the given name in the given resource group.
Mono<com.azure.core.http.rest.Response<SearchServiceInner>>	getByResourceGroupWithResponseAsync(String resourceGroupName, String searchServiceName, UUID clientRequestId)	Gets the search service with the given name in the given resource group.
com.azure.core.http.rest.PagedIterable<SearchServiceInner>	list()	Gets a list of all search services in the given subscription.
com.azure.core.http.rest.PagedIterable<SearchServiceInner>	list(UUID clientRequestId, com.azure.core.util.Context context)	Gets a list of all search services in the given subscription.
com.azure.core.http.rest.PagedFlux<SearchServiceInner>	listAsync()	Gets a list of all search services in the given subscription.
com.azure.core.http.rest.PagedFlux<SearchServiceInner>	listAsync(UUID clientRequestId)	Gets a list of all search services in the given subscription.
com.azure.core.http.rest.PagedIterable<SearchServiceInner>	listByResourceGroup(String resourceGroupName)	Gets a list of all search services in the given resource group.
com.azure.core.http.rest.PagedIterable<SearchServiceInner>	listByResourceGroup(String resourceGroupName, UUID clientRequestId, com.azure.core.util.Context context)	Gets a list of all search services in the given resource group.
com.azure.core.http.rest.PagedFlux<SearchServiceInner>	listByResourceGroupAsync(String resourceGroupName)	Gets a list of all search services in the given resource group.
com.azure.core.http.rest.PagedFlux<SearchServiceInner>	listByResourceGroupAsync(String resourceGroupName, UUID clientRequestId)	Gets a list of all search services in the given resource group.
SearchServiceInner	update(String resourceGroupName, String searchServiceName, SearchServiceUpdate serviceParam)	Updates an existing search service in the given resource group.
Mono<SearchServiceInner>	updateAsync(String resourceGroupName, String searchServiceName, SearchServiceUpdate serviceParam)	Updates an existing search service in the given resource group.
Mono<SearchServiceInner>	updateAsync(String resourceGroupName, String searchServiceName, SearchServiceUpdate serviceParam, UUID clientRequestId)	Updates an existing search service in the given resource group.
com.azure.core.http.rest.Response<SearchServiceInner>	updateWithResponse(String resourceGroupName, String searchServiceName, SearchServiceUpdate serviceParam, UUID clientRequestId, com.azure.core.util.Context context)	Updates an existing search service in the given resource group.
Mono<com.azure.core.http.rest.Response<SearchServiceInner>>	updateWithResponseAsync(String resourceGroupName, String searchServiceName, SearchServiceUpdate serviceParam, UUID clientRequestId)	Updates an existing search service in the given resource group.

Method Detail

createOrUpdateWithResponseAsync

Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync(String resourceGroupName,
                                                                                          String searchServiceName,
                                                                                          SearchServiceInner serviceParam,
                                                                                          UUID clientRequestId)

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.

Parameters:

resourceGroupName - 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 - 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://<name>.search.windows.net). You cannot change the service name after the service is created.

serviceParam - Describes an Azure Cognitive Search service and its current state.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCreateOrUpdateAsync

com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<SearchServiceInner>,SearchServiceInner> beginCreateOrUpdateAsync(String resourceGroupName,
                                                                                                                                                           String searchServiceName,
                                                                                                                                                           SearchServiceInner serviceParam,
                                                                                                                                                           UUID clientRequestId)

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.

Parameters:

resourceGroupName - 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 - 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://<name>.search.windows.net). You cannot change the service name after the service is created.

serviceParam - Describes an Azure Cognitive Search service and its current state.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SearchServiceInner>,SearchServiceInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                                      String searchServiceName,
                                                                                                                                                      SearchServiceInner serviceParam,
                                                                                                                                                      UUID clientRequestId)

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.

Parameters:

resourceGroupName - 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 - 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://<name>.search.windows.net). You cannot change the service name after the service is created.

serviceParam - Describes an Azure Cognitive Search service and its current state.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SearchServiceInner>,SearchServiceInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                                      String searchServiceName,
                                                                                                                                                      SearchServiceInner serviceParam,
                                                                                                                                                      UUID clientRequestId,
                                                                                                                                                      com.azure.core.util.Context context)

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.

Parameters:

resourceGroupName - 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 - 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://<name>.search.windows.net). You cannot change the service name after the service is created.

serviceParam - Describes an Azure Cognitive Search service and its current state.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

context - The context to associate with this operation.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateAsync

Mono<SearchServiceInner> createOrUpdateAsync(String resourceGroupName,
                                             String searchServiceName,
                                             SearchServiceInner serviceParam,
                                             UUID clientRequestId)

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.

Parameters:

resourceGroupName - 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 - 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://<name>.search.windows.net). You cannot change the service name after the service is created.

serviceParam - Describes an Azure Cognitive Search service and its current state.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateAsync

Mono<SearchServiceInner> createOrUpdateAsync(String resourceGroupName,
                                             String searchServiceName,
                                             SearchServiceInner serviceParam)

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.

Parameters:

resourceGroupName - 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 - 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://<name>.search.windows.net). You cannot change the service name after the service is created.

serviceParam - Describes an Azure Cognitive Search service and its current state.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

SearchServiceInner createOrUpdate(String resourceGroupName,
                                  String searchServiceName,
                                  SearchServiceInner serviceParam,
                                  UUID clientRequestId)

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.

Parameters:

resourceGroupName - 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 - 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://<name>.search.windows.net). You cannot change the service name after the service is created.

serviceParam - Describes an Azure Cognitive Search service and its current state.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

SearchServiceInner createOrUpdate(String resourceGroupName,
                                  String searchServiceName,
                                  SearchServiceInner serviceParam)

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.

Parameters:

resourceGroupName - 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 - 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://<name>.search.windows.net). You cannot change the service name after the service is created.

serviceParam - Describes an Azure Cognitive Search service and its current state.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

SearchServiceInner createOrUpdate(String resourceGroupName,
                                  String searchServiceName,
                                  SearchServiceInner serviceParam,
                                  UUID clientRequestId,
                                  com.azure.core.util.Context context)

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.

Parameters:

resourceGroupName - 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 - 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://<name>.search.windows.net). You cannot change the service name after the service is created.

serviceParam - Describes an Azure Cognitive Search service and its current state.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

context - The context to associate with this operation.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateWithResponseAsync

Mono<com.azure.core.http.rest.Response<SearchServiceInner>> updateWithResponseAsync(String resourceGroupName,
                                                                                    String searchServiceName,
                                                                                    SearchServiceUpdate serviceParam,
                                                                                    UUID clientRequestId)

Updates an existing search service in the given resource group.

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service to update.

serviceParam - The parameters used to update an Azure Cognitive Search service.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateAsync

Mono<SearchServiceInner> updateAsync(String resourceGroupName,
                                     String searchServiceName,
                                     SearchServiceUpdate serviceParam,
                                     UUID clientRequestId)

Updates an existing search service in the given resource group.

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service to update.

serviceParam - The parameters used to update an Azure Cognitive Search service.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateAsync

Mono<SearchServiceInner> updateAsync(String resourceGroupName,
                                     String searchServiceName,
                                     SearchServiceUpdate serviceParam)

Updates an existing search service in the given resource group.

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service to update.

serviceParam - The parameters used to update an Azure Cognitive Search service.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

SearchServiceInner update(String resourceGroupName,
                          String searchServiceName,
                          SearchServiceUpdate serviceParam)

Updates an existing search service in the given resource group.

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service to update.

serviceParam - The parameters used to update an Azure Cognitive Search service.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateWithResponse

com.azure.core.http.rest.Response<SearchServiceInner> updateWithResponse(String resourceGroupName,
                                                                         String searchServiceName,
                                                                         SearchServiceUpdate serviceParam,
                                                                         UUID clientRequestId,
                                                                         com.azure.core.util.Context context)

Updates an existing search service in the given resource group.

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service to update.

serviceParam - The parameters used to update an Azure Cognitive Search service.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

context - The context to associate with this operation.

Returns:

describes an Azure Cognitive Search service and its current state.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupWithResponseAsync

Mono<com.azure.core.http.rest.Response<SearchServiceInner>> getByResourceGroupWithResponseAsync(String resourceGroupName,
                                                                                                String searchServiceName,
                                                                                                UUID clientRequestId)

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

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupAsync

Mono<SearchServiceInner> getByResourceGroupAsync(String resourceGroupName,
                                                 String searchServiceName,
                                                 UUID clientRequestId)

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

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupAsync

Mono<SearchServiceInner> getByResourceGroupAsync(String resourceGroupName,
                                                 String searchServiceName)

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

Specified by:

getByResourceGroupAsync in interface InnerSupportsGet<SearchServiceInner>

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroup

SearchServiceInner getByResourceGroup(String resourceGroupName,
                                      String searchServiceName)

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

Specified by:

getByResourceGroup in interface InnerSupportsGet<SearchServiceInner>

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<SearchServiceInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                     String searchServiceName,
                                                                                     UUID clientRequestId,
                                                                                     com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

context - The context to associate with this operation.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponseAsync

Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponseAsync(String resourceGroupName,
                                                                      String searchServiceName,
                                                                      UUID clientRequestId)

Deletes a search service in the given resource group, along with its associated resources.

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteAsync

Mono<Void> deleteAsync(String resourceGroupName,
                       String searchServiceName,
                       UUID clientRequestId)

Deletes a search service in the given resource group, along with its associated resources.

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteAsync

Mono<Void> deleteAsync(String resourceGroupName,
                       String searchServiceName)

Deletes a search service in the given resource group, along with its associated resources.

Specified by:

deleteAsync in interface InnerSupportsDelete<Void>

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String searchServiceName)

Deletes a search service in the given resource group, along with its associated resources.

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String searchServiceName,
                                                           UUID clientRequestId,
                                                           com.azure.core.util.Context context)

Deletes a search service in the given resource group, along with its associated resources.

Parameters:

resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

context - The context to associate with this operation.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroupAsync

com.azure.core.http.rest.PagedFlux<SearchServiceInner> listByResourceGroupAsync(String resourceGroupName,
                                                                                UUID clientRequestId)

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

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroupAsync

com.azure.core.http.rest.PagedFlux<SearchServiceInner> listByResourceGroupAsync(String resourceGroupName)

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

Specified by:

listByResourceGroupAsync in interface InnerSupportsListing<SearchServiceInner>

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<SearchServiceInner> listByResourceGroup(String resourceGroupName)

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

Specified by:

listByResourceGroup in interface InnerSupportsListing<SearchServiceInner>

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<SearchServiceInner> listByResourceGroup(String resourceGroupName,
                                                                               UUID clientRequestId,
                                                                               com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

context - The context to associate with this operation.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listAsync

com.azure.core.http.rest.PagedFlux<SearchServiceInner> listAsync(UUID clientRequestId)

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

Parameters:

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

a list of all search services in the given subscription.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listAsync

com.azure.core.http.rest.PagedFlux<SearchServiceInner> listAsync()

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

Specified by:

listAsync in interface InnerSupportsListing<SearchServiceInner>

Returns:

a list of all search services in the given subscription.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<SearchServiceInner> list()

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

Specified by:

list in interface InnerSupportsListing<SearchServiceInner>

Returns:

a list of all search services in the given subscription.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<SearchServiceInner> list(UUID clientRequestId,
                                                                com.azure.core.util.Context context)

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

Parameters:

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

context - The context to associate with this operation.

Returns:

a list of all search services in the given subscription.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkNameAvailabilityWithResponseAsync

Mono<com.azure.core.http.rest.Response<CheckNameAvailabilityOutput>> checkNameAvailabilityWithResponseAsync(String name,
                                                                                                            UUID clientRequestId)

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).

Parameters:

name - 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.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

output of check name availability API.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkNameAvailabilityAsync

Mono<CheckNameAvailabilityOutput> checkNameAvailabilityAsync(String name,
                                                             UUID clientRequestId)

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).

Parameters:

name - 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.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

output of check name availability API.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkNameAvailabilityAsync

Mono<CheckNameAvailabilityOutput> checkNameAvailabilityAsync(String name)

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).

Parameters:

name - 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.

Returns:

output of check name availability API.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkNameAvailability

CheckNameAvailabilityOutput checkNameAvailability(String name)

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).

Parameters:

name - 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.

Returns:

output of check name availability API.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkNameAvailabilityWithResponse

com.azure.core.http.rest.Response<CheckNameAvailabilityOutput> checkNameAvailabilityWithResponse(String name,
                                                                                                 UUID clientRequestId,
                                                                                                 com.azure.core.util.Context context)

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).

Parameters:

name - 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.

clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

context - The context to associate with this operation.

Returns:

output of check name availability API.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.