Interface ClustersClient


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

      • list

        com.azure.core.http.rest.PagedIterable<ClusterInner> list​(String resourceGroupName,
                                                                  String privateCloudName)
        List clusters in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        Returns:
        a paged list of clusters.
        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<ClusterInner> list​(String resourceGroupName,
                                                                  String privateCloudName,
                                                                  com.azure.core.util.Context context)
        List clusters in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        context - The context to associate with this operation.
        Returns:
        a paged list of clusters.
        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

        ClusterInner get​(String resourceGroupName,
                         String privateCloudName,
                         String clusterName)
        Get a cluster by name in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        Returns:
        a cluster by name in a private cloud.
        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<ClusterInner> getWithResponse​(String resourceGroupName,
                                                                        String privateCloudName,
                                                                        String clusterName,
                                                                        com.azure.core.util.Context context)
        Get a cluster by name in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        context - The context to associate with this operation.
        Returns:
        a cluster by name in a private cloud.
        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<ClusterInner>,​ClusterInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                  String privateCloudName,
                                                                                                                                                  String clusterName,
                                                                                                                                                  ClusterInner cluster)
        Create or update a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - The name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        cluster - A cluster in the private cloud.
        Returns:
        a cluster resource.
        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<ClusterInner>,​ClusterInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                  String privateCloudName,
                                                                                                                                                  String clusterName,
                                                                                                                                                  ClusterInner cluster,
                                                                                                                                                  com.azure.core.util.Context context)
        Create or update a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - The name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        cluster - A cluster in the private cloud.
        context - The context to associate with this operation.
        Returns:
        a cluster resource.
        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

        ClusterInner createOrUpdate​(String resourceGroupName,
                                    String privateCloudName,
                                    String clusterName,
                                    ClusterInner cluster)
        Create or update a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - The name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        cluster - A cluster in the private cloud.
        Returns:
        a cluster resource.
        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

        ClusterInner createOrUpdate​(String resourceGroupName,
                                    String privateCloudName,
                                    String clusterName,
                                    ClusterInner cluster,
                                    com.azure.core.util.Context context)
        Create or update a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - The name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        cluster - A cluster in the private cloud.
        context - The context to associate with this operation.
        Returns:
        a cluster resource.
        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<ClusterInner>,​ClusterInner> beginUpdate​(String resourceGroupName,
                                                                                                                                          String privateCloudName,
                                                                                                                                          String clusterName,
                                                                                                                                          ClusterUpdate clusterUpdate)
        Update a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        clusterUpdate - The cluster properties to be updated.
        Returns:
        a cluster resource.
        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<ClusterInner>,​ClusterInner> beginUpdate​(String resourceGroupName,
                                                                                                                                          String privateCloudName,
                                                                                                                                          String clusterName,
                                                                                                                                          ClusterUpdate clusterUpdate,
                                                                                                                                          com.azure.core.util.Context context)
        Update a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        clusterUpdate - The cluster properties to be updated.
        context - The context to associate with this operation.
        Returns:
        a cluster resource.
        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

        ClusterInner update​(String resourceGroupName,
                            String privateCloudName,
                            String clusterName,
                            ClusterUpdate clusterUpdate)
        Update a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        clusterUpdate - The cluster properties to be updated.
        Returns:
        a cluster resource.
        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

        ClusterInner update​(String resourceGroupName,
                            String privateCloudName,
                            String clusterName,
                            ClusterUpdate clusterUpdate,
                            com.azure.core.util.Context context)
        Update a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        clusterUpdate - The cluster properties to be updated.
        context - The context to associate with this operation.
        Returns:
        a cluster resource.
        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 privateCloudName,
                                                                                                                          String clusterName)
        Delete a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String privateCloudName,
                                                                                                                          String clusterName,
                                                                                                                          com.azure.core.util.Context context)
        Delete a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        context - The context to associate with this operation.
        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 privateCloudName,
                    String clusterName)
        Delete a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        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 privateCloudName,
                    String clusterName,
                    com.azure.core.util.Context context)
        Delete a cluster in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        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.