Interface ConnectedClustersClient


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

    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ConnectedClusterInner>,ConnectedClusterInner> beginCreate(String resourceGroupName, String clusterName, ConnectedClusterInner connectedCluster)
      Register a new Kubernetes cluster with Azure Resource Manager.

      API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      connectedCluster - Parameters supplied to Create a Connected Cluster.
      Returns:
      the SyncPoller for polling of represents a connected 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.
    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ConnectedClusterInner>,ConnectedClusterInner> beginCreate(String resourceGroupName, String clusterName, ConnectedClusterInner connectedCluster, com.azure.core.util.Context context)
      Register a new Kubernetes cluster with Azure Resource Manager.

      API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      connectedCluster - Parameters supplied to Create a Connected Cluster.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of represents a connected 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.
    • create

      ConnectedClusterInner create(String resourceGroupName, String clusterName, ConnectedClusterInner connectedCluster)
      Register a new Kubernetes cluster with Azure Resource Manager.

      API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      connectedCluster - Parameters supplied to Create a Connected Cluster.
      Returns:
      represents a connected 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.
    • create

      ConnectedClusterInner create(String resourceGroupName, String clusterName, ConnectedClusterInner connectedCluster, com.azure.core.util.Context context)
      Register a new Kubernetes cluster with Azure Resource Manager.

      API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      connectedCluster - Parameters supplied to Create a Connected Cluster.
      context - The context to associate with this operation.
      Returns:
      represents a connected 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.
    • updateWithResponse

      com.azure.core.http.rest.Response<ConnectedClusterInner> updateWithResponse(String resourceGroupName, String clusterName, ConnectedClusterPatch connectedClusterPatch, com.azure.core.util.Context context)
      Updates a connected cluster.

      API to update certain properties of the connected cluster resource.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      connectedClusterPatch - Parameters supplied to update Connected Cluster.
      context - The context to associate with this operation.
      Returns:
      represents a connected 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.
    • update

      ConnectedClusterInner update(String resourceGroupName, String clusterName, ConnectedClusterPatch connectedClusterPatch)
      Updates a connected cluster.

      API to update certain properties of the connected cluster resource.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      connectedClusterPatch - Parameters supplied to update Connected Cluster.
      Returns:
      represents a connected 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<ConnectedClusterInner> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, com.azure.core.util.Context context)
      Get the properties of the specified connected cluster.

      Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      context - The context to associate with this operation.
      Returns:
      represents a connected 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.
    • getByResourceGroup

      ConnectedClusterInner getByResourceGroup(String resourceGroupName, String clusterName)
      Get the properties of the specified connected cluster.

      Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      Returns:
      represents a connected 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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String clusterName)
      Delete a connected cluster.

      Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      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, com.azure.core.util.Context context)
      Delete a connected cluster.

      Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      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)
      Delete a connected cluster.

      Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      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)
      Delete a connected cluster.

      Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      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.
    • listClusterUserCredentialWithResponse

      com.azure.core.http.rest.Response<CredentialResultsInner> listClusterUserCredentialWithResponse(String resourceGroupName, String clusterName, ListClusterUserCredentialProperties properties, com.azure.core.util.Context context)
      Gets cluster user credentials of a connected cluster

      Gets cluster user credentials of the connected cluster with a specified resource group and name.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      properties - ListClusterUserCredential properties.
      context - The context to associate with this operation.
      Returns:
      cluster user credentials of the connected cluster with a specified resource group and name 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.
    • listClusterUserCredential

      CredentialResultsInner listClusterUserCredential(String resourceGroupName, String clusterName, ListClusterUserCredentialProperties properties)
      Gets cluster user credentials of a connected cluster

      Gets cluster user credentials of the connected cluster with a specified resource group and name.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterName - The name of the Kubernetes cluster on which get is called.
      properties - ListClusterUserCredential properties.
      Returns:
      cluster user credentials of the connected cluster with a specified resource group and 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.
    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<ConnectedClusterInner> listByResourceGroup(String resourceGroupName)
      Lists all connected clusters

      API to enumerate registered connected K8s clusters under a Resource Group.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      the paginated list of connected Clusters 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<ConnectedClusterInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Lists all connected clusters

      API to enumerate registered connected K8s clusters under a Resource Group.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      context - The context to associate with this operation.
      Returns:
      the paginated list of connected Clusters 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<ConnectedClusterInner> list()
      Lists all connected clusters

      API to enumerate registered connected K8s clusters under a Subscription.

      Returns:
      the paginated list of connected Clusters 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<ConnectedClusterInner> list(com.azure.core.util.Context context)
      Lists all connected clusters

      API to enumerate registered connected K8s clusters under a Subscription.

      Parameters:
      context - The context to associate with this operation.
      Returns:
      the paginated list of connected Clusters 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.