Package com.azure.resourcemanager.hybridkubernetes.models

Interface ConnectedClusters

public interface ConnectedClusters
Resource collection API of ConnectedClusters.

  • Method Details

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<ConnectedCluster> 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

      ConnectedCluster 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.

    • deleteByResourceGroup

      void deleteByResourceGroup(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<CredentialResults> 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

      CredentialResults 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<ConnectedCluster> 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<ConnectedCluster> 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<ConnectedCluster> 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<ConnectedCluster> 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.

    • getById

      ConnectedCluster getById(String id)
      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:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<ConnectedCluster> getByIdWithResponse(String id, 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:
      id - the resource ID.
      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.

    • deleteById

      void deleteById(String id)
      Delete a connected cluster.

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

      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)
      Delete a connected cluster.

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

      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

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