Package com.azure.resourcemanager.kusto.fluent

Interface DatabasesClient

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

    • Method Detail

      • checkNameAvailability

        CheckNameResultInner checkNameAvailability​(String resourceGroupName,
                                           String clusterName,
                                           CheckNameRequest resourceName)
        Checks that the databases resource name is valid and is not already in use.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        resourceName - The name of the resource.
        Returns:
        the result returned from a check name availability request.
        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<CheckNameResultInner> checkNameAvailabilityWithResponse​(String resourceGroupName,
                                                                                          String clusterName,
                                                                                          CheckNameRequest resourceName,
                                                                                          com.azure.core.util.Context context)
        Checks that the databases resource name is valid and is not already in use.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        resourceName - The name of the resource.
        context - The context to associate with this operation.
        Returns:
        the result returned from a check name availability request along with 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.

      • listByCluster

        com.azure.core.http.rest.PagedIterable<DatabaseInner> listByCluster​(String resourceGroupName,
                                                                    String clusterName)
        Returns the list of databases of the given Kusto cluster.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        Returns:
        the list Kusto databases operation response as paginated response with PagedIterable.
        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.

      • listByCluster

        com.azure.core.http.rest.PagedIterable<DatabaseInner> listByCluster​(String resourceGroupName,
                                                                    String clusterName,
                                                                    com.azure.core.util.Context context)
        Returns the list of databases of the given Kusto cluster.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        context - The context to associate with this operation.
        Returns:
        the list Kusto databases operation response as paginated response with PagedIterable.
        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.

      • get

        DatabaseInner get​(String resourceGroupName,
                  String clusterName,
                  String databaseName)
        Returns a database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        Returns:
        class representing a Kusto database.
        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.

      • getWithResponse

        com.azure.core.http.rest.Response<DatabaseInner> getWithResponse​(String resourceGroupName,
                                                                 String clusterName,
                                                                 String databaseName,
                                                                 com.azure.core.util.Context context)
        Returns a database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        context - The context to associate with this operation.
        Returns:
        class representing a Kusto database along with 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.

      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DatabaseInner>,​DatabaseInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                            String clusterName,
                                                                                                                                            String databaseName,
                                                                                                                                            DatabaseInner parameters)
        Creates or updates a database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        parameters - The database parameters supplied to the CreateOrUpdate operation.
        Returns:
        the SyncPoller for polling of class representing a Kusto database.
        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<DatabaseInner>,​DatabaseInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                            String clusterName,
                                                                                                                                            String databaseName,
                                                                                                                                            DatabaseInner parameters,
                                                                                                                                            com.azure.core.util.Context context)
        Creates or updates a database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        parameters - The database parameters supplied to the CreateOrUpdate operation.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of class representing a Kusto database.
        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

        DatabaseInner createOrUpdate​(String resourceGroupName,
                             String clusterName,
                             String databaseName,
                             DatabaseInner parameters)
        Creates or updates a database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        parameters - The database parameters supplied to the CreateOrUpdate operation.
        Returns:
        class representing a Kusto database.
        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

        DatabaseInner createOrUpdate​(String resourceGroupName,
                             String clusterName,
                             String databaseName,
                             DatabaseInner parameters,
                             com.azure.core.util.Context context)
        Creates or updates a database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        parameters - The database parameters supplied to the CreateOrUpdate operation.
        context - The context to associate with this operation.
        Returns:
        class representing a Kusto database.
        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.

      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DatabaseInner>,​DatabaseInner> beginUpdate​(String resourceGroupName,
                                                                                                                                    String clusterName,
                                                                                                                                    String databaseName,
                                                                                                                                    DatabaseInner parameters)
        Updates a database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        parameters - The database parameters supplied to the Update operation.
        Returns:
        the SyncPoller for polling of class representing a Kusto database.
        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.

      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DatabaseInner>,​DatabaseInner> beginUpdate​(String resourceGroupName,
                                                                                                                                    String clusterName,
                                                                                                                                    String databaseName,
                                                                                                                                    DatabaseInner parameters,
                                                                                                                                    com.azure.core.util.Context context)
        Updates a database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        parameters - The database parameters supplied to the Update operation.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of class representing a Kusto database.
        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

        DatabaseInner update​(String resourceGroupName,
                     String clusterName,
                     String databaseName,
                     DatabaseInner parameters)
        Updates a database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        parameters - The database parameters supplied to the Update operation.
        Returns:
        class representing a Kusto database.
        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

        DatabaseInner update​(String resourceGroupName,
                     String clusterName,
                     String databaseName,
                     DatabaseInner parameters,
                     com.azure.core.util.Context context)
        Updates a database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        parameters - The database parameters supplied to the Update operation.
        context - The context to associate with this operation.
        Returns:
        class representing a Kusto database.
        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.

      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                  String clusterName,
                                                                                                                  String databaseName)
        Deletes the database with the given name.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        Returns:
        the SyncPoller for polling of long-running operation.
        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.

      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                  String clusterName,
                                                                                                                  String databaseName,
                                                                                                                  com.azure.core.util.Context context)
        Deletes the database with the given name.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of long-running operation.
        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 clusterName,
            String databaseName)
        Deletes the database with the given name.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        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 clusterName,
            String databaseName,
            com.azure.core.util.Context context)
        Deletes the database with the given name.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        context - The context to associate with this operation.
        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.

      • listPrincipals

        com.azure.core.http.rest.PagedIterable<DatabasePrincipalInner> listPrincipals​(String resourceGroupName,
                                                                              String clusterName,
                                                                              String databaseName)
        Returns a list of database principals of the given Kusto cluster and database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        Returns:
        the list Kusto database principals operation response as paginated response with PagedIterable.
        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.

      • listPrincipals

        com.azure.core.http.rest.PagedIterable<DatabasePrincipalInner> listPrincipals​(String resourceGroupName,
                                                                              String clusterName,
                                                                              String databaseName,
                                                                              com.azure.core.util.Context context)
        Returns a list of database principals of the given Kusto cluster and database.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        context - The context to associate with this operation.
        Returns:
        the list Kusto database principals operation response as paginated response with PagedIterable.
        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.

      • addPrincipals

        DatabasePrincipalListResultInner addPrincipals​(String resourceGroupName,
                                               String clusterName,
                                               String databaseName,
                                               DatabasePrincipalListRequest databasePrincipalsToAdd)
        Add Database principals permissions.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        databasePrincipalsToAdd - List of database principals to add.
        Returns:
        the list Kusto database principals operation 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.

      • addPrincipalsWithResponse

        com.azure.core.http.rest.Response<DatabasePrincipalListResultInner> addPrincipalsWithResponse​(String resourceGroupName,
                                                                                              String clusterName,
                                                                                              String databaseName,
                                                                                              DatabasePrincipalListRequest databasePrincipalsToAdd,
                                                                                              com.azure.core.util.Context context)
        Add Database principals permissions.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        databasePrincipalsToAdd - List of database principals to add.
        context - The context to associate with this operation.
        Returns:
        the list Kusto database principals operation response along with 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.

      • removePrincipals

        DatabasePrincipalListResultInner removePrincipals​(String resourceGroupName,
                                                  String clusterName,
                                                  String databaseName,
                                                  DatabasePrincipalListRequest databasePrincipalsToRemove)
        Remove Database principals permissions.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        databasePrincipalsToRemove - List of database principals to remove.
        Returns:
        the list Kusto database principals operation 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.

      • removePrincipalsWithResponse

        com.azure.core.http.rest.Response<DatabasePrincipalListResultInner> removePrincipalsWithResponse​(String resourceGroupName,
                                                                                                 String clusterName,
                                                                                                 String databaseName,
                                                                                                 DatabasePrincipalListRequest databasePrincipalsToRemove,
                                                                                                 com.azure.core.util.Context context)
        Remove Database principals permissions.
        Parameters:
        resourceGroupName - The name of the resource group containing the Kusto cluster.
        clusterName - The name of the Kusto cluster.
        databaseName - The name of the database in the Kusto cluster.
        databasePrincipalsToRemove - List of database principals to remove.
        context - The context to associate with this operation.
        Returns:
        the list Kusto database principals operation response along with 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.