Package com.azure.resourcemanager.search.fluent

Interface QueryKeysClient

  • public interface QueryKeysClient
    An instance of this class provides access to all the operations defined in QueryKeysClient.

    • Method Detail

      • createWithResponseAsync

        Mono<com.azure.core.http.rest.Response<QueryKeyInner>> createWithResponseAsync​(String resourceGroupName,
                                                                               String searchServiceName,
                                                                               String name,
                                                                               UUID clientRequestId)
        Generates a new query key for the specified search service. You can create up to 50 query keys per 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 Cognitive Search service associated with the specified resource group.
        name - The name of the new query API key.
        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 API key for a given Azure Cognitive Search service that has permissions for query operations only.
        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.

      • createAsync

        Mono<QueryKeyInner> createAsync​(String resourceGroupName,
                                String searchServiceName,
                                String name,
                                UUID clientRequestId)
        Generates a new query key for the specified search service. You can create up to 50 query keys per 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 Cognitive Search service associated with the specified resource group.
        name - The name of the new query API key.
        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 API key for a given Azure Cognitive Search service that has permissions for query operations only.
        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.

      • createAsync

        Mono<QueryKeyInner> createAsync​(String resourceGroupName,
                                String searchServiceName,
                                String name)
        Generates a new query key for the specified search service. You can create up to 50 query keys per 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 Cognitive Search service associated with the specified resource group.
        name - The name of the new query API key.
        Returns:
        describes an API key for a given Azure Cognitive Search service that has permissions for query operations only.
        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.

      • create

        QueryKeyInner create​(String resourceGroupName,
                     String searchServiceName,
                     String name)
        Generates a new query key for the specified search service. You can create up to 50 query keys per 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 Cognitive Search service associated with the specified resource group.
        name - The name of the new query API key.
        Returns:
        describes an API key for a given Azure Cognitive Search service that has permissions for query operations only.
        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.

      • createWithResponse

        com.azure.core.http.rest.Response<QueryKeyInner> createWithResponse​(String resourceGroupName,
                                                                    String searchServiceName,
                                                                    String name,
                                                                    UUID clientRequestId,
                                                                    com.azure.core.util.Context context)
        Generates a new query key for the specified search service. You can create up to 50 query keys per 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 Cognitive Search service associated with the specified resource group.
        name - The name of the new query API key.
        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 API key for a given Azure Cognitive Search service that has permissions for query operations only.
        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.

      • listBySearchServiceAsync

        com.azure.core.http.rest.PagedFlux<QueryKeyInner> listBySearchServiceAsync​(String resourceGroupName,
                                                                           String searchServiceName,
                                                                           UUID clientRequestId)
        Returns the list of query API keys for the given Azure Cognitive 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 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:
        response containing the query API keys for a given Azure Cognitive Search service.
        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.

      • listBySearchServiceAsync

        com.azure.core.http.rest.PagedFlux<QueryKeyInner> listBySearchServiceAsync​(String resourceGroupName,
                                                                           String searchServiceName)
        Returns the list of query API keys for the given Azure Cognitive 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 Cognitive Search service associated with the specified resource group.
        Returns:
        response containing the query API keys for a given Azure Cognitive Search service.
        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.

      • listBySearchService

        com.azure.core.http.rest.PagedIterable<QueryKeyInner> listBySearchService​(String resourceGroupName,
                                                                          String searchServiceName)
        Returns the list of query API keys for the given Azure Cognitive 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 Cognitive Search service associated with the specified resource group.
        Returns:
        response containing the query API keys for a given Azure Cognitive Search service.
        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.

      • listBySearchService

        com.azure.core.http.rest.PagedIterable<QueryKeyInner> listBySearchService​(String resourceGroupName,
                                                                          String searchServiceName,
                                                                          UUID clientRequestId,
                                                                          com.azure.core.util.Context context)
        Returns the list of query API keys for the given Azure Cognitive 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 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:
        response containing the query API keys for a given Azure Cognitive Search service.
        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,
                                                                      String key,
                                                                      UUID clientRequestId)
        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 Cognitive Search service associated with the specified resource group.
        key - The query key to be deleted. Query keys are identified by value, not by name.
        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,
                       String key,
                       UUID clientRequestId)
        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 Cognitive Search service associated with the specified resource group.
        key - The query key to be deleted. Query keys are identified by value, not by name.
        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,
                       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 Cognitive 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:
        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,
            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 Cognitive 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.

      • deleteWithResponse

        com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName,
                                                           String searchServiceName,
                                                           String key,
                                                           UUID clientRequestId,
                                                           com.azure.core.util.Context context)
        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 Cognitive Search service associated with the specified resource group.
        key - The query key to be deleted. Query keys are identified by value, not by name.
        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.