Interface SearchServices

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

  • Method Summary

    Modifier and Type
    Method
    Description
    CheckNameAvailabilityOutput
    checkNameAvailability(String name)
    Checks if the specified Search service name is valid and available.
    Mono<CheckNameAvailabilityOutput>
    checkNameAvailabilityAsync(String name)
    Checks if Search service name is valid and is not in use asynchronously.
    QueryKey
    createQueryKey(String resourceGroupName, String searchServiceName, String name)
    Regenerates either the primary or secondary admin API key.
    Mono<QueryKey>
    createQueryKeyAsync(String resourceGroupName, String searchServiceName, String name)
    Regenerates either the primary or secondary admin API key.
    void
    deleteQueryKey(String resourceGroupName, String searchServiceName, String key)
    Deletes the specified query key.
    Mono<Void>
    deleteQueryKeyAsync(String resourceGroupName, String searchServiceName, String key)
    Deletes the specified query key.
    AdminKeys
    getAdminKeys(String resourceGroupName, String searchServiceName)
    Gets the primary and secondary admin API keys for the specified Azure Search service.
    Mono<AdminKeys>
    getAdminKeysAsync(String resourceGroupName, String searchServiceName)
    Gets the primary and secondary admin API keys for the specified Azure Search service.
    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.
    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.
    AdminKeys
    regenerateAdminKeys(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)
    Regenerates either the primary or secondary admin API key.
    Mono<AdminKeys>
    regenerateAdminKeysAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)
    Regenerates either the primary or secondary admin API key.

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

    manager

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsBatchCreation

    create, create, createAsync, createAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating

    define

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById

    deleteById, deleteByIdAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup

    deleteByResourceGroup, deleteByResourceGroupAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById

    getById, getByIdAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup

    getByResourceGroup, getByResourceGroupAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListing

    list, listAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup

    listByResourceGroup, listByResourceGroupAsync

  • 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