Package com.azure.resourcemanager.search.models

Interface SearchServices

All Superinterfaces:
HasManager<SearchServiceManager>, SupportsBatchCreation<SearchService>, SupportsCreating<SearchService.DefinitionStages.Blank>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsGettingById<SearchService>, SupportsGettingByResourceGroup<SearchService>, SupportsListing<SearchService>, SupportsListingByResourceGroup<SearchService>
public interface SearchServices extends SupportsCreating<SearchService.DefinitionStages.Blank>, SupportsListing<SearchService>, SupportsListingByResourceGroup<SearchService>, SupportsGettingByResourceGroup<SearchService>, SupportsGettingById<SearchService>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsBatchCreation<SearchService>, HasManager<SearchServiceManager>
Entry point to Cognitive Search service management API in Azure.

  • Method Details

    • checkNameAvailability

      CheckNameAvailabilityOutput checkNameAvailability(String name)
      Checks if the specified Search service name is valid and available.
      Parameters:
      name - the Search service name to check
      Returns:
      whether the name is available and other info if not

    • checkNameAvailabilityAsync

      Mono<CheckNameAvailabilityOutput> checkNameAvailabilityAsync(String name)
      Checks if Search service name is valid and is not in use asynchronously.
      Parameters:
      name - the Search service name to check
      Returns:
      a representation of the deferred computation of this call, returning whether the name is available or other info if not

    • getAdminKeys

      AdminKeys getAdminKeys(String resourceGroupName, String searchServiceName)
      Gets the primary and secondary admin API keys for the specified Azure Search service.
      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 Search service associated with the specified resource group
      Returns:
      the AdminKeys object if successful
      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

    • getAdminKeysAsync

      Mono<AdminKeys> getAdminKeysAsync(String resourceGroupName, String searchServiceName)
      Gets the primary and secondary admin API keys for the specified Azure Search service.
      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 Search service associated with the specified resource group
      Returns:
      a representation of the future computation of this call
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation

    • listQueryKeys

      com.azure.core.http.rest.PagedIterable<QueryKey> listQueryKeys(String resourceGroupName, String searchServiceName)
      Returns the list of query API keys for the given Azure Search service.
      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 Search service associated with the specified resource group
      Returns:
      the List<QueryKey> object if successful
      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

    • listQueryKeysAsync

      com.azure.core.http.rest.PagedFlux<QueryKey> listQueryKeysAsync(String resourceGroupName, String searchServiceName)
      Returns the list of query API keys for the given Azure Search service.
      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 Search service associated with the specified resource group.
      Returns:
      a representation of the future computation of this call
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation

    • regenerateAdminKeys

      AdminKeys regenerateAdminKeys(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)
      Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
      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 Search service associated with the specified resource group.
      keyKind - Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. Possible values include: 'primary', 'secondary'
      Returns:
      the AdminKeys object if successful.
      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

    • regenerateAdminKeysAsync

      Mono<AdminKeys> regenerateAdminKeysAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)
      Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
      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 Search service associated with the specified resource group.
      keyKind - Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. Possible values include: 'primary', 'secondary'
      Returns:
      the observable to the AdminKeyResultInner object
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation

    • createQueryKey

      QueryKey createQueryKey(String resourceGroupName, String searchServiceName, String name)
      Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
      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 Search service associated with the specified resource group.
      name - The name of the new query API key.
      Returns:
      the QueryKey object if successful.
      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

    • createQueryKeyAsync

      Mono<QueryKey> createQueryKeyAsync(String resourceGroupName, String searchServiceName, String name)
      Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
      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 Search service associated with the specified resource group.
      name - The name of the new query API key.
      Returns:
      a representation of the future computation of this call
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation

    • deleteQueryKey

      void deleteQueryKey(String resourceGroupName, String searchServiceName, String key)
      Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
      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 Search service associated with the specified resource group.
      key - The query key to be deleted. Query keys are identified by value, not by name.
      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

    • deleteQueryKeyAsync

      Mono<Void> deleteQueryKeyAsync(String resourceGroupName, String searchServiceName, String key)
      Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
      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 Search service associated with the specified resource group.
      key - The query key to be deleted. Query keys are identified by value, not by name.
      Returns:
      a representation of the future computation of this call
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation