Package com.azure.resourcemanager.kusto.models

Interface Clusters

public interface Clusters
Resource collection API of Clusters.

  • Method Details

    • getByResourceGroup

      Cluster getByResourceGroup(String resourceGroupName, String clusterName)
      Gets a Kusto cluster.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of the Kusto cluster.
      Returns:
      a 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.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Cluster> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, com.azure.core.util.Context context)
      Gets a 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:
      a Kusto cluster 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.

    • deleteByResourceGroup

      void deleteByResourceGroup(String resourceGroupName, String clusterName)
      Deletes a Kusto cluster.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of 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, com.azure.core.util.Context context)
      Deletes a 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.
      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.

    • stop

      void stop(String resourceGroupName, String clusterName)
      Stops a Kusto cluster.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of 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.

    • stop

      void stop(String resourceGroupName, String clusterName, com.azure.core.util.Context context)
      Stops a 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.
      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.

    • start

      void start(String resourceGroupName, String clusterName)
      Starts a Kusto cluster.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of 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.

    • start

      void start(String resourceGroupName, String clusterName, com.azure.core.util.Context context)
      Starts a 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.
      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.

    • listFollowerDatabases

      com.azure.core.http.rest.PagedIterable<FollowerDatabaseDefinition> listFollowerDatabases(String resourceGroupName, String clusterName)
      Returns a list of databases that are owned by this cluster and were followed by another cluster.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of 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.

    • listFollowerDatabases

      com.azure.core.http.rest.PagedIterable<FollowerDatabaseDefinition> listFollowerDatabases(String resourceGroupName, String clusterName, com.azure.core.util.Context context)
      Returns a list of databases that are owned by this cluster and were followed by another 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 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.

    • detachFollowerDatabases

      void detachFollowerDatabases(String resourceGroupName, String clusterName, FollowerDatabaseDefinitionInner followerDatabaseToRemove)
      Detaches all followers of a database owned by this cluster.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of the Kusto cluster.
      followerDatabaseToRemove - The follower databases properties to remove.
      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.

    • detachFollowerDatabases

      void detachFollowerDatabases(String resourceGroupName, String clusterName, FollowerDatabaseDefinitionInner followerDatabaseToRemove, com.azure.core.util.Context context)
      Detaches all followers of a database owned by this cluster.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of the Kusto cluster.
      followerDatabaseToRemove - The follower databases properties to remove.
      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.

    • diagnoseVirtualNetwork

      DiagnoseVirtualNetworkResult diagnoseVirtualNetwork(String resourceGroupName, String clusterName)
      Diagnoses network connectivity status for external resources on which the service is dependent on.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of the Kusto cluster.
      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.

    • diagnoseVirtualNetwork

      DiagnoseVirtualNetworkResult diagnoseVirtualNetwork(String resourceGroupName, String clusterName, com.azure.core.util.Context context)
      Diagnoses network connectivity status for external resources on which the service is dependent on.
      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 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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Cluster> listByResourceGroup(String resourceGroupName)
      Lists all Kusto clusters within a resource group.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      Returns:
      the list Kusto clusters 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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Cluster> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Lists all Kusto clusters within a resource group.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      context - The context to associate with this operation.
      Returns:
      the list Kusto clusters 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.

    • list

      com.azure.core.http.rest.PagedIterable<Cluster> list()
      Lists all Kusto clusters within a subscription.
      Returns:
      the list Kusto clusters operation response as paginated response with PagedIterable.
      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<Cluster> list(com.azure.core.util.Context context)
      Lists all Kusto clusters within a subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the list Kusto clusters 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.

    • listSkus

      com.azure.core.http.rest.PagedIterable<SkuDescription> listSkus()
      Lists eligible SKUs for Kusto resource provider.
      Returns:
      the list of the EngagementFabric SKU descriptions as paginated response with PagedIterable.
      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.

    • listSkus

      com.azure.core.http.rest.PagedIterable<SkuDescription> listSkus(com.azure.core.util.Context context)
      Lists eligible SKUs for Kusto resource provider.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the list of the EngagementFabric SKU descriptions 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.

    • checkNameAvailability

      CheckNameResult checkNameAvailability(String location, ClusterCheckNameRequest clusterName)
      Checks that the cluster name is valid and is not already in use.
      Parameters:
      location - Azure location (region) name.
      clusterName - The name of the cluster.
      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<CheckNameResult> checkNameAvailabilityWithResponse(String location, ClusterCheckNameRequest clusterName, com.azure.core.util.Context context)
      Checks that the cluster name is valid and is not already in use.
      Parameters:
      location - Azure location (region) name.
      clusterName - The name of the cluster.
      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.

    • listSkusByResource

      com.azure.core.http.rest.PagedIterable<AzureResourceSku> listSkusByResource(String resourceGroupName, String clusterName)
      Returns the SKUs available for the provided resource.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of the Kusto cluster.
      Returns:
      list of available SKUs for a Kusto Cluster 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.

    • listSkusByResource

      com.azure.core.http.rest.PagedIterable<AzureResourceSku> listSkusByResource(String resourceGroupName, String clusterName, com.azure.core.util.Context context)
      Returns the SKUs available for the provided resource.
      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:
      list of available SKUs for a Kusto Cluster 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.

    • listOutboundNetworkDependenciesEndpoints

      com.azure.core.http.rest.PagedIterable<OutboundNetworkDependenciesEndpoint> listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String clusterName)
      Gets the network endpoints of all outbound dependencies of a Kusto cluster.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of the Kusto cluster.
      Returns:
      the network endpoints of all outbound dependencies of a Kusto cluster 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.

    • listOutboundNetworkDependenciesEndpoints

      com.azure.core.http.rest.PagedIterable<OutboundNetworkDependenciesEndpoint> listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String clusterName, com.azure.core.util.Context context)
      Gets the network endpoints of all outbound dependencies of a 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 network endpoints of all outbound dependencies of a Kusto cluster 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.

    • listLanguageExtensions

      com.azure.core.http.rest.PagedIterable<LanguageExtension> listLanguageExtensions(String resourceGroupName, String clusterName)
      Returns a list of language extensions that can run within KQL queries.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of the Kusto cluster.
      Returns:
      the list of language extension objects 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.

    • listLanguageExtensions

      com.azure.core.http.rest.PagedIterable<LanguageExtension> listLanguageExtensions(String resourceGroupName, String clusterName, com.azure.core.util.Context context)
      Returns a list of language extensions that can run within KQL queries.
      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 of language extension objects 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.

    • addLanguageExtensions

      void addLanguageExtensions(String resourceGroupName, String clusterName, LanguageExtensionsList languageExtensionsToAdd)
      Add a list of language extensions that can run within KQL queries.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of the Kusto cluster.
      languageExtensionsToAdd - The language extensions to add.
      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.

    • addLanguageExtensions

      void addLanguageExtensions(String resourceGroupName, String clusterName, LanguageExtensionsList languageExtensionsToAdd, com.azure.core.util.Context context)
      Add a list of language extensions that can run within KQL queries.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of the Kusto cluster.
      languageExtensionsToAdd - The language extensions to add.
      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.

    • removeLanguageExtensions

      void removeLanguageExtensions(String resourceGroupName, String clusterName, LanguageExtensionsList languageExtensionsToRemove)
      Remove a list of language extensions that can run within KQL queries.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of the Kusto cluster.
      languageExtensionsToRemove - The language extensions to remove.
      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.

    • removeLanguageExtensions

      void removeLanguageExtensions(String resourceGroupName, String clusterName, LanguageExtensionsList languageExtensionsToRemove, com.azure.core.util.Context context)
      Remove a list of language extensions that can run within KQL queries.
      Parameters:
      resourceGroupName - The name of the resource group containing the Kusto cluster.
      clusterName - The name of the Kusto cluster.
      languageExtensionsToRemove - The language extensions to remove.
      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.

    • getById

      Cluster getById(String id)
      Gets a Kusto cluster.
      Parameters:
      id - the resource ID.
      Returns:
      a Kusto cluster 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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Cluster> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets a Kusto cluster.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a Kusto cluster 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.

    • deleteById

      void deleteById(String id)
      Deletes a Kusto cluster.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes a Kusto cluster.
      Parameters:
      id - the resource ID.
      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.

    • define

      Cluster.DefinitionStages.Blank define(String name)
      Begins definition for a new Cluster resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Cluster definition.