Share via

KubernetesClusters Interface

Package:
com.azure.resourcemanager.containerservice.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-containerservice:2.56.1

Implements

SupportsDeletingByResourceGroup SupportsGettingById<KubernetesCluster> SupportsGettingByResourceGroup<KubernetesCluster> SupportsListingByResourceGroup<KubernetesCluster> HasManager<ContainerServiceManager> SupportsBatchCreation<KubernetesCluster> SupportsCreating<Blank> SupportsDeletingById SupportsListing<KubernetesCluster>

public interface KubernetesClusters
extends HasManager<ContainerServiceManager>, SupportsCreating<Blank>, SupportsBatchCreation<KubernetesCluster>, SupportsListing<KubernetesCluster>, SupportsGettingById<KubernetesCluster>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsListingByResourceGroup<KubernetesCluster>, SupportsGettingByResourceGroup<KubernetesCluster>

Entry point to managed Kubernetes service management API.

Method Summary

Modifier and Type Method and Description
abstract List<CredentialResult> listAdminKubeConfigContent(String resourceGroupName, String kubernetesClusterName)

Returns the admin Kube.config content which can be used with a Kubernetes client.
abstract Mono<List<CredentialResult>> listAdminKubeConfigContentAsync(String resourceGroupName, String kubernetesClusterName)

Returns asynchronously the admin Kube.config content which can be used with a Kubernetes client.
abstract Set<String> listKubernetesVersions(Region region)

Deprecated

Returns the list of available Kubernetes versions available for the given Azure region.
abstract Mono<Set<String>> listKubernetesVersionsAsync(Region region)

Deprecated

Returns the list of available Kubernetes versions available for the given Azure region.
abstract PagedIterable<OrchestratorVersionProfile> listOrchestrators(Region region, ContainerServiceResourceTypes resourceTypes)

Returns the list of available orchestrators for the given Azure region.
abstract PagedFlux<OrchestratorVersionProfile> listOrchestratorsAsync(Region region, ContainerServiceResourceTypes resourceTypes)

Returns the list of available orchestrators for the given Azure region.
abstract List<CredentialResult> listUserKubeConfigContent(String resourceGroupName, String kubernetesClusterName)

Returns the user Kube.config content which can be used with a Kubernetes client.
abstract List<CredentialResult> listUserKubeConfigContent(String resourceGroupName, String kubernetesClusterName, Format format)

Returns the user Kube.config content which can be used with a Kubernetes client.
abstract Mono<List<CredentialResult>> listUserKubeConfigContentAsync(String resourceGroupName, String kubernetesClusterName)

Returns asynchronously the user Kube.config content which can be used with a Kubernetes client.
abstract Mono<List<CredentialResult>> listUserKubeConfigContentAsync(String resourceGroupName, String kubernetesClusterName, Format format)

Returns asynchronously the user Kube.config content which can be used with a Kubernetes client.
abstract void start(String resourceGroupName, String kubernetesClusterName)

Starts a stopped Kubernetes cluster.
abstract Mono<Void> startAsync(String resourceGroupName, String kubernetesClusterName)

Starts a stopped Kubernetes cluster.
abstract void stop(String resourceGroupName, String kubernetesClusterName)

Stops a running Kubernetes cluster.
abstract Mono<Void> stopAsync(String resourceGroupName, String kubernetesClusterName)

Stops a running Kubernetes cluster.

Method Details

listAdminKubeConfigContent

public abstract List<CredentialResult> listAdminKubeConfigContent(String resourceGroupName, String kubernetesClusterName)

Returns the admin Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is
kubernetesClusterName - the managed cluster name

Returns:

the Kube.config content which can be used with a Kubernetes client

listAdminKubeConfigContentAsync

public abstract Mono<List<CredentialResult>> listAdminKubeConfigContentAsync(String resourceGroupName, String kubernetesClusterName)

Returns asynchronously the admin Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is
kubernetesClusterName - the managed cluster name

Returns:

a future representation of the Kube.config content which can be used with a Kubernetes client

listKubernetesVersions

@Deprecated
public abstract Set<String> listKubernetesVersions(Region region)

Deprecated

Returns the list of available Kubernetes versions available for the given Azure region.

Parameters:

region - the Azure region to query into

Returns:

a set of Kubernetes versions which can be used when creating a service in this region

listKubernetesVersionsAsync

@Deprecated
public abstract Mono<Set<String>> listKubernetesVersionsAsync(Region region)

Deprecated

Returns the list of available Kubernetes versions available for the given Azure region.

Parameters:

region - the Azure region to query into

Returns:

a future representation of a set of Kubernetes versions which can be used when creating a service in this region

listOrchestrators

public abstract PagedIterable<OrchestratorVersionProfile> listOrchestrators(Region region, ContainerServiceResourceTypes resourceTypes)

Returns the list of available orchestrators for the given Azure region.

Parameters:

region - the Azure region to query into
resourceTypes - the resource type of container service

Returns:

a list of orchestrators which can be used when creating a service in this region

listOrchestratorsAsync

public abstract PagedFlux<OrchestratorVersionProfile> listOrchestratorsAsync(Region region, ContainerServiceResourceTypes resourceTypes)

Returns the list of available orchestrators for the given Azure region.

Parameters:

region - the Azure region to query into
resourceTypes - the resource type of container service

Returns:

a list of orchestrators which can be used when creating a service in this region

listUserKubeConfigContent

public abstract List<CredentialResult> listUserKubeConfigContent(String resourceGroupName, String kubernetesClusterName)

Returns the user Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is
kubernetesClusterName - the managed cluster name

Returns:

the Kube.config content which can be used with a Kubernetes client

listUserKubeConfigContent

public abstract List<CredentialResult> listUserKubeConfigContent(String resourceGroupName, String kubernetesClusterName, Format format)

Returns the user Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is
kubernetesClusterName - the managed cluster name
format - Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.

Returns:

the Kube.config content which can be used with a Kubernetes client

listUserKubeConfigContentAsync

public abstract Mono<List<CredentialResult>> listUserKubeConfigContentAsync(String resourceGroupName, String kubernetesClusterName)

Returns asynchronously the user Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is
kubernetesClusterName - the managed cluster name

Returns:

a future representation of the Kube.config content which can be used with a Kubernetes client

listUserKubeConfigContentAsync

public abstract Mono<List<CredentialResult>> listUserKubeConfigContentAsync(String resourceGroupName, String kubernetesClusterName, Format format)

Returns asynchronously the user Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is
kubernetesClusterName - the managed cluster name
format - Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.

Returns:

a future representation of the Kube.config content which can be used with a Kubernetes client

start

public abstract void start(String resourceGroupName, String kubernetesClusterName)

Starts a stopped Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group.
kubernetesClusterName - The name of the managed cluster resource.

startAsync

public abstract Mono<Void> startAsync(String resourceGroupName, String kubernetesClusterName)

Starts a stopped Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group.
kubernetesClusterName - The name of the managed cluster resource.

Returns:

the completion.

stop

public abstract void stop(String resourceGroupName, String kubernetesClusterName)

Stops a running Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group.
kubernetesClusterName - The name of the managed cluster resource.

stopAsync

public abstract Mono<Void> stopAsync(String resourceGroupName, String kubernetesClusterName)

Stops a running Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group.
kubernetesClusterName - The name of the managed cluster resource.

Returns:

the completion.

Applies to